Skip to main content
GET
Get data erasure requests

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

status
enum<string> | null

Filter by erasure request status. Where a patient's erasure request has got to. The happy path is PendingVerification → Verified → Processing → Completed. The side exits are all terminal: a link that ran out of time, a request the clinic withdrew, or a run that failed part way and needs a person to look at it before it is tried again.

Mevcut seçenekler:
pending_verification,
verified,
processing,
completed,
expired,
cancelled,
failed
created_at_from
string<date-time> | null

Filter records created on or after this date.

created_at_to
string<date-time> | null

Filter records created on or before this date.

per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
created_at,
verified_at,
executed_at,
status,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null

Yanıt

Paginated set of DataErasureRequestResource

data
DataErasureRequestResource · object[]
gerekli
meta
object
gerekli