Get all companies for a contact with pagination

Returns a paginated list of companies that a contact is associated with.

Contact Identification

You can retrieve companies using various types of identifiers:

1. Customerly Contact ID (numeric):

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

2. Custom User ID (prefix: cuid:):

  • Your own custom identifier for a registered user
  • Example: GET /contacts/cuid:user_123/companies

3. Custom Lead ID (prefix: clid:):

  • Your own custom identifier for a lead
  • Example: GET /contacts/clid:lead_456/companies

4. WhatsApp Number (prefix: wa:):

  • The contact's WhatsApp number in E.164 format
  • Example: GET /contacts/wa:+1234567890/companies

5. Email Address (prefix: uem: or lem:):

Pagination

This endpoint uses cursor-based pagination:

  • per_page: Number of companies 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 /contacts/{id}/companies?per_page=20
  2. Response returns a cursor value (e.g., 12345) and up to 20 companies
  3. Next page: GET /contacts/{id}/companies?per_page=20&cursor=12345
  4. Continue until cursor is null (no more companies available)

Response

Companies are ordered by association ID in descending order (most recent first).
Each company includes:

  • company_id: Internal Customerly company ID
  • custom_company_id: Your custom company identifier (if set)
  • name: Company name
  • created_at: Unix timestamp of company creation
  • last_seen_at: Unix timestamp of last activity
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Contact identifier. Can be: numeric ID (e.g., '12345'), custom user ID with 'cuid:' prefix (e.g., 'cuid:user_123'), custom lead ID with 'clid:' prefix (e.g., 'clid:lead_456'), WhatsApp with 'wa:' prefix (e.g., 'wa:+1234567890'), or email with 'uem:' or 'lem:' prefix (e.g., 'uem:[email protected]' for users or 'lem:[email protected]' for leads).

Query Params
integer
1 to 100

Number of companies 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

Contact 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