Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-26104113247.1 KB
Create a Retrieval

Create a Retrieval

Creates a data retrieval job.

post/data-retrievals/v3.0

Query parameters

tokenstring

Your project token

Request body

distinct_idsstring[]
compliance_typestring

Select CCPA or GDPR. Default is GDPR.

disclosure_typestring

Only required if compliance_type = CCPA. Can be Data, Categories, or Sources. Default is Data.

Example request

{
  "distinct_ids": [
    "distinct_id_1",
    "distinct_id_2",
    "distinct_id_3"
  ]
}

Response

Success

statusstring required

The status of the response

Example response

{
  "status": "ok",
  "results": {
    "task_id": "job-tracking-id"
  }
}