GET/v1/status_pages/{status_page_id}/subscribers

List all subscribers

Requires STATUS_PAGES:READ; EDIT also grants READ. Session cookies are accepted only when no bearer credential is supplied.

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID

Query parameters

page:integeroptional
Page number of paginated results, starting at 1.
Default: 1
per_page:integeroptional
Number of items per page. Defaults to 20. Continue requesting subsequent pages until the accumulated item count reaches result_info.total_count or a page is empty.
Default: 20
search:stringoptional
Search term to filter results.

Responses

StatusMeaningDescription
200OKReturns a list of subscribers for a status page
400Bad RequestInvalid request
401UnauthorizedUnauthenticated
403ForbiddenUnauthorized - status page not in user's organisation
404Not FoundResource not found, unavailable, or rejected by the domain operation
500Internal Server ErrorInternal Server Error

Response Schema

result:object[]
result_info:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

GET
/v1/status_pages/{status_page_id}/subscribers
curl --request GET \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/subscribers \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'X-OnlineOrNot-Organisation: string'

Response

{
  "result": [
    {
      "id": "a1b2c3d4e5f6",
      "email_address": "user@example.com",
      "confirmed": false,
      "component_subscription_mode": "ALL_COMPONENTS",
      "component_ids": ["a1b2c3d4"],
      "created_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  },
  "success": true,
  "errors": [],
  "messages": []
}
POST/v1/status_pages/{status_page_id}/subscribers

Create a subscriber

Requires STATUS_PAGES:EDIT; EDIT also grants READ. Session cookies are accepted only when no bearer credential is supplied.

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID

Body parameters

email_address:string(email)
Email address of the subscriber
component_subscription_mode:stringoptional
Component alert preference mode for this subscriber
Accepted values: "ALL_COMPONENTS" | "SELECTED_COMPONENTS"
Default: "ALL_COMPONENTS"
component_ids:string[]optional
Selected component IDs when component_subscription_mode is SELECTED_COMPONENTS
Default: []

Responses

StatusMeaningDescription
201CreatedReturns the newly created subscriber
400Bad RequestInvalid email address
401UnauthorizedUnauthenticated
403ForbiddenUnauthorized - status page not in user's organisation
409ConflictEmail already subscribed or has pending invitation
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

POST
/v1/status_pages/{status_page_id}/subscribers
curl --request POST \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/subscribers \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'Content-Type: application/json' \
  --header 'X-OnlineOrNot-Organisation: string' \
  --data '{"email_address":"user@example.com","component_subscription_mode":"ALL_COMPONENTS","component_ids":["a1b2c3d4"]}'

Response

{
  "result": {
    "id": "a1b2c3d4e5f6",
    "email_address": "user@example.com",
    "confirmed": false,
    "component_subscription_mode": "ALL_COMPONENTS",
    "component_ids": ["a1b2c3d4"],
    "created_at": "2021-01-01T00:00:00.000Z"
  },
  "success": true,
  "errors": [],
  "messages": []
}
DELETE/v1/status_pages/{status_page_id}/subscribers/{subscriber_id}

Delete a subscriber

Requires STATUS_PAGES:EDIT; EDIT also grants READ. Session cookies are accepted only when no bearer credential is supplied.

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Header parameters

X-OnlineOrNot-Organisation:stringoptional
Public organization ID to select from an OAuth grant. Required for grants authorizing multiple organizations. Omit for single-organization grants and API tokens.

Path parameters

status_page_id:string
Status Page ID
subscriber_id:string
Status Page Subscriber ID

Responses

StatusMeaningDescription
200OKReturns the deleted subscriber's ID
400Bad RequestInvalid request
401UnauthorizedUnauthenticated
403ForbiddenUnauthorized
404Not FoundSubscriber not found
500Internal Server ErrorInternal Server Error

Response Schema

result:object
success:boolean
Whether the API call was successful
errors:object[]
messages:object[]

Request

DELETE
/v1/status_pages/{status_page_id}/subscribers/{subscriber_id}
curl --request DELETE \
  --url https://api.onlineornot.com/v1/status_pages/a1b2c3d4/subscribers/a1b2c3d4e5f6 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}' \
  --header 'X-OnlineOrNot-Organisation: string'

Response

{
  "result": {
    "id": "a1b2c3d4e5f6"
  },
  "success": true,
  "errors": [],
  "messages": []
}

Was this page helpful?