en
Customers›List customers

List customers

Returns a paginated, searchable directory of the business's customer records — the customer database (CRM) behind every booking and work order. Supports the `since`/`next_since` cursor for incremental sync into an external CRM, ERP or marketing tool.

Arguments

qstringqueryoptional
Fuzzy search over name, UID, phone, email
phonestringqueryoptional
EXACT caller lookup by phone in E.164 with the leading + (e.g. +16135550188). Separators are stripped, so '+1 (613) 555-0188' works; a bare national number without a country code is refused with PHONE_INVALID. Use this rather than q to identify a caller — q is a substring match and can return the wrong person.
tierarray<string>queryoptional
Filter by tier: regular|vip (repeatable)
statusstringqueryoptional
Filter by status: active|inactive
preferred_technician_idstringqueryoptional
Filter by preferred technician UUID
sortstringqueryoptional
Sort: created_at_desc|created_at_asc|name_asc|name_desc|uid_asc|uid_desc (default: created_at_desc)
pageintegerqueryoptional
Page number (default 1)
limitintegerqueryoptional
Page size (default 15, max 1000)
sincestringqueryoptional
RFC3339 cursor for short-polling; echo back next_since from prior response
GET/v1/customers
curl -X GET "https://api.crisphive.com/v1/customers" \
  -H "Authorization: Bearer chsk_test_4eC8xQ9mZ2pL7Ka0rT"

Responses