List case units

Required scope: clients:read.

Returns case units across every client this key can access, most recently updated first by default. Use it to sync case units account-wide, for example with updated_since. For one client's case units, use List a client's case units.

Filter by stage, program, cycle, lifecycle_state, active or updated_since. Different filters combine with AND; repeated values of one filter combine with OR. A proceeding that covers both SSDI and SSI appears once, lists both programs, and matches either program filter. Units in the determined and quality_review states are active; closed and dropped units are inactive.

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/case-units
Bearer token scope clients:read

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