List customers due for erasure

GET

/retention/due

const url = 'https://example.com/retention/due?withinDays=30';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/retention/due?withinDays=30' \
  --cookie bottle.session_token=<bottle.session_token>

Everything due to be erased within the given number of days, soonest first, so nothing disappears unannounced. Anything on legal hold is listed and marked rather than hidden.

Authorizations

sessionCookie
privacy:read
apiKey
privacy:read

Parameters

Query Parameters

withinDays

integer | null

default: 30 <= 3650

Responses

200

Due

application/json

object

items

required

Array<object>

object

required

UUID v7

string format: uuid

tradingName

required

string

lastOrderAt

required

string | null format: date-time

dueOn

required

string format: date

legalHold

required

boolean

Example

{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}