Skip to main content
GET
List 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

Query Parameters

Text matched against the company name, the domain and the values of the company attributes your role can see. Punctuation is not normalized: 12.345.678/0001-90 does not find a company stored as 12345678000190. For a CNPJ or another identifier, filter with attribute_key and attribute_value instead. Longer than 200 characters, it is cut to the first 200. Sent as an array or an object (search[]=), it answers 400.

Maximum string length: 200
Example:

"rapida"

attribute_key
string

The key of a company custom attribute, for an exact match together with attribute_value. Sending only one of the two, or a key that is not a company attribute your role can read, answers 400 with error.details naming attribute_key; the message lists the keys available to you.

Example:

"cnpj"

attribute_value
string

The value attribute_key must hold, compared as text and exactly — no partial match, no case folding, and spaces count: the value is compared as you send it.

One exception, for document numbers such as a CNPJ, and only on a text attribute: when the value you send has at least 8 digits and contains only digits, dots, slashes, hyphens or spaces, a stored value made of those same characters, with at least 8 digits, also matches if its digits alone are the same — on this path punctuation and spaces are ignored on both sides. So 12.345.678/0001-90 finds a company stored as 12345678000190, and 12345678000190 finds one stored as 12.345.678/0001-90. Number and date attributes never match by digits — send them exactly as stored.

Example:

"12345678000190"

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 companies. data is empty when nothing matches.

data
object[]
required

The companies on this page, ordered by name.

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.