Skip to content
Site Qwality Site Qwality Site Qwality Docs

List a status page's subscribers.

GET
/v1/status-pages/{status_page_id}/subscribers
 
curl --request GET \
  --url https://api.siteqwality.com/v1/status-pages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscribers \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
status_page_id
required
string format: uuid

Query Parameters

Section titled “Query Parameters ”
state
string

confirmed, pending, queued, expired or quarantined. Leave out for every state.

q
string

Part of an address, ignoring case.

cursor
string

next_cursor from the previous page.

limit
integer format: int64

1 to 200, default 50.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Subscribers, newest first

Media type application/json

{"data": [...], "next_cursor": ...}; the /v1 shaping keeps it as is.

object
data
required
Array<object>

Someone who asked for email about a status page.

object
id
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:

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:

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

string
Allowed values: bounce complaint
next_cursor

Send back as cursor for the next page; null on the last one.

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

400

Section titled “400 ”

Invalid state, q, limit or cursor

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

401

Section titled “401 ”

Missing or invalid credentials

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

403

Section titled “403 ”

The key or member may not do this, or lacks the scope it needs

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

404

Section titled “404 ”

No such status page in this account

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

429

Section titled “429 ”

Too many requests; wait for the time in Retry-After

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

Privacy Cookie preferences