# Get a list of opt out requests

```
GET https://www.example.com/api/v2/opt_outs
```

Get a list of opt out requests

## Request

### Query Parameters

**status** string

Filters your list of opt outs by status.:  
- `not_started`  
- `in_progress`  
- `complete`  
- `canceled`  
- `incomplete`

**Example:** `not_started`

### Header Parameters

**authorization** string required

**Example:** `Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9`

## Responses

- 200
  - Opt out requests fetched
  - application/json
  - Schema
  - Example (auto)

**Schema**

**data** object[]

Array [

**created_at** string

Datetime of when the opt out was created.

**Example:** `2024-08-09T21:14:49.444Z`

**due_date** string

Date of when the opt out is due.

**Example:** `2024-12-09T21:14:49.444Z`

**data** object

**canonical_email** string

The email associated with the data subject.

**Example:** `john@example.com`

**email** string

The email associated with the data subject.

**Example:** `john@example.com`

**first_name** string

The first name of the data subject.

**Example:** `John`

**last_name** string

The last name of the data subject.

**Example:** `Smith`

**location** object

The location the data subject when they submitted the request.

oneOf
- string
- null

string

**status** string

The status of the request.

**Example:** `not_started`

**additional_info** string

returning the additional_info passed in when the Opt Out was created

**Example:** `Some additional data`

**uuid** string

The unique identifier of the request.

**Example:** `967e34da-4863-4fcf-842d-176dd102d032`

**intake_data** object

The intake data associated with the request. If submitted through an intake form, data subject specific information will be included here.

**property name*** object

oneOf
- string
- string[]

string

```json
{
  "data": [
    {
      "created_at": "2024-08-09T21:14:49.444Z",
      "due_date": "2024-12-09T21:14:49.444Z",
      "data": {
        "canonical_email": "john@example.com"
      },
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Smith",
      "location": "US",
      "status": "not_started",
      "additional_info": "Some additional data",
      "uuid": "967e34da-4863-4fcf-842d-176dd102d032",
      "intake_data": {
        "first_name": "Guinevere",
        "last_name": "Camelot",
        "reported_country_code": "CA",
        "reported_sub_region_code_1": "QB",
        "favorite_colors": [
          "Red",
          "Blue"
        ]
      }
    }
  ]
}
```

- curl
- go
- java
- nodejs
- php
- python
- ruby
- rust
- swift

- CURL

```bash
curl -L 'https://www.example.com/api/v2/opt_outs' \
-H 'Accept: application/json'
```