Hivebuy External API (v2)

Sections

Theme switcher

List accessible companies

Header Parameters

Authorizationstring

Query Parameters

pageinteger

Page number, starting at 1.

Minimum
1
Default value
1
pageSizeinteger

Results per page. Default 25, maximum 100.

Minimum
1
Maximum
100
Default value
25

Response

200
Object

Paginated list of companies.

Response Attributes

totalRecordsinteger

Total matching records across all pages.

totalPagesinteger

Total pages. 0 when there are no results.

currentPageinteger

The page this response contains.

resultsarray

Show child attributes

401
Object

Missing, invalid, or expired API key, or a session credential was used instead of an API key.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

403
Object

Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

429
Object

Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

GET

/

Select
1

Response