The Hiver APIs allows you to programmatically access your Hiver Data. You can use Hiver REST APIs to build custom integrations for your team.

If you need any help, you can refer to our help article here.

Overview

To get started you can get the API keys created by referring to the Getting API Key section below. You need these API keys to access any of the APIs listed below.

Getting Started

Getting API key

You need to create an API key to access the Hiver APIs. Please follow these steps to get an API key

Select...
curl 'https://api2.hiverhq.com/v1/inboxes'  --header 'Authorization: Bearer <your-access-token>'

If you suspect that any of your API keys have been compromised, you must take immediate action and delete them from the Hiver admin panel.

Authentication

You need to have access to a Hiver API key to access any of these Hiver APIs. Do note that the API key can be created by an administrator in Hiver. The API key will have the access privileges of an admin user. It is very important to store and use your API keys safely.

Request Format

Hiver uses HTTP methods like GET, POST, PATCH etc for different types of operations. Depending on the type of the request, the query parameters, request body, URL path needs to be formed.

For more details, refer to individual APIs in the API reference section below.

Response format

JSON

Select...
{
  "data":{
    ...
  }
}

JSON

Select...
{
  "results": [
    {..},
    ],
  "pagination": {
    "next_page": "<next-page-token>"
  }
}

For the paginated results, use the next page token in the subsequent request to get further results. Keep continuing to get the next page until the next_page returns null

Pagination

Some endpoints return a list like list of inboxes etc. These endpoints return paginated results. To get the complete list, you need to implement the fetching of paginated lists.

These endpoints support following parameters

All of these field are optional, depending on the endpoint being used.

Errors

The error response will have an appropriate HTTP status code attached in the response. In addition to this, there could also be message, in some cases, to help identify the errors

JSON

Select...
{
  "errors": [
    {"message": "Actual Error message"}
    ..
  ]
}
or
{
  "Message": "Actual Error Message"
}

Refer to the rate-limiting section to get to know more about rate-limiting enforced by Hiver.

Rate limits

Hiver enforces rate-limits based per account. The current rate is limited at 1 RPS (request per second). Once you hit the limit, you’ll start getting 429 Too Many Requests error in the response. If you get this error, retry with an exponential backoff. Continuous retries with 429 error could result in the client-ip/api-key getting blacklisted. Also, the APIs are limited to 5000 requests per day. Please get in touch with us if you want to increase this.

List all the inboxes

Get an Inbox by Id

Get all users in the inbox

Search users in the inbox

Get tags in the inbox

Search tags in the inbox