End UsersBulk DeletionEndpoints

Get a deletion job

Returns the current state of a deletion job, including the per-identifier dispositions. A job for an unknown or unowned job_id returns 404.

Path parameters

job_idstringRequired
Identifier of the deletion job returned when the request was submitted.

Response

The deletion job was found.
job_idstring
Identifier of the deletion job.
typestring
The job type.
client_referencestring or null

The caller-supplied reference from the original request, or null.

statusenum

Lifecycle state of a deletion job. queued and in_progress are non-terminal; completed, partial, and failed are terminal.

identifierslist of objects

Per-identifier outcomes. Inspect this array to understand exactly what was erased, rather than relying on the top-level status alone.

created_atstringformat: "date-time"
Time the job was created, in ISO 8601 format.
completed_atstring or nullformat: "date-time"
Time the job reached a terminal state, in ISO 8601 format, or null while the job is still running.
failure_reasonstring or null

Opaque, machine-readable diagnostic present only when status is failed, or null otherwise. This value is subject to change; to understand outcomes per identifier, inspect each identifier’s disposition and reason.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error