CAcasemark
Matters

Inspect a Matter purge

Changed on

Returns a Matter purge receipt for manual diagnostics. Integrations should subscribe to Matter purge webhooks rather than polling this route.

get/matters/v1/purges/{purgeId}

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/matters/v1/purges/{purgeId}
  • Auth
    HTTP bearer

Path parameters

purgeIdstring required

Response

Matter purge receipt

purge_idstring required
status'queued' | 'in_progress' | 'failed' | 'completed' required
attemptinteger required
matter_idstring required
vault_idstring required
workflow_idstring nullable required
terminal_event_idstring nullable

Stable ID of the failed or completed terminal webhook event

failure_codestring nullable
requested_atstring date-time
started_atstring date-time nullable
failed_atstring date-time nullable
completed_atstring date-time nullable

Changes