v1

latestOpenAPI 3.1.12026-07-268973189.3 KB

Objects

List companies

Returns a paginated list of company records. Supports cursor pagination, full-text search, structured filters (stage, owner, tags, dates), and sorting. Results respect the API key user's ownership permissions. See the Listing & filters guide for filter syntax.

get/companies

Query parameters

cursorstring

Cursor for pagination. Pass the previous response meta.nextCursor value to fetch the next page.

pageSizeinteger

Number of items to return per page (max 100)

searchstring

Search by name, number, email, or phone

orderBy'createdAt' | 'name' | 'number'

Field to sort results by

orderDir'asc' | 'desc'

Sort direction

filtersobject

Structured filters. Each key is a filter field with operator and values. Option fields use string IDs; date fields use ISO 8601 date-time strings. See the Listing & filters guide.

v1

List companies

Query parameters

Response