API

Welcome to the HIVO API! You can use our API to access HIVO API endpoints.

This API follows the json:api specification. You can register a new HIVO API key by contacting HIVO Support. HIVO expects a USER_ID and API_KEY in all API requests to the server in headers.

Response Details

Every response has the following properties:

• All responses are of type application/json; charset=utf-8.

• All responses are a JSON object containing the meta property.

• The response either contains the data or errors property depending on whether the request was successful. The two properties will never coexist.

• The meta object always contains a timestamp property, which is a server timestamp in milliseconds.

• If the User was successfully authenticated, the meta object will contain the properties:

  • authentication - property describing how the User was authenticated. If using an API key, this will be "apiKey".

  • links.meta - link to the User who was authenticated.

• If the request contains the Accept-Encoding: gzip header, the response may be gzipped and returned with the Content-Encoding: gzip header.