Skip to main content
Request example
Response example
GET /api/external/contacts/?limit={limit}&cursor={cursor}&{filters}

Query parameters

number
Requested page size. SDK default: 20.
string | null
Cursor for the next page.
Record<string, string>
Contact filters, for example name, status, or externalId when supported.

Response

Returns a page of Contact objects. See Cursor response.
Contact[]
Contacts on this page. Each item is a Contact.
string | null
Cursor for the next page. null on the last page.
boolean
Whether another page exists.
Request example
Response example