Hivebuy External API (v2)

Sections

Theme switcher

Retrieve one member

Header Parameters

Authorizationstring

Path Parameters

companyIdstring Required

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

idstring Required

Row id. A row belonging to another company is 404 on every verb, never 403.

Response

200
Object

The member.

Response Attributes

idstring
emailstring

Login email. Unique across the platform.

firstNamestring | null
lastNamestring | null
namestring

Display name, derived from first and last name.

readOnly
isActiveboolean

Whether the login is active. Deactivated members stay in the list.

externalIdstring | null

Reference in your system (e.g. the personnel number in your HR system). Not interpreted by Hivebuy.

rolesarray

Roles in the URL company. O OWNER (company admin), MD MANAGING DIRECTOR, AC ACCOUNTANT, BU BUYER, AP APPROVER, AL APPROVER_LIMITED, CO CONTRACT_OWNER, AU API_USER, CR CONTROLLER, NA NEWS_ADMIN, AD AUDITOR, LA LEGAL_ENTITY_ACCOUNTANT. Empty means a basic user.

Enum values:
OMDACBUAPALCOAUCRNA
... 2 other enums

Show child attributes

supervisorstring | null

The supervisor on this company's membership.

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

404
Object

No such row for this company, including a row that belongs to another company, and a soft-deleted row you tried to write to. The API does not confirm whether the id exists elsewhere.

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