get
https://api.customerly.io/v2/companies//contacts
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:
- First request:
GET /companies/12345/contacts?per_page=20 - Response returns a
cursorvalue and 20 contacts - Next page:
GET /companies/12345/contacts?per_page=20&cursor=20 - Continue until
cursorisnull(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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
401Authentication required
404Company not found
422Invalid request parameters