Audiences

List subscribers

get/audiences/{id}/subscribers

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/audiences/{id}/subscribers
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

status'subscribed' | 'pending' | 'unsubscribed' | 'bounced' | 'complained' | 'suppressed' | 'transactional_only' | 'dormant'

Filter by subscriber status.

emailstring email

Filter to an exact email address.

cursorstring

Opaque pagination cursor returned by the same list operation. Send it unchanged; do not parse, modify, or fabricate it.

limitinteger

Number of items to return (1-100, default 25).

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Paginated list of subscribers.

Changes

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