Status API › Subscribers
List subscribers
GET/api/v1/pages/{pageID}/subscribers
Every subscriber of the page, newest first, pending and confirmed. Not paged.
Permission (API-key scope): status:subscriber:read.
Authorization
bearerAuth(status:subscriber:read)apiKeyHeader(status:subscriber:read)
Parameters
Path parameters
pageIDstring (uuid) requiredThe status page's id (a UUID).
Responses
200
The subscribers.
dataarray of Subscriber requiredShow Subscriber properties
idstring (uuid)emailstring (email)statusstringOnlyconfirmedsubscribers are mailed (double opt-in).component_idsarray of stringEmpty: the whole page.product_groupsarray of stringGroups (products) followed.created_atstring (date-time)confirmed_atstring (date-time)
successboolean required
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
404
No such item, or one the caller cannot see (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
Example request
curl -X GET 'https://evohub.io/api/v1/pages/3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42/subscribers' \
-H 'Authorization: Bearer <TOKEN>'