FlaresendDocs
Audiences

List audience contacts

Page through the contacts in one audience, newest first.

GET/v1/audiences/{id}/contactsAPI key

Returns the contacts in the audience, ordered by when the contact was created, newest first. Unsubscribed contacts are included; check each contact's unsubscribed field. The list is cursor-paginated, see Pagination.

Path parameters

idstringpathrequired

The audience ID.

Query parameters

limitnumberquerydefault: 25

How many contacts per page, from 1 to 100. Values outside that range are clamped to it.

cursorstringquery

The nextCursor value from the previous page.

Response

dataContact[]

The contacts on this page, with the fields described in Create a contact.

nextCursorstring | null

Pass this as cursor to get the next page. null on the last page.

Errors

StatusCodeWhen
404audience_not_foundNo audience with that ID in this project.