> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hiveinspect.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List inspections

> Read-only. Deleted and sample inspections are never returned.

<Note>
  **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.
</Note>


## OpenAPI

````yaml /api/openapi.json get /v1/inspections
openapi: 3.1.0
info:
  title: Hive Inspect API
  version: 1.0.0
  description: Connect other tools to your Hive Inspect contacts, inspections and events.
servers:
  - url: https://api.hiveinspect.com
security:
  - bearerAuth: []
tags:
  - name: Contacts
    description: Agents, clients and every other contact in your organization.
  - name: Agencies
    description: The brokerages your agents belong to. Read-only.
  - name: Inspections
    description: Read-only access to your inspections.
  - name: Attachments
    description: Additional reports and additional documents on an inspection.
  - name: Events
    description: Extra appointments on an inspection, such as a radon drop-off or pick-up.
paths:
  /v1/inspections:
    get:
      tags:
        - Inspections
      summary: List inspections
      description: Read-only. Deleted and sample inspections are never returned.
      operationId: listInspections
      parameters:
        - name: ids
          in: query
          required: false
          description: Comma-separated inspection ids (up to 200) to fetch in one call
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: >-
            Comma-separated: draft, waiting, review, confirmed, canceled.
            Default: every status except canceled
          schema:
            type: string
        - name: include_canceled
          in: query
          required: false
          description: true to include canceled inspections
          schema:
            type: boolean
        - name: include_deleted
          in: query
          required: false
          description: >-
            true to also return deleted inspections (deleted: true, deleted_at
            set)
          schema:
            type: boolean
        - name: scheduled_after
          in: query
          required: false
          description: ISO 8601 date or timestamp; scheduled at/after this time
          schema:
            type: string
        - name: scheduled_before
          in: query
          required: false
          description: ISO 8601 date or timestamp; scheduled before this time
          schema:
            type: string
        - name: updated_since
          in: query
          required: false
          description: ISO 8601 date or timestamp; created or changed at/after this time
          schema:
            type: string
        - name: inspector_id
          in: query
          required: false
          description: Assigned to this inspector
          schema:
            type: string
            format: uuid
        - name: contact_id
          in: query
          required: false
          description: This contact is on the inspection
          schema:
            type: string
            format: uuid
        - name: service_id
          in: query
          required: false
          description: Includes this service
          schema:
            type: string
            format: uuid
        - name: add_on_id
          in: query
          required: false
          description: Includes this add-on
          schema:
            type: string
            format: uuid
        - name: payment_status
          in: query
          required: false
          description: >-
            Comma-separated: paid, pending, partial, refunded, invoiced,
            processing, pay_at_close, failed
          schema:
            type: string
        - name: paid
          in: query
          required: false
          description: true / false
          schema:
            type: boolean
        - name: agreements_signed
          in: query
          required: false
          description: 'true: every agreement signed'
          schema:
            type: boolean
        - name: published
          in: query
          required: false
          description: 'true: at least one report published'
          schema:
            type: boolean
        - name: zip
          in: query
          required: false
          description: Exact ZIP / postal code
          schema:
            type: string
        - name: search
          in: query
          required: false
          description: Address, or a linked contact's name, email or phone, contains
          schema:
            type: string
        - name: sort
          in: query
          required: false
          description: >-
            scheduled_for, created_at, updated_at or price; prefix '-' for
            descending (default: -scheduled_for)
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: '`next_cursor` from the previous page'
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Page size, 1-200 (default 50)
          schema:
            type: integer
            minimum: 1
            maximum: 200
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InspectionList'
        '400':
          description: Invalid parameter
        '401':
          description: Missing, invalid or inactive API key
        '429':
          description: Rate limit exceeded (120 requests/minute per key owner)
