List Subscribers
shipmail_list_subscribersRetrieve all subscribers from a newsletter audience. Filter results by status or exact email address.
Instructions
List subscribers in a newsletter audience. Filter by status or an exact email address.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Filter to an exact email address. | ||
| limit | No | Maximum results to return. | |
| cursor | No | Pagination cursor returned by the previous call. | |
| status | No | Filter by subscriber status. | |
| audience_id | Yes | Audience ID. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| pagination | Yes |