List a client's case units

Required scope: clients:read.

Returns the case units for one client, most recently updated first by default. Each stage and cycle is its own case unit, so a client usually has several.

Accepts the same filters, sorting and pagination as List case units. A client that does not exist or that this key cannot access returns 404, not an empty list.

When sorting by created_at, the date used is when the unit entered its stage. Decision source_documents are included only when the key also has documents:read.

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

Path parameters

· 1
id string required

Client ID.

Query parameters

· 10
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: updated_at· enum

Field to sort by.

values

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

Sort direction.

values

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

Only return case units in these stages. Repeat the parameter for several values.

values

  • initial
  • recon
  • reconsideration
  • hearing
  • appeals
program array of string · min items: 1· max items: 100

Only return case units for these programs. Repeat the parameter for several values.

values

  • SSDI
  • SSI
cycle integer · min: 1· max: 2147483647

Only return case units in this claim cycle.

lifecycle_state array of string · min items: 1· max items: 100

Only return case units in these lifecycle states. Repeat the parameter for several values.

values

  • processing
  • determined
  • quality_review
  • closed
  • dropped
active string · enum

Only return active (true) or inactive (false) case units.

values

  • true
  • false
updated_since string · date-time · pattern

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

Responses