Skip to main content
List inspections
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.

Authorizations

Authorization
string
header
required

Your API key from Business Tools → API Access.

Query Parameters

ids
string

Comma-separated inspection ids (up to 200) to fetch in one call

status
string

Comma-separated: draft, waiting, review, confirmed, canceled. Default: every status except canceled

include_canceled
boolean

true to include canceled inspections

include_deleted
boolean

true to also return deleted inspections (deleted: true, deleted_at set)

scheduled_after
string

ISO 8601 date or timestamp; scheduled at/after this time

scheduled_before
string

ISO 8601 date or timestamp; scheduled before this time

updated_since
string

ISO 8601 date or timestamp; created or changed at/after this time

inspector_id
string<uuid>

Assigned to this inspector

contact_id
string<uuid>

This contact is on the inspection

service_id
string<uuid>

Includes this service

add_on_id
string<uuid>

Includes this add-on

payment_status
string

Comma-separated: paid, pending, partial, refunded, invoiced, processing, pay_at_close, failed

paid
boolean

true / false

agreements_signed
boolean

true: every agreement signed

published
boolean

true: at least one report published

zip
string

Exact ZIP / postal code

Address, or a linked contact's name, email or phone, contains

sort
string

scheduled_for, created_at, updated_at or price; prefix '-' for descending (default: -scheduled_for)

cursor
string

next_cursor from the previous page

limit
integer

Page size, 1-200 (default 50)

Required range: 1 <= x <= 200

Response

OK

data
object[]
next_cursor
string | null
total
integer

Every record matching the filters, across all pages

Last modified on October 2, 2026