List the people subscribed to a status page, newest first.

GET

/status_page/{status_page_id}/subscriber

const url = 'https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscriber';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscriber \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

status_page_id

required

string format: uuid

Status page identifier

Query Parameters

state

string

Confirmed, pending, queued, expired or quarantined. Omit for all

string

Part of an email address, ignoring case

limit

integer format: int64

Page size. Defaults to 50, clamped to 1..=200

offset

integer format: int64

Row offset into the filtered list

Responses

200

One page of subscribers in data, total for the filter, counts for the whole list and the page’s capacity

application/json

One page of subscribers. data stays the bare array like every other list; the rest rides beside it.

object

data

required

Array<object>

Someone who asked for email about a status page.

object

required

string

email

required

string

state

required

confirmed receives notices. pending has not clicked the link yet. queued was imported and waits for its confirmation email. expired never clicked, and the link lapsed. quarantined bounced or complained and gets nothing.

string

Allowed values: confirmed pending queued expired quarantined

subscribed_at

required

When the address was first submitted.

string format: date-time

confirmed_at

string | null format: date-time

component_ids

Components (monitor ids) whose notices it gets. Empty means every component.

Array<string>

kinds

Kinds of update it gets. Empty means both.

Array<string>

Allowed values: incident maintenance

consent_source

One of:

string
null

How the address was added. Absent on subscribers from before it was recorded.

string

Allowed values: public_form owner_add import

consent_version

The version of the confirm page wording it agreed to, set when it confirms.

string | null

quarantined_at

string | null format: date-time

quarantine_reason

One of:

string
null

Why an address gets nothing. A complaint is never lifted automatically.

string

Allowed values: bounce complaint

total

required

Subscribers matching the filters, not the length of data.

integer format: int64

counts

required

The whole list by state, whatever the filters.

object

confirmed

required

integer format: int64

pending

required

integer format: int64

queued

required

Imported addresses waiting for their confirmation email.

integer format: int64

expired

required

integer format: int64

quarantined

required

Bounced or complained. They get no mail and hold no place.

integer format: int64

capacity

required

The most subscribers a page can hold (confirmed, pending and queued together).

integer format: int64

Example

{
  "data": [
    {
      "state": "confirmed",
      "kinds": [
        "incident"
      ],
      "consent_source": "public_form",
      "quarantine_reason": "bounce"
    }
  ]
}

400

Invalid filter

401

Missing or invalid authentication

404

Status page not found

500

Internal server error