Get a list of opt out requests

GET 
/api/v2/opt_outs

Get a list of opt out requests

Request

Query Parameters

opt_out string
Filters your list of opt outs by status.
Example: not_started

Header Parameters

authorization stringrequired
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9

Responses

200

Opt out requests fetched

application/json

Schema

Schema

created_at string

Datetime of when the opt out was created.

email string

The email associated with the data subject.

first_name string

The first name of the data subject.

last_name string

The last name of the data subject.

location string

The location the data subject when they submitted the request.

status string

The status of the request.

uuid string

The unique identifier of the request.

Example (from schema)

{
  "created_at": "2024-08-09T21:14:49.444Z",
  "email": "john@example.com",
  "first_name": "John",
  "last_name": "Smith",
  "location": "US",
  "status": "not_started",
  "uuid": "967e34da-4863-4fcf-842d-176dd102d032"
}

Loading...