Contacts

List contact stats

Confirmed, non-deleted inspections. Revenue is the inspection price.

get/v1/contacts/stats

Request

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

Query parameters

rolestring

Count only inspections where the contact had this role (default: any role): agent, client, or an exact role

contact_idstring uuid

Stats for one contact

contact_idsstring

Comma-separated contact ids (up to 200)

agency_idstring uuid

Only contacts linked to this agency

searchstring

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

tagstring[]

Only contacts with any of these tag names; repeat for several

inspection_afterstring

ISO 8601 date or timestamp; count only inspections at/after this time

inspection_beforestring

ISO 8601 date or timestamp; count only inspections before this time

first_inspection_afterstring

ISO 8601 date or timestamp; contacts whose first inspection is at/after this time

first_inspection_beforestring

ISO 8601 date or timestamp; contacts whose first inspection is before this time

inactive_afterstring

With inactive_before: contacts with inspections, but none in this range

inactive_beforestring

With inactive_after: end of the inactive range

birthday_afterstring

MM-DD; birthdays on/after this day of the year

birthday_beforestring

MM-DD; birthdays on/before this day of the year

paid_onlyboolean

Count only paid inspections

sortstring

total_inspections, buying_agent_inspections, listing_agent_inspections, client_inspections, total_revenue, buying_agent_revenue, listing_agent_revenue, first_inspection_at, last_inspection_at, first_name or last_name; prefix '-' for descending

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": [
    {
      "contact_id": "0b6f2c1e-7d1a-4c55-9a5e-2f3b8c1d4e6f",
      "first_name": "Dana",
      "last_name": "Reyes",
      "email": "dana@example.com",
      "agency_id": "6c5b4a39-2817-4f6e-9d0c-8b7a6f5e4d3c",
      "agency_name": "Lone Star Realty",
      "total_inspections": 14,
      "buying_agent_inspections": 11,
      "listing_agent_inspections": 3,
      "client_inspections": 0,
      "total_revenue": 6890,
      "buying_agent_revenue": 5415,
      "listing_agent_revenue": 1475,
      "first_inspection_at": "2026-03-09T14:00:00Z",
      "last_inspection_at": "2026-09-24T16:00:00Z",
      "upcoming_inspections_30d": 2,
      "inspection_count": 14,
      "revenue": 6890
    }
  ],
  "next_cursor": null,
  "total": 1
}

Changes

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