Subscribers

List subscribers

Permission required: subscribers:read.

updated_since returns only the records created or changed since that date.

get/api/v1/subscribers

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/subscribers
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Query parameters

limitinteger

Number of items per page, from 1 to 100.

cursorstring

The next_cursor from the previous response.

status'pending' | 'subscribed' | 'unsubscribed' | 'bounced' | 'complained'
qstring

Search on address, first name or last name.

updated_sincestring date-time

ISO 8601. Only the records created or changed since then — status, name, fields, tags. Keep the largest updated_at you receive and pass it next time, minus one minute: you catch up without reading the whole list.

Response

The requested page.

object'list'
has_moreboolean

One more page after this one.

next_cursorstring nullable

To pass back as ?cursor= for the next page. null on the last page.

Changes

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