> ## 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.

# Hive Inspect API: Connect Your Tools to Your Hive Data

> Use the Hive Inspect API to read and update contacts and to read inspections, events and agent stats from your CRM, spreadsheets or your own scripts.

<p className="hive-locator">In the dashboard: <strong>Business Tools → API Access</strong></p>

<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. To ask for early access, message us from the chat bubble in your dashboard.
</Note>

The Hive Inspect API lets other tools work with your account's data. Use it to keep a CRM in sync, build agent scorecards, feed a spreadsheet or dashboard, or automate follow-ups with your own code.

## What you can do

| Data | Access | What it covers |
| - | - | - |
| **Contacts** | Read and write | Agents, clients and every other contact. List, filter, create and update. Set tags and the photo. |
| **Contact tags** | Read | The tags you created in the dashboard, with how many contacts hold each one. |
| **Contact stats** | Read | Buying, listing and client inspection counts and revenue per contact, with date filters. |
| **Agencies** | Read | The brokerages your agents belong to, with phone, website and address. |
| **Inspections** | Read | Schedule, address, cover photo, services, inspectors, contacts, price and payment, agreement and report status. |
| **Inspection attachments** | Read and upload | Additional reports and additional documents, per inspection or across your whole account. |
| **Webhooks** | Push | Hive tells your URL when an inspection is confirmed, rescheduled, canceled or published, or a contact changes. |
| **MCP** | Read | Connect Claude, ChatGPT or another AI assistant and ask questions about your data. |
| **Inspection events** | Read | Extra appointments on an inspection, such as a radon drop-off or pick-up. |

Not available yet: deleting or merging contacts, creating or deleting tags, creating or changing agencies, creating or changing inspections, report content, deleting attachments, payment and invoice details, and agreement documents.

## Make your first request

<Steps titleSize="h3">
  <Step title="Create an API key">
    Go to **Business Tools → API Access** and click **Create API Key**. Copy the key right away. Hive shows the full key only once.
  </Step>

  <Step title="Call the API">
    Send the key in the `Authorization` header. This example lists five agents:

    ```bash theme={"theme":{"light":"github-light","dark":"vesper"}}
    curl "https://api.hiveinspect.com/v1/contacts?role=agent&limit=5" \
      -H "Authorization: Bearer YOUR_API_KEY"
    ```
  </Step>

  <Step title="Read the response">
    Lists return your records in `data`, a `next_cursor` to fetch the next page, and the `total` number of matching records:

    ```json theme={"theme":{"light":"github-light","dark":"vesper"}}
    {
      "data": [
        {
          "id": "0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f",
          "first_name": "Dana",
          "last_name": "Reyes",
          "email": "dana@example.com",
          "roles": ["Buyer Agent"]
        }
      ],
      "next_cursor": "0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f",
      "total": 214
    }
    ```
  </Step>
</Steps>

## The basics

* **Base URL:** `https://api.hiveinspect.com`
* **Format:** JSON requests and responses over HTTPS
* **Your data only:** a key can only reach the organization it was created in
* **Timestamps:** every timestamp in a response is in UTC

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key-round" href="/api/authentication">
    Create, use and delete API keys.
  </Card>

  <Card title="Pagination" icon="list" href="/api/pagination">
    Page through long lists with a cursor.
  </Card>

  <Card title="Dates and time zones" icon="clock" href="/api/dates-and-time-zones">
    How date filters use your company's time zone.
  </Card>

  <Card title="Rate limits and errors" icon="gauge" href="/api/rate-limits-and-errors">
    Limits, status codes and how to retry.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/api/webhooks">
    Get a message when something changes.
  </Card>

  <Card title="Connect an AI assistant" icon="sparkles" href="/api/mcp">
    Ask Claude or ChatGPT about your data.
  </Card>

  <Card title="How agencies work" icon="building-2" href="/api/agencies">
    Link contacts to their brokerage.
  </Card>
</CardGroup>


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