Skip to main content
GET
List entities

Authorizations

x-api-key
string
header
required

API key for authentication.

Query Parameters

page
integer
default:1

Page number to retrieve.

Required range: x >= 1
page_size
integer
default:100

Number of entities per page.

Required range: 1 <= x <= 500

Filter entities by name (case-insensitive substring match).

status
enum<string>

Processing status of an entity.

  • pending: Entity has been created and is queued for enrichment.
  • enriching: Enrichment is in progress.
  • ready: Enrichment complete — entity is indexed and ready for use in jobs.
  • failed: Enrichment failed. The entity may still be used but matching quality may be reduced.
Available options:
pending,
enriching,
ready,
failed
entity_type
enum<string>
default:company

The type of entity.

  • company: A company or organization (default).
  • person: An individual person.
Available options:
company,
person
sort_by
enum<string>
default:created_at

Fields available for sorting entity list results.

Available options:
created_at,
name,
status
sort_order
enum<string>
default:desc

Sort direction for list results.

  • asc: ascending (oldest or smallest first)
  • desc: descending (newest or largest first)
Available options:
asc,
desc

Response

Paginated list of entities.

entities
object[]
required

Array of entity objects for this page.

total
integer
required

Total number of entities matching the filter criteria.

Example:

17

page
integer
required

Current page number.

Example:

1

page_size
integer
required

Number of entities per page.

Example:

100