Skip to main content
GET
List companies
Results include only credential-authorized companies. Each Company object contains only id and name. When supplied, companyId and name must be nonempty. limit is an integer from 1 to 100 (default 50), and offset is a nonnegative integer (default 0). Invalid query values return 400 invalid_input; a companyId outside the key’s policy 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

Optional exact ID filter.

Minimum string length: 1
name
string

Optional case-insensitive partial match.

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

Response

Authorized companies.

companies
object[]
required
pagination
object
required