Skip to content

Mail

mail_contact_list

List contacts in an audience

Tool

mail_contact_list

List contacts in an audience

List contacts in an audience

Behavior

HTTP
GET /mail/audiences/:audienceId/contacts

Arguments

NameTypeRequiredDescription
limitintegerMax items per page (1–100, default 50)
cursorstringOpaque pagination cursor from a prior page
audience_idstringAudience to list contacts from
unsubscribedstringFilter by unsubscribed flag

Response

FieldTypeAlwaysDescription
dataarray
nextCursorstring

Try it

List contacts in an audience.

When to use

List contacts in an audience

Example

Ask your agent something like this:

List contacts in an audience.

The agent will invoke mail_contact_list with these arguments:

{
  "audience_id": "<audience_id>"
}

Esc

Start typing to search the docs.

navigateselect