Mailing Lists

List Recipients

Changed on

Retrieve recipients for a specific mailing list.

get/mailing-lists-utils/recipients/{mailingListId}

Request

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

Path parameters

mailingListIdinteger required
Example:56

ID of mailing list

Query parameters

limitinteger
Example:1000

Number of results to return per page.

updated_sincestring
Example:2020-04-06 01:55:50

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

Response

Successful Response

current_pageinteger

Current page number

first_page_urlstring nullable

URL of the first page of results

frominteger

Index of the first item on the current page

last_pageinteger

Total number of pages

last_page_urlstring nullable

URL of the last page of results

next_page_urlstring nullable

URL of the next page of results

pathstring

Base URL for the resource

per_pageinteger

Number of items per page

prev_page_urlstring nullable

URL of the previous page of results

tointeger

Index of the last item on the current page

totalinteger

Total number of items

Example response

{
  "data": [
    {
      "id": 18113288,
      "mailing_list_id": 1,
      "name": "Tobias Example",
      "company": "thanks.io",
      "address": "123 Main Street",
      "address2": "Apartment 1",
      "city": "Any Town",
      "province": "KS",
      "postal_code": "12345",
      "country": "US",
      "dob": "1981-04-23",
      "anniversary": "2025-07-21",
      "email": "tobias@example.com",
      "phone": "+1 (555) 123-4567",
      "custom1": "Unique Info",
      "custom2": "For example a product code or customer ID",
      "custom3": "Any Extra Info",
      "custom4": "Any Extra Info",
      "custom5": "Any Extra Info",
      "custom6": "Any Extra Info",
      "custom7": "Any Extra Info",
      "custom8": "Any Extra Info",
      "custom9": "Any Extra Info",
      "custom10": "Any Extra Info",
      "absentee_address": "742 Evergreen Terrace, Springfield, IL 62704",
      "mailing-list": {
        "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"
      },
      "created_at": "2025-06-27T14:57:11.000000Z",
      "updated_at": "2025-06-27T14:57:11.000000Z"
    }
  ],
  "current_page": 1,
  "first_page_url": "https://api.thanks.io/api/v2/mailing-lists-utils/recipients/3014?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://api.thanks.io/api/v2/mailing-lists-utils/recipients/3014?page=1",
  "path": "https://api.thanks.io/api/v2/mailing-lists-utils/recipients/3014",
  "per_page": 50,
  "to": 12,
  "total": 12
}

Changes

  • bbe02ffe74f3Revision changes
    • info

      added the optional property /// to the response with the status

  • c10cfeb34552Revision changes
    • warning

      removed the optional property /// from the response with the status