List recipients
rapidmail_list_recipientsRead-only
List the recipients (subscribers) of ONE recipient list, optionally filtered by e-mail address, external id or status. recipientlist_id is required. The long text fields (extrabig1-10) are only returned with include_extrabig. GET /recipients.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| No | Only the recipient with this e-mail address. | ||
| status | No | Only recipients in these statuses: new (awaiting confirmation), active, bounced, abused, deleted. | |
| sort_by | No | Sort field. | |
| foreign_id | No | Only the recipient with this external id. | |
| sort_order | No | Sort direction. | |
| include_extrabig | No | Also return the long text fields extrabig1-10 (default false). | |
| recipientlist_id | Yes | rapidmail recipient list id (see rapidmail_list_recipientlists). |