Mailing Lists

Get Details

Gets a mailing list by ID. Returns a single mailing list object.

get/mailing-lists/{mailingListId}

Request

  • Base URL: https://api.thanks.io/api/v2
  • URL: https://api.thanks.io/api/v2/mailing-lists/{mailingListId}
  • Auth: HTTP bearer

Response

Successful Response

idinteger
user_idinteger
sub_account_idinteger nullable
type'csv' | 'manual' | 'map' | 'friends' | 'retarget' | 'leads' | 'zapier' | 'radius' | 'highlevel' | 'qrscans'
descriptionstring
qrcode_urlstring nullable
total_recipientsinteger
processedboolean
is_suppression_listboolean
total_scansinteger
unique_scansinteger
last_scanstring nullable
total_sendsinteger
last_sendstring nullable
api_keystring

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

created_atstring date-time
created_at_diffstring

Human-friendly relative time since creation

updated_atstring date-time

Example response

{
  "id": 1,
  "user_id": 2,
  "type": "manual",
  "description": "Test",
  "total_recipients": 1,
  "processed": true,
  "api_key": "abcd1234efgh5678ijkl9012mnop3456",
  "created_at": "2018-07-15T06:06:57.000000Z",
  "created_at_diff": "6 years ago",
  "updated_at": "2025-06-27T14:57:11.000000Z"
}

Changes

No recorded changes to this operation across all 51 revisions of this API.