Contacts

List contacts

get/v1/contacts

Request

  • Base URL: https://api.hiveinspect.com
  • URL: https://api.hiveinspect.com/v1/contacts
  • Auth: HTTP bearer

Query parameters

idsstring

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

rolestring

Only contacts who have had this role on an inspection: agent (Buyer Agent or Listing Agent), client (Customer), or an exact role: Customer, Buyer Agent, Listing Agent, Sub Contractor, Insurance Agent, Lender, Builder, Transaction Coordinator, Attorney, Title Company, Others

tag_idstring

Only contacts with this tag

tagstring[]

Only contacts with any of these tag names (case-insensitive); repeat for several

agency_idstring uuid

Only contacts linked to this agency (see /v1/agencies)

emailstring

Exact email match (case-insensitive)

searchstring

Name, email, or phone (3+ digits) contains

updated_sincestring

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

sortstring

first_name, last_name, agency_name, created_at or updated_at; prefix '-' for descending (default: by id)

cursorstring

next_cursor from the previous page

limitinteger

Page size, 1-200 (default 50)

Response

OK

next_cursorstring nullable
totalinteger

Every record matching the filters, across all pages

Example response

{
  "data": [
    {
      "id": "0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f",
      "first_name": "Dana",
      "last_name": "Reyes",
      "email": "dana@example.com",
      "cc_email": null,
      "phone": "(512) 555-0142",
      "business_name": null,
      "agency_name": "Lone Star Realty",
      "agency_id": "6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c",
      "agency": {
        "id": "6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c",
        "name": "Lone Star Realty",
        "phone": "(512) 555-0100",
        "website": "https://lonestarrealty.example.com"
      },
      "uses_agency_address": true,
      "address": "410 Oak St",
      "address_line2": null,
      "city": "Austin",
      "state": "TX",
      "zip": "78701",
      "country": "US",
      "birthday": "1988-04-12",
      "website": null,
      "social": null,
      "notes": "Prefers text messages",
      "photo_url": "https://files.example.com/signed-link-valid-for-1-hour",
      "tags": [
        {
          "id": "5a1d9c3e-2b7f-4f0a-8c6d-1e2f3a4b5c6d",
          "name": "Top agent"
        }
      ],
      "roles": [
        "Buyer Agent",
        "Listing Agent"
      ],
      "created_at": "2026-03-02T15:04:11Z",
      "updated_at": "2026-09-18T20:41:07Z"
    }
  ],
  "next_cursor": "0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f",
  "total": 1
}

Changes

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