Get a data request by its confirmation token

const options = {method: 'GET', headers: {'x-spree-api-key': '<api-key>'}};

fetch('http://{defaultHost}/api/v3/store/data_requests/{token}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "dsr_UkLWZg9DAJ",
  "number": "DSR1001",
  "kind": "access",
  "status": "pending",
  "requested_at": "2026-01-15T12:00:00Z",
  "completed_at": null,
  "expires_at": null,
  "download_url": null
}

{
  "error": {
    "code": "invalid_token",
    "message": "This confirmation link has expired or is no longer valid"
  }
}

Get a data request by its confirmation token

Returns the data request the emailed confirmation token belongs to, with a download link once the export is ready. Needs no signed-in session, because the link may be opened on a device that was never signed in.

The token stays readable after the 24-hour confirmation window, and the response carries the request’s saved status. A request that is awaiting_confirmation can be confirmed only within that window: a later confirmation attempt returns 422 and marks the request lapsed. 404 means the token is unknown, or was voided when the customer’s data was erased.

GET

api

store

data_requests

{token}

Get a data request by its confirmation token

const options = {method: 'GET', headers: {'x-spree-api-key': '<api-key>'}};

fetch('http://{defaultHost}/api/v3/store/data_requests/{token}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "dsr_UkLWZg9DAJ",
  "number": "DSR1001",
  "kind": "access",
  "status": "pending",
  "requested_at": "2026-01-15T12:00:00Z",
  "completed_at": null,
  "expires_at": null,
  "download_url": null
}

{
  "error": {
    "code": "invalid_token",
    "message": "This confirmation link has expired or is no longer valid"
  }
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Path Parameters

token

string

required

Response

data request found

string

required

number

string

required

kind

enum<string>

required

Available options:

access,

erasure

status

required

The values listed are the built-in ones; extensions may add more.

Available options:

awaiting_confirmation,

pending,

processing,

completed,

failed,

lapsed

requested_at

string | null

required

completed_at

string | null

required

expires_at

string | null

required

download_url

string | null

required

⌘I

API basics

Endpoints

Get a data request by its confirmation token

Authorizations

Headers

Path Parameters

Response