components:
  schemas:
    InspectionList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Inspection'
        next_cursor:
          type:
            - string
            - 'null'
        total:
          type: integer
          description: Every record matching the filters, across all pages
      example:
        data:
          - 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'
        next_cursor: WzE3OTAyNjU2MDAuMCwiM2YyYTljMWUiXQ
        total: 1
    Inspection:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - draft
            - waiting
            - review
            - confirmed
            - canceled
        confirmed:
          type: boolean
        scheduled_for:
          type:
            - string
            - 'null'
          format: date-time
        duration_hours:
          type:
            - number
            - 'null'
        ends_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        canceled_at:
          type:
            - string
            - 'null'
          format: date-time
        urgent:
          type: boolean
        booked_online:
          type: boolean
        address:
          type: object
          properties:
            full:
              type:
                - string
                - 'null'
            street:
              type:
                - string
                - 'null'
            unit:
              type:
                - string
                - 'null'
            city:
              type:
                - string
                - 'null'
            state:
              type:
                - string
                - 'null'
            zip:
              type:
                - string
                - 'null'
            county:
              type:
                - string
                - 'null'
            country:
              type:
                - string
                - 'null'
        property:
          type: object
          properties:
            type:
              type:
                - string
                - 'null'
            square_footage:
              type:
                - integer
                - 'null'
            year_built:
              type:
                - integer
                - 'null'
            bedrooms:
              type:
                - string
                - 'null'
            bathrooms:
              type:
                - string
                - 'null'
            occupancy:
              type:
                - string
                - 'null'
            foundation:
              type:
                - string
                - 'null'
        description:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
          description: >-
            Private notes on the inspection (inspector-only in the app; may
            include the client's booking notes)
        services:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type:
                  - string
                  - 'null'
        add_ons:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type:
                  - string
                  - 'null'
              quantity:
                type: integer
        inspectors:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type:
                  - string
                  - 'null'
        contacts:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              role:
                type:
                  - string
                  - 'null'
              first_name:
                type:
                  - string
                  - 'null'
              last_name:
                type:
                  - string
                  - 'null'
              email:
                type:
                  - string
                  - 'null'
              phone:
                type:
                  - string
                  - 'null'
              agency_id:
                type:
                  - string
                  - 'null'
              agency_name:
                type:
                  - string
                  - 'null'
        price:
          type: object
          properties:
            quote:
              type:
                - number
                - 'null'
            amount_paid:
              type:
                - number
                - 'null'
            amount_due:
              type:
                - number
                - 'null'
            payment_status:
              type:
                - string
                - 'null'
            paid:
              type: boolean
            pay_at_close_status:
              type:
                - string
                - 'null'
        agreements:
          type: object
          properties:
            present:
              type: boolean
            all_signed:
              type: boolean
            items:
              type: array
              items:
                type: object
                properties:
                  name:
                    type:
                      - string
                      - 'null'
                  status:
                    type:
                      - string
                      - 'null'
                  signed_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
        reports:
          type: object
          properties:
            status:
              type: string
              enum:
                - na
                - pending
                - partial
                - published
            items:
              type: array
              items:
                type: object
                properties:
                  id:
                    type:
                      - string
                      - 'null'
                  name:
                    type:
                      - string
                      - 'null'
                  status:
                    type:
                      - string
                      - 'null'
        portal_url:
          type: string
          description: Client report portal for this inspection
        referral_source:
          oneOf:
            - type: object
              properties:
                id:
                  type: string
                name:
                  type:
                    - string
                    - 'null'
            - type: 'null'
        discount_codes:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type:
                  - string
                  - 'null'
              code:
                type:
                  - string
                  - 'null'
        custom_fields:
          type: array
          items:
            type: object
            properties:
              name:
                type:
                  - string
                  - 'null'
              value:
                type:
                  - string
                  - 'null'
        deleted:
          type: boolean
          description: true only for a deleted inspection returned with include_deleted
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
        cover_photo_url:
          type:
            - string
            - 'null'
          description: Signed link to the cover photo, valid for 1 hour
      example:
        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'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key from Business Tools → API Access.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.