Skip to main content
GET
List a contact's companies

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

contactId
integer
required

The contact id — the contact.id returned by the conversation endpoints.

Example:

815

Query Parameters

page
integer
default:1

Page number, starting at 1. Clamped, never rejected: below 1, or not a number, you get the first page.

Example:

1

per_page
integer
default:25

Results per page. Clamped, never rejected: above 100 you get 100, below 1 you get the default 25.

Required range: x <= 100
Example:

25

Response

One page of the contact's companies. data is empty when it has none.

data
object[]
required

The companies linked to the contact on this page, oldest link first. An empty array when the contact has none.

meta
object
required

Where you are in the result set. There is no total count — ask for the next page while has_next is true.