Get a client

Required scope: clients:read.

Returns one client.

Set include_case_units=true to embed every one of the client's case units in case_units, most recently updated first, using the same shape as Get a case unit. Without it, case_units is omitted; use List a client's case units to filter or page through them instead.

SSN, date of birth and SSN last four are omitted unless you pass include_sensitive=true, which also requires clients:sensitive:read.

The ETag response header identifies this version of the client. Send it as If-Match to Update a client. It covers the client's own fields, not embedded case units; each case unit has its own resource_version.

GET /api/v2/clients/{id}
Bearer token scope clients:read

Path parameters

· 1
id string required

Client ID.

Query parameters

· 2
include_sensitive string · enum

Set to true to include SSN, date of birth and SSN last four. Requires clients:sensitive:read.

values

  • true
  • false
include_case_units string · enum

Set to true to embed all of the client's case units in case_units.

values

  • true
  • false

Responses