Skip to main content
GET
List Companies

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

page
integer

Page number

limit
integer

Limit (use a small limit and read pagination.total to count matches)

companyIds
string[]

List of company id

query
string

Search text matched against company name or external id

status
string[]

Filter by company status (e.g. accepted, pending). Repeat the param for multiple values.

isRootCompany
boolean

When true, only parent/root companies (isRootCompany=true). When false, only non-root.

isTestCompany
boolean

When true, only test companies. When false, exclude test companies.

showOnlyParents
boolean

When true, only companies that are organization parents (id equals mainParentId or mainParentId is null).

Respuesta

200 - application/json

A list of companies

data
any[]
requerido
pagination
object
requerido