Get Audience Customers

GET 
/audiences/:id/customers

Retrieves the list of customers for a specific Audience

Use this endpoint to view all recipient's email addresses and associated profile details within a particular Audience list, enabling precise audience management.

Request

Path Parameters

id uuidrequired

ID of the Audience

Query Parameters

page integer

Page number (default is 0)

size integer

Number of items per page (default is 20)

Responses

200

successful operation

application/json

Schema

Schema

members object
content object[]
Array [
email stringrequired
firstName string
lastName string
source string
status string
Possible values: [Subscribed, Unsubscribed, Bounced, Inactive, Spam]
birthday string
tags string[]
currency string
country string
province string
city string
address1 string
address2 string
phone string
postalCode string
company string
lastPurchaseOrder string
lastPurchasePrice string
latestOrderId string
lastPurchaseDate string
unsubscribedAt string
This field will be returned if the customer is Unsubscribed. It will be in the ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).
customAttributes object
Values for the custom attributes your account has defined, keyed by the attribute name exactly as you created it — spaces and capitalisation included (Interests, not Interest_list or interests).
Send each value in the JSON type the attribute was defined with:
Attribute type	Send	Example
STRING	a string	"pro"
INTEGER	a whole number	12
DECIMAL	a number	129.95
DATE	an ISO date or date-time	"2026-09-01"
BOOLEAN	true / false	true
ARRAY	a JSON array	["cycling", "photography"]
Prefer a real JSON array for an array attribute — that is the shape the segment builder matches against. A bracketed string such as "[cycling, photography]" is also accepted, for parity with CSV import, and is stored as a proper array.
Dates must be ISO (2026-09-01, or a full ISO date-time). 09/01/2026 is rejected rather than guessed at, because it is a valid date under both MM/DD/YYYY and DD/MM/YYYY.
Sending null for an attribute removes it from the contact.
The request fails with 412 if it names an attribute your account has not defined, or if a value's type does not match the definition; the error message names every offending attribute. Nothing is stored in that case, so a 2xx means every attribute in the payload was saved.
custom_attributes is accepted as an alias on the way in. Responses always use customAttributes.
property name* any
Values for the custom attributes your account has defined, keyed by the attribute name exactly as you created it — spaces and capitalisation included (Interests, not Interest_list or interests).
Send each value in the JSON type the attribute was defined with:
| Attribute type | Send | Example | | --- | --- | --- | | STRING | a string | "pro" | | INTEGER | a whole number | 12 | | DECIMAL | a number | 129.95 | | DATE | an ISO date or date-time | "2026-09-01" | | BOOLEAN | true / false | true | | ARRAY | a JSON array | ["cycling", "photography"] |
Prefer a real JSON array for an array attribute — that is the shape the segment builder matches against. A bracketed string such as "[cycling, photography]" is also accepted, for parity with CSV import, and is stored as a proper array.
Dates must be ISO (2026-09-01, or a full ISO date-time). 09/01/2026 is rejected rather than guessed at, because it is a valid date under both MM/DD/YYYY and DD/MM/YYYY.
Sending null for an attribute removes it from the contact.
The request fails with 412 if it names an attribute your account has not defined, or if a value's type does not match the definition; the error message names every offending attribute. Nothing is stored in that case, so a 2xx means every attribute in the payload was saved.
custom_attributes is accepted as an alias on the way in. Responses always use customAttributes.
]
totalPages integer
last boolean
totalElements boolean
sort object
sorted boolean
unsorted boolean
empty boolean
first boolean
numberOfElements integer
size integer
number integer
empty boolean

Example (from schema)

{
  "members": {
    "content": [
      {
        "email": "test@tinyemail.com",
        "firstName": "John",
        "lastName": "Doe",
        "source": "sales_force",
        "status": "Subscribed",
        "birthday": "2020-01-01",
        "tags": [
          "string"
        ],
        "currency": "SOS",
        "country": "Argentina",
        "province": "Massachusetts",
        "city": "Burnsville",
        "address1": "31641 Candace Locks",
        "address2": "Apt. 452",
        "phone": "(123) 456-7890",
        "postalCode": "87774",
        "company": "Bode Inc",
        "lastPurchaseOrder": "Super Bike",
        "lastPurchasePrice": "3500",
        "latestOrderId": "Order#50993961",
        "lastPurchaseDate": "2020-01-01",
        "unsubscribedAt": "2026-02-11T13:12:29",
        "customAttributes": {
          "Interests": [
            "cycling",
            "photography"
          ],
          "Plan tier": "pro"
        }
      }
    ],
    "totalPages": 50,
    "last": false,
    "totalElements": 20,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "first": true,
    "numberOfElements": 10000,
    "size": 20,
    "number": 0,
    "empty": false
  }
}

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Some error message"
}

401

API key is missing or invalid

405

Method Not Allowed

Loading...