Search
K
9fin Entity API

List Entities

Returns a list of Entities.
Allows for filtering and sorting by a variety of entity attributes.

get
https://api.9fin.com/v0/entity

Query Parameters

sort_byAny Of

Comma-separated list of field__asc / field__desc tokens applied in order, e.g. company_name__desc,price__asc. Sortable fields: nf_id, roles, website, description, street_name, country_ref_name, industry_ref_code, cik, active_flag, alias, coverage_region, created_at, modified_at.

Default:null

Variant 1string
limitAny Of

Maximum number of rows to return.

Default:20

Variant 1integer

>= 1<= 100

cursorAny Of

Opaque keyset-pagination cursor from a prior page.

Default:null

Variant 1string
nf_id__eqAny Of

Filter where nf_id equal value.

Default:null

Variant 1string
nf_id__neqAny Of

Filter where nf_id not_equal value.

Default:null

Variant 1string
nf_id__containsAny Of

Filter where nf_id contains value.

Default:null

Variant 1string
nf_id__inAny Of

Filter where nf_id in value.

Default:null

Variant 1string
roles__containsAny Of

Filter where the roles array contains this value.

Default:null

Variant 1string
website__eqAny Of

Filter where website equal value.

Default:null

Variant 1string
website__neqAny Of

Filter where website not_equal value.

Default:null

Variant 1string
website__containsAny Of

Filter where website contains value.

Default:null

Variant 1string
website__inAny Of

Filter where website in value.

Default:null

Variant 1string
description__eqAny Of

Filter where description equal value.

Default:null

Variant 1string
description__neqAny Of

Filter where description not_equal value.

Default:null

Variant 1string
description__containsAny Of

Filter where description contains value.

Default:null

Variant 1string
description__inAny Of

Filter where description in value.

Default:null

Variant 1string
street_name__eqAny Of

Filter where street_name equal value.

Default:null

Variant 1string
street_name__neqAny Of

Filter where street_name not_equal value.

Default:null

Variant 1string
street_name__containsAny Of

Filter where street_name contains value.

Default:null

Variant 1string
street_name__inAny Of

Filter where street_name in value.

Default:null

Variant 1string
country_ref_name__eqAny Of

Filter where country_ref_name equal value.

Default:null

Variant 1string
country_ref_name__neqAny Of

Filter where country_ref_name not_equal value.

Default:null

Variant 1string
country_ref_name__containsAny Of

Filter where country_ref_name contains value.

Default:null

Variant 1string
country_ref_name__inAny Of

Filter where country_ref_name in value.

Default:null

Variant 1string
industry_ref_code__eqAny Of

Filter where industry_ref_code equal value.

Default:null

Variant 1string
industry_ref_code__neqAny Of

Filter where industry_ref_code not_equal value.

Default:null

Variant 1string
industry_ref_code__containsAny Of

Filter where industry_ref_code contains value.

Default:null

Variant 1string
industry_ref_code__inAny Of

Filter where industry_ref_code in value.

Default:null

Variant 1string
cik__eqAny Of

Filter where cik equal value.

Default:null

Variant 1integer
cik__neqAny Of

Filter where cik not_equal value.

Default:null

Variant 1integer
cik__gtAny Of

Filter where cik greater value.

Default:null

Variant 1integer
cik__gteAny Of

Filter where cik greater_or_equal value.

Default:null

Variant 1integer
cik__ltAny Of

Filter where cik less value.

Default:null

Variant 1integer
cik__lteAny Of

Filter where cik less_or_equal value.

Default:null

Variant 1integer
cik__inAny Of

Filter where cik in value.

Default:null

Variant 1string
active_flag__eqAny Of

Filter where active_flag equal value.

Default:null

Variant 1boolean
active_flag__neqAny Of

Filter where active_flag not_equal value.

Default:null

Variant 1boolean
alias__containsAny Of

Filter where the alias array contains this value.

Default:null

Variant 1string
coverage_region__containsAny Of

Filter where the coverage_region array contains this value.

Default:null

Variant 1string
created_at__eqAny Of

Filter where created_at equal value.

Default:null

Variant 1string(date-time)
created_at__neqAny Of

Filter where created_at not_equal value.

Default:null

Variant 1string(date-time)
created_at__gtAny Of

Filter where created_at greater value.

Default:null

Variant 1string(date-time)
created_at__gteAny Of

Filter where created_at greater_or_equal value.

Default:null

Variant 1string(date-time)
created_at__ltAny Of

Filter where created_at less value.

Default:null

Variant 1string(date-time)
created_at__lteAny Of

Filter where created_at less_or_equal value.

Default:null

Variant 1string(date-time)
created_at__inAny Of

Filter where created_at in value.

Default:null

Variant 1string
modified_at__eqAny Of

Filter where modified_at equal value.

Default:null

Variant 1string(date-time)
modified_at__neqAny Of

Filter where modified_at not_equal value.

Default:null

Variant 1string(date-time)
modified_at__gtAny Of

Filter where modified_at greater value.

Default:null

Variant 1string(date-time)
modified_at__gteAny Of

Filter where modified_at greater_or_equal value.

Default:null

Variant 1string(date-time)
modified_at__ltAny Of

Filter where modified_at less value.

Default:null

Variant 1string(date-time)
modified_at__lteAny Of

Filter where modified_at less_or_equal value.

Default:null

Variant 1string(date-time)
modified_at__inAny Of

Filter where modified_at in value.

Default:null

Variant 1string

Response

application/json

Successful Response

EntityListResponse

Public-facing page of entities; next_cursor is None on the last page.

itemsarray[object]required

Public-facing subset of an entity.

Show Child Parameters
next_cursorAny Of
required
Variant 1string
get/v0/entity
 
application/json