Skip to main content
GET
/
mailing-lists
/
{mailingListId}
Get Details
const url = 'https://api.thanks.io/api/v2/mailing-lists/{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);
}
{
  "id": 3020,
  "user_id": 2,
  "sub_account_id": null,
  "type": "manual",
  "description": "Birthday List",
  "qrcode_url": null,
  "total_recipients": 0,
  "processed": true,
  "is_suppression_list": false,
  "total_scans": 0,
  "unique_scans": 0,
  "last_scan": null,
  "total_sends": 0,
  "last_send": null,
  "api_key": "167ba7f0-72de-11f0-b054-6d9179a1fdb2",
  "created_at": "2025-08-06T15:57:43.000000Z",
  "created_at_diff": "18 minutes ago",
  "updated_at": "2025-08-06T15:57:43.000000Z"
}

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

Response

Successful Response

id
integer
Example:

1

user_id
integer
Example:

2

sub_account_id
integer | null
type
enum<string>
Available options:
csv,
manual,
map,
friends,
retarget,
leads,
zapier,
radius,
highlevel,
qrscans
Example:

"manual"

description
string
Example:

"Test"

qrcode_url
string | null
total_recipients
integer
Example:

1

processed
boolean
Example:

true

is_suppression_list
boolean
Example:

false

total_scans
integer
Example:

0

unique_scans
integer
Example:

0

last_scan
string | null
total_sends
integer
Example:

0

last_send
string | null
api_key
string

API key that can be used to add recipients to this mailing list with thanks.io Webhooks

Example:

"abcd1234efgh5678ijkl9012mnop3456"

created_at
string<date-time>
Example:

"2018-07-15T06:06:57.000000Z"

created_at_diff
string

Human friendly time since created

Example:

"6 years ago"

updated_at
string<date-time>
Example:

"2025-06-27T14:57:11.000000Z"