Hivebuy External API (v2)

Sections

Theme switcher

List purchase requests

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
statusstring

Narrow by status. Repeat the key or send a comma list. An unknown value is a 400 listing the valid ones. Codes: D draft, P pending, A approved, R rejected, C cancelled, CR change request.

Enum values:
DPARCCR
externalIdstring

Request number. Non-digits are stripped, so the display form works; a value with no digits is a 400.

externalOrderNumberstring

Exact match on the linked order's external (ERP) order number.

clientExternalIdstring

Exact match on the linked order's client external id.

requestedBystring

The requester, by user UUID or email. Anything else is a 400.

requestedAfterstring

Requests filed at or after this ISO-8601 timestamp.

requestedBeforestring

Requests filed at or before this timestamp.

searchstring

Case-insensitive contains over title, externalId, externalOrderNumber and clientExternalId.

orderingstring

Sort key, - for descending. Default -externalId. A stable id tiebreaker is always appended.

Enum values:
requestedAt-requestedAtexternalId-externalIdstatus-status

Path Parameters

companyIdstring Required

Company ID. Must be one of the IDs returned by GET /api/v2/companies/.

Response

200
Object

The standard paginated envelope.

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

400
Object

A query parameter was invalid or unknown. attr names it.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

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