Skip to main content
GET
List / search contacts

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Query Parameters

after
string
Minimum string length: 1
limit
integer
default:100
Required range: 1 <= x <= 500
includeDeleted
enum<string>
default:false
Available options:
true,
false
q
string
Required string length: 2 - 200
type
enum<string>
Available options:
medical_provider,
insurance_carrier,
referral_partner,
vendor,
other
tag
string
Required string length: 1 - 100
email
string
Required string length: 1 - 200
phone
string
Required string length: 1 - 50
organizationId
string<uuid>

Select one organization for this request. Defaults to the key organization. An HQ key may select an active descendant when its active acting attorney has the required HQ and resource permissions. Repeat the same organizationId on related mutations, upload completion, detail requests, and every cursor page. See /authorization.

Response

{ success: true, contacts: [...], nextCursor }

success
boolean
required
{key}
any