Getting Started

Sections

Theme switcher

Business Manager Companies

Header Parameters

Authorizationstring

Token used for authentication.

Query Parameters

idinteger

Business Manager company id - appended to the URL as the final path segment (/business-manager/companies/v2/), not sent as a query string. When given, the single company is returned.

updated_sincestring

ISO 8601 datetime WITH an explicit UTC offset (e.g. 2026-09-01T00:00:00+00:00). Returns records changed strictly after it. Missing offset gives 400.

activestring

Filter on is_active. Omitted returns both active and inactive.

Enum values:
truefalse10
pageinteger

Page number, 1-based. Ignored unless limit is also given.

Minimum
1
limitinteger

Page size, clamped to 2000.

Minimum
1
Maximum
2000

Response

200
Object

Paginated companies (no id) or the single company (id given)

Response Attributes

totalnumber
pagenumber
page_sizenumber
itemsarray

Show child attributes

idnumber
namestring
internal_idstring
countryobject

Show child attributes

is_activeboolean
principal_groupobject

Show child attributes

address_line_1string
address_line_2string
address_line_3string
address_line_4string
citystring
zipstring
vat_numberstring
updated_byobject

Show child attributes

updated_atstring
400
Object

Invalid updated_since / active / page / limit

Response Attributes

errorobject

Show child attributes

404
Object

Unknown id (single lookup only)

Response Attributes

errorobject

Show child attributes

default
Object

Unexpected error

Response Attributes

codeinteger Required
messagestring Required

GET

/

Select
1

Response