Skip to main content
GET
List companies
Results include only non-archived credential-authorized companies. Each Company object contains only id and name. Empty companyId and name values are ignored. Nonempty values may be at most 100 characters. limit is an integer from 1 to 100 (default 50), and offset is a nonnegative integer (default 0). Empty pagination values use the defaults. Invalid query values return 400 invalid_input. A company ID not accessible to the key returns 403 forbidden.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

companyId
string

Filter by exact ID when provided. An empty value is ignored.

Maximum string length: 100
name
string

Use a case-insensitive partial match when provided. An empty value is ignored.

Maximum string length: 100
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991

Response

Non-archived authorized companies.

companies
object[]
required
pagination
object
required