GET
/
mailing-lists-utils
/
recipients
/
{mailingListId}
List Recipients
const url = 'https://api.thanks.io/api/v2/mailing-lists-utils/recipients/{mailingListId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "current_page": 1,
  "data": [
    {
      "id": 293345,
      "mailing_list_id": 514,
      "session_id": null,
      "name": "John Doe",
      "address": "123 Main Street",
      "address2": null,
      "city": "Austin",
      "province": "TX",
      "postal_code": "78703",
      "country": "US",
      "dob": null,
      "custom1": null,
      "custom2": null,
      "deliverability": null,
      "can_deliver": true,
      "created_at": "2020-03-10 13:33:04",
      "updated_at": "2020-04-06 01:57:50"
    }
  ],
  "first_page_url": "http://api.thanks.io/api/v2/mailing-lists/514/recipients?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://api.thanks.io/api/v2/mailing-lists/514/recipients?page=1",
  "next_page_url": null,
  "path": "http://api.thanks.io/api/v2/mailing-lists/514/recipients",
  "per_page": "1000",
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

mailingListId
integer
required

ID of mailing list

Example:

56

Query Parameters

limit
integer

Number of results to return per page.

Required range: 1 <= x <= 10000
Example:

1000

updated_since
string

Return only recipients updated since this date/time. Format: YYYY-MM-DD HH:MM:SS

Example:

"2020-04-06 01:55:50"

Response

200
application/json

Successful Response

The response is of type object.