Skip to content
bynhDocs
Log in

List subscribers

GET/workspaces/{workspace}/status/subscribers

Returns people who get your status page emails, newest first, 50 per page, with counts.

Authentication

Send an API token as a bearer token. This endpoint needs a read token, made by any member of the workspace. Create one in My account → API tokens; see scopes and roles.

Authorization: Bearer 42|bynh_pat_•••••••Header

Path parameters

  • workspacestringRequired

    Your workspace slug, e.g. dokan.

Query parameters

  • qstring

    Searches email and company (max 100).

  • filterenumdefault all

    Confirmation state. One of all, confirmed, unconfirmed.

  • pageintegerdefault 1

    Page number (min 1).

Response

200 OK

50 per page; meta {total, page, last_page, counts {all, confirmed, unconfirmed, maintenance_only}, notified_last_30d}. No links.

  • idintegerSubscriber id.
  • emailstringLower-cased.
  • companystring|nullCompany.
  • channelenumAlways email. One of email.
  • scopeenumWhat they follow. One of all, components, maintenance.
  • followsstringLocalized description of scope (component names for components).
  • sourcestringHow they joined, manual (added in the app or API), import (CSV), form (the public status page).
  • confirmedbooleanClicked the confirmation link.
  • confirmed_atstring|nullISO 8601.
  • confirmation_sent_atstring|nullISO 8601.
  • last_notified_atstring|nullISO 8601.
  • created_atstringISO 8601.

Rate limits

This endpoint counts toward your general limit of 120 requests a minute. When you go over, wait for the number of seconds in Retry-After.

Errors

401The token is missing, wrong, revoked or expired.
404The token belongs to another workspace, or its owner is no longer a member.
422Bad filter, q or page.

Every error is JSON with a message. See Errors.

Next →Invite a subscriber
curl "https://api.bynh.io/api/v1/workspaces/dokan/status/subscribers?filter=confirmed&page=1" \
  -H "Authorization: Bearer $BYNH_TOKEN" \
  -H "Accept: application/json"

Response200 OK

application/json
{
  "data": [
    {
      "id": 301,
      "email": "ops@almarai-retail.sa",
      "company": "Almarai Retail",
      "channel": "email",
      "scope": "all",
      "follows": "All components",
      "source": "form",
      "confirmed": true,
      "confirmed_at": "2026-09-02T12:00:00+00:00",
      "confirmation_sent_at": "2026-10-01T08:10:00+00:00",
      "last_notified_at": "2026-09-14T18:05:00+00:00",
      "created_at": "2026-10-01T08:10:00+00:00"
    }
  ],
  "meta": {
    "total": 251,
    "page": 1,
    "last_page": 6,
    "counts": {
      "all": 251,
      "confirmed": 243,
      "unconfirmed": 8,
      "maintenance_only": 12
    },
    "notified_last_30d": 240
  }
}

Examples use Dokan, a sample workspace. Responses are shortened where lists are long.