List an audience's contacts
GET
/v1/audiences/{audience_id}/contacts
curl -X GET "https://us1.platform.bird.com/v1/audiences/{audience_id}/contacts" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"Lists the contacts in a static audience as a cursor page, ordered by the time each contact joined the audience, most recent first. Each entry is the contact together with the time it joined.
Parameters
audience_id
string
Audience ID.
Queryparameters
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Response Payload
data
array of object
verplicht
Page of audience members, each a contact paired with the time it joined the audience.
Onderliggende attributen tonen
data.contact
object
verplicht
Onderliggende attributen tonen
data.contact.id
string
verplicht
Contact ID.
data.contact.email
string
verplicht
The contact's email address, stored trimmed and lowercased. Unique within the workspace.
data.contact.first_name
nullable string
The contact's first name.
data.contact.last_name
nullable string
The contact's last name.
data.contact.external_id
nullable string
Your own identifier for this contact, such as a user ID in your system. Unique within the workspace when set.
data.contact.data
object
Custom property values for this contact, available as template variables in broadcasts. Each key is a property created via the contact properties API, and each value is a string, number, or boolean matching the property's declared type (strings up to 500 characters). Total size is capped at 2 KB serialized.
data.contact.created_at
string
verplicht
data.contact.updated_at
string
verplicht
data.joined_at
string
verplicht
When this contact joined the audience. Members are listed in join order, most recent first.
next_cursor
nullable string
verplicht
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
verplicht
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
verplicht
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.