SPspectate
Status page subscribers

List subscribers

Returns the page's subscribers, newest first.

get/status-pages/{statusPage}/subscribers

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

statusPagestring uuid required

Status page ID.

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Subscribers per page, 1 to 100.

filter[confirmed]boolean

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

filter[search]string

Case-insensitive text in the email address.

Response

Paginated set of StatusPageSubscriber

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "email": "jane@example.com"
    }
  ]
}

Changes

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