Skip to main content
List the connection's companies

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string[]

Return only these fields of each row. id is always returned. Fields: id, external_company_id, name, registration_number, country, company_id, linked_by, can_create_company.

Response

The connection's companies, by name.

data
object[]
required
discovers_companies
boolean
required

Whether the connection's login reaches several companies, found by listing them (listIntegrationCompanies). Otherwise it reaches one.