Skip to main content
GET
/
mailing-lists-utils
/
recipients
/
{mailingListId}
List Recipients
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thanks.io/api/v2/mailing-lists-utils/recipients/{mailingListId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.thanks.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your thanks.io API key

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

Successful Response

​
data
object[]

Array of recipient objects

​
current_page
integer

Current page number

Example:

1

​
first_page_url
string | null

URL of the first page of results

Example:

"https://api.thanks.io/api/v2/mailing-lists-utils/recipients/3014?page=1"

​
from
integer

Index of the first item on the current page

Example:

1

​
last_page
integer

Total number of pages

Example:

1

​
last_page_url
string | null

URL of the last page of results

Example:

"https://api.thanks.io/api/v2/mailing-lists-utils/recipients/3014?page=1"

​
next_page_url
string | null

URL of the next page of results

​
path
string

Base URL for the resource

Example:

"https://api.thanks.io/api/v2/mailing-lists-utils/recipients/3014"

​
per_page
integer

Number of items per page

Example:

50

​
prev_page_url
string | null

URL of the previous page of results

​
to
integer

Index of the last item on the current page

Example:

12

​
total
integer

Total number of items

Example:

12