Skip to main content
Get an inspection
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.

Path Parameters

inspectionId
string<uuid>
required

Query Parameters

include_deleted
boolean

true to return the inspection even if it was deleted

Response

OK

id
string<uuid>
status
enum<string>
Available options:
draft,
waiting,
review,
confirmed,
canceled
confirmed
boolean
scheduled_for
string<date-time> | null
duration_hours
number | null
ends_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>
canceled_at
string<date-time> | null
urgent
boolean
booked_online
boolean
address
object
property
object
description
string | null
notes
string | null

Private notes on the inspection (inspector-only in the app; may include the client's booking notes)

services
object[]
add_ons
object[]
inspectors
object[]
contacts
object[]
price
object
agreements
object
reports
object
portal_url
string

Client report portal for this inspection

referral_source
object | null
discount_codes
object[]
custom_fields
object[]
deleted
boolean

true only for a deleted inspection returned with include_deleted

deleted_at
string<date-time> | null
cover_photo_url
string | null

Signed link to the cover photo, valid for 1 hour

Last modified on October 4, 2026