List clients

Required scope: clients:read.

Returns the clients this key can access, newest first by default. Filter by ids, external_id, first_name, last_name, q or updated_since. Different filters combine with AND; repeated values of one filter combine with OR.

SSN, date of birth and SSN last four are omitted unless you pass include_sensitive=true, which also requires clients:sensitive:read. To find clients by SSN, use Look up clients so SSNs stay out of URLs.

summary_status summarizes the client as a whole. Use List case units for the status of each claim stage.

GET /api/v2/clients
Bearer token scope clients:read

Query parameters

· 11
limit integer · min: 1· max: 100· default: 50

Maximum number of items to return, from 1 to 100.

cursor string · min length: 1· max length: 4096

The page.next_cursor value from the previous page. Use it with the same filters; cursors expire after 24 hours.

sort string · default: created_at· enum

Field to sort by.

values

  • created_at
  • updated_at
order string · default: desc· enum

Sort direction.

values

  • asc
  • desc
ids array of string · min items: 1· max items: 100

Only return these client IDs. Repeat the parameter for several values, up to 100.

external_id string · min length: 1· max length: 200

Exact match on the client's external ID (the identifier from your own system).

first_name string · min length: 1· max length: 200

Case-insensitive partial match on first name.

last_name string · min length: 1· max length: 200

Case-insensitive partial match on last name.

q string · min length: 1· max length: 200

Case-insensitive partial match on the client's full name.

updated_since string · date-time · pattern

Only return items updated at or after this time (ISO 8601 timestamp, inclusive).

Responses