Status page subscribers

Download schema

People who subscribed to a status page's updates by email, from the page itself. A subscription is confirmed by double opt-in; only confirmed subscribers are emailed. Subscribers can't be added through the API.

List subscribers

GET

https://api.spectate.net/v1

/status-pages/{statusPage}/subscribers

Returns the page's subscribers, newest first.

List subscribers › path Parameters

statusPage

string · uuid · required

Status page ID.

List subscribers › query Parameters

page

integer

Page number, from 1.

Default: 1

per_page

integer

Subscribers per page, 1 to 100.

Default: 25

filter[confirmed]

boolean

true for confirmed subscribers only, false for those awaiting confirmation.

filter[search]

string

Case-insensitive text in the email address.

List subscribers › Responses

Paginated set of StatusPageSubscriber

current_page

integer · min: 1 · required

StatusPageSubscriber[] · required

first_page_url

string | null · required

from

integer | null · min: 1 · required

last_page_url

string | null · required

last_page

integer · min: 1 · required

object[] · required

Generated paginator links.

next_page_url

string | null · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

prev_page_url

string | null · required

to

integer | null · min: 1 · required

Number of the last item in the slice.

total

integer · min: 0 · required

Total number of items being paginated.

GET/status-pages/{statusPage}/subscribers

curl https://api.spectate.net/v1/status-pages/:statusPage/subscribers \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "current_page": 1,
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "jane@example.com",
      "confirmed_at": "2024-08-25T15:00:00Z",
      "language": "en",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "first_page_url": "first_page_url",
  "from": 1,
  "last_page_url": "last_page_url",
  "last_page": 1,
  "links": [
    {
      "url": "url",
      "label": "label",
      "active": true
    }
  ],
  "next_page_url": "next_page_url",
  "path": "path",
  "per_page": 0,
  "prev_page_url": "prev_page_url",
  "to": 1,
  "total": 0
}

json

application/json

Remove a subscriber

DELETE

https://api.spectate.net/v1

/status-pages/{statusPage}/subscribers/{subscriber}

They get no more emails from the page and aren't told. They can subscribe again on the page.

Remove a subscriber › path Parameters

statusPage

string · uuid · required

Status page ID.

subscriber

string · uuid · required

Subscriber ID.

Remove a subscriber › Responses

No content

No data returned

Status page incidents Status page issue reports