Inspections

Get an inspection

get/v1/inspections/{inspectionId}

Request

  • Base URL: https://api.hiveinspect.com
  • URL: https://api.hiveinspect.com/v1/inspections/{inspectionId}
  • Auth: HTTP bearer

Path parameters

inspectionIdstring uuid required

Query parameters

include_deletedboolean

true to return the inspection even if it was deleted

Response

OK

idstring uuid
status'draft' | 'waiting' | 'review' | 'confirmed' | 'canceled'
confirmedboolean
scheduled_forstring date-time nullable
duration_hoursnumber nullable
ends_atstring date-time nullable
created_atstring date-time
updated_atstring date-time
canceled_atstring date-time nullable
urgentboolean
booked_onlineboolean
descriptionstring nullable
notesstring nullable

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

portal_urlstring

Client report portal for this inspection

deletedboolean

true only for a deleted inspection returned with include_deleted

deleted_atstring date-time nullable
cover_photo_urlstring nullable

Signed link to the cover photo, valid for 1 hour

Example response

{
  "id": "3f2a9c1e-6b4d-4e7a-8c15-9d0e1f2a3b4c",
  "status": "confirmed",
  "confirmed": true,
  "scheduled_for": "2026-09-24T16:00:00Z",
  "duration_hours": 3,
  "ends_at": "2026-09-24T19:00:00Z",
  "created_at": "2026-09-10T18:22:40Z",
  "updated_at": "2026-09-22T13:05:19Z",
  "canceled_at": null,
  "deleted": false,
  "deleted_at": null,
  "urgent": false,
  "booked_online": true,
  "address": {
    "full": "12 Oak St, Austin, TX 78701",
    "street": "12 Oak St",
    "unit": null,
    "city": "Austin",
    "state": "TX",
    "zip": "78701",
    "county": "Travis",
    "country": "US"
  },
  "property": {
    "type": "Single Family",
    "square_footage": 2100,
    "year_built": 1999,
    "bedrooms": "3",
    "bathrooms": "2",
    "occupancy": "Occupied",
    "foundation": "Slab"
  },
  "description": null,
  "notes": "Gate code 4411",
  "services": [
    {
      "id": "a1b2c3d4-1111-4a2b-8c3d-4e5f6a7b8c9d",
      "name": "Residential Inspection"
    }
  ],
  "add_ons": [
    {
      "id": "b2c3d4e5-2222-4b3c-9d4e-5f6a7b8c9d0e",
      "name": "Radon Test",
      "quantity": 1
    }
  ],
  "inspectors": [
    {
      "id": "c3d4e5f6-3333-4c4d-8e5f-6a7b8c9d0e1f",
      "name": "Alex Morgan"
    }
  ],
  "contacts": [
    {
      "id": "c2a7e1d4-58b3-4f6a-9d0e-7b1c2d3e4f5a",
      "role": "Customer",
      "first_name": "Jordan",
      "last_name": "Lee",
      "email": "jordan@example.com",
      "phone": "(512) 555-0188",
      "agency_id": null,
      "agency_name": null
    },
    {
      "id": "0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f",
      "role": "Buyer Agent",
      "first_name": "Dana",
      "last_name": "Reyes",
      "email": "dana@example.com",
      "phone": "(512) 555-0142",
      "agency_id": "6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c",
      "agency_name": "Lone Star Realty"
    }
  ],
  "price": {
    "quote": 550,
    "amount_paid": 550,
    "amount_due": 0,
    "payment_status": "paid",
    "paid": true,
    "pay_at_close_status": null
  },
  "agreements": {
    "present": true,
    "all_signed": true,
    "items": [
      {
        "name": "Pre-Inspection Agreement",
        "status": "signed",
        "signed_at": "2026-09-12T02:14:55Z"
      }
    ]
  },
  "reports": {
    "status": "published",
    "items": [
      {
        "id": "d4e5f6a7-4444-4d5e-9f6a-7b8c9d0e1f2a",
        "name": "Home Inspection Report",
        "status": "published"
      }
    ]
  },
  "portal_url": "https://reports.hiveinspect.com/dashboard/reports?reportId=3f2a9c1e-6b4d-4e7a-8c15-9d0e1f2a3b4c",
  "cover_photo_url": "https://files.example.com/signed-link-valid-for-1-hour",
  "referral_source": {
    "id": "9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b",
    "name": "Google"
  },
  "discount_codes": [
    {
      "id": "4f3e2d1c-0b9a-4876-9543-210fedcba987",
      "name": "Fall special",
      "code": "FALL50"
    }
  ],
  "custom_fields": [
    {
      "name": "Detached Garage",
      "value": "true"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.