Subscribers

List subscribers

Returns subscribers in the authenticated workspace, sorted from newest to oldest.

get/v1/subscribers

Request

  • Base URL: https://api.mailrith.com
  • URL: https://api.mailrith.com/v1/subscribers
  • Auth: HTTP bearer

Query parameters

searchstring

Filter subscribers by name, email, or status.

emailstring email

Filter subscribers by an exact subscriber email address.

status'Active' | 'Unconfirmed' | 'Unsubscribed' | 'Complained' | 'Bounced' | 'Blocked'

Filter subscribers by subscriber status.

cold_onlyboolean

When true, return only cold subscribers.

tag_idstring

Return subscribers that currently have this tag ID. Repeat tag_id or use tag_ids to match any of several tags.

tag_idsstring

Comma-separated tag IDs. By default, the API returns subscribers who have any listed tag.

tag_operator'has_any_of' | 'has_none_of'

Controls how tag filters are applied. Defaults to has_any_of.

sequence_idstring

Return subscribers that match this sequence ID. Repeat sequence_id or use sequence_ids to match any of several sequences.

sequence_idsstring

Comma-separated sequence IDs. By default, the API returns only subscribers who are active in any listed sequence.

sequence_operator'is_active_in_any_of' | 'is_not_active_in_any_of' | 'has_completed_any_of' | 'has_not_completed_any_of' | 'has_ever_been_in_any_of' | 'has_never_been_in_any_of'

Controls how sequence filters are applied. Defaults to is_active_in_any_of.

limitinteger

Maximum number of subscribers to return. Defaults to 25 and is capped at 100.

starting_afterstring

Use the opaque cursor from the previous page to request the next page.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.