Get all contacts for a specific company with pagination

Returns a paginated list of contacts (users and leads) associated with a specific company.
This endpoint is useful when a company has many contacts, and you want to retrieve them efficiently.

Company Identification

You can identify the company using two types of identifiers:

1. Customerly Company ID (numeric):

  • Use the internal company ID directly (e.g., 12345)
  • Example: GET /companies/12345/contacts

2. Custom Company ID (prefixed with cid:):

  • Use your custom identifier with the cid: prefix
  • Example: GET /companies/cid:company_12345/contacts

Pagination

This endpoint uses cursor-based pagination:

  • per_page: Number of contacts to return per page (default: 20, max: 100)
  • cursor: The cursor value from the previous response to fetch the next page

Example pagination flow:

  1. First request: GET /companies/12345/contacts?per_page=20
  2. Response returns a cursor value and 20 contacts
  3. Next page: GET /companies/12345/contacts?per_page=20&cursor=20
  4. Continue until cursor is null (no more contacts available)

Response

Each contact includes:

  • Contact ID, name, email, role (user/lead)
  • Custom contact ID and WhatsApp number (if available)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The company identifier. Can be either the numeric Customerly company ID (e.g., '12345') or your custom_company_id prefixed with 'cid:' (e.g., 'cid:company_12345')

Query Params
integer
1 to 100

Number of contacts per page (default: 20, max: 100)

integer

Pagination cursor from the previous response. Use the 'cursor' value returned in the previous page's response to fetch the next page. Omit this parameter for the first page.

Responses

401

Authentication required

404

Company not found

422

Invalid request parameters

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json