Skip to main content
The Hive Inspect API is a work in progress. It is available to a small group of accounts today, and the release for everyone is coming very soon. To ask for early access, message us from the chat bubble in your dashboard.
List endpoints return one page at a time. Each response has three parts:
  • data: the records on this page
  • next_cursor: a value to fetch the next page, or null when there are no more
  • total: how many records match your filters across all pages

​
Page through a list

1

Request the first page

Set how many records you want with limit. The default is 50 and the maximum is 200.
2

Pass the cursor back

Take next_cursor from the response and send it as cursor. Keep every other parameter the same.
3

Stop when the cursor is null

Repeat until next_cursor is null. That page is the last one.

​
Things to know

  • A page can be shorter than limit. With some filters a page holds fewer records even though more pages follow. Always check next_cursor, not the page size.
  • A cursor belongs to its request. Use a cursor only with the same filters and the same sort it came from. A cursor from a different sort returns 400.
  • Treat the cursor as opaque. Its format can change. Pass it back exactly as you received it.
  • total counts every page. It is the number of records that match your filters, not the size of this page. To get only a count, send limit=1 and read total.

​
Fetch several records by id

Contacts, agencies and inspections accept an ids parameter. Send up to 200 ids, separated by commas, to fetch them in one request:
  • An id that is not in your account is left out. It does not cause an error.
  • Other filters still apply, so ids together with role=agent returns only the agents among those ids.
  • On inspections, ids also returns canceled inspections. Deleted inspections need include_deleted=true.
  • Contact stats use contact_ids instead of ids.

​
Sorting

Most lists accept a sort parameter. Add a - in front for descending order, for example sort=-scheduled_for for the newest inspections first. Each endpoint’s reference page lists the fields you can sort by.

​
Sync only what changed

To keep another system in sync, store the time of your last sync and ask only for newer records with updated_since:
This is faster than downloading everything each time, and it keeps you well inside the rate limit.

​
Pick up deleted inspections

A deleted inspection drops out of the normal list, so a sync would never learn it is gone. Add include_deleted=true to get deleted inspections too. Each one has deleted: true and a deleted_at time:
When you see deleted: true, remove that inspection from your own system.

​
Overlap your sync window

Start each sync a few minutes before the last one ended. A record saved while your previous sync was running can otherwise be missed. Records you receive twice have the same id, so they are safe to save again.
Last modified on October 2, 2026