API REFERENCE · SCHEMA

CasePage schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas

itemsRequired

CaseSummary[]

items item fields

Each array item: CaseSummary.

Case queue projection including current linked screening metadata, review ownership, supersession and retention state. Nullable keys remain present. status may be null after evidence expires; inspect evidenceAvailable.

items[].idRequired: string
Format: uuid.
items[].environmentRequired: string
items[].screening_idRequired: string
Format: uuid.
items[].monitor_idRequired: string or null
May be null.; items[].monitor_id fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
items[].decisionRequired: string
items[].business_dispositionRequired: string
items[].review_started_atRequired: string
Format: date-time.
items[].superseded_by_screening_idRequired: string or null
May be null.; items[].superseded_by_screening_id fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
items[].superseded_by_case_idRequired: string or null
May be null.; items[].superseded_by_case_id fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
items[].created_atRequired: string
Format: date-time.
items[].updated_atRequired: string
Format: date-time.
items[].latest_screening_idRequired: string or null
May be null.; items[].latest_screening_id fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
items[].counterparty_idRequired: string or null
May be null.; items[].counterparty_id fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
items[].assignee_idRequired: string or null
May be null.; items[].assignee_id fields and rules
Allowed alternatives
string
null
May be null.
items[].priorityRequired: string
items[].due_atRequired: string or null
May be null.; items[].due_at fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
items[].escalated_atRequired: string or null
May be null.; items[].escalated_at fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
items[].revisionRequired: integer
items[].requires_second_reviewRequired: boolean
items[].review_stateRequired: string
items[].submitted_byRequired: string or null
May be null.; items[].submitted_by fields and rules
Allowed alternatives
string
null
May be null.
items[].approved_byRequired: string or null
May be null.; items[].approved_by fields and rules
Allowed alternatives
string
null
May be null.
items[].submitted_screening_idRequired: string or null
May be null.; items[].submitted_screening_id fields and rules
Allowed alternatives
string
Format: uuid.
null
May be null.
items[].retention_policyRequired: string
items[].retention_yearsRequired: integer or null
May be null.; items[].retention_years fields and rules
Allowed alternatives
integer
null
May be null.
items[].retention_daysRequired: integer or null
May be null.; items[].retention_days fields and rules
Allowed alternatives
integer
null
May be null.
items[].closed_atRequired: string or null
May be null.; items[].closed_at fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
items[].retention_expires_atRequired: string or null
May be null.; items[].retention_expires_at fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
items[].retention_triggerRequired: string
items[].retention_event_atRequired: string or null
May be null.; items[].retention_event_at fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.
items[].retention_event_reasonRequired: string or null
May be null.; items[].retention_event_reason fields and rules
Allowed alternatives
string
null
May be null.
items[].retention_event_actorRequired: string or null
May be null.; items[].retention_event_actor fields and rules
Allowed alternatives
string
null
May be null.
items[].subjectNameRequired: string or null
May be null.; items[].subjectName fields and rules
Allowed alternatives
string
null
May be null.
items[].entityTypeRequired: string or null
May be null.; items[].entityType fields and rules
Allowed alternatives
string
null
May be null.
items[].originRequired: string
items[].statusRequired: string or null
May be null.; items[].status fields and rules
Allowed alternatives
string
Values: "potential_match", "no_match".
null
May be null.
items[].matchCountRequired: integer
Minimum: 0.
items[].evidenceAvailableRequired: boolean
items[].retentionRequired: string
Values: "standard", "minimal".
items[].expiresAtRequired: string or null
May be null.; items[].expiresAt fields and rules
Allowed alternatives
string
Format: date-time.
null
May be null.

nextCursorRequired

string or null

May be null.

nextCursor fields and rules

Allowed alternatives

string
null
May be null.