Status Page Members
The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
Used as a cursor for pagination.
Used as a cursor for pagination.
Set the number of subscriptions to return in the response. This defaults to 20 items, and can be a maximum of 100.
Filter the members by email.
The list of members
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
GET /api/v2/status_pages/{subdomain}/members HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"members": [
{
"id": 5,
"email": "jane@doe.com",
"role": "v",
"enabled": true,
"user": {
"id": 1,
"last_sign_in_at": "2022-01-01T00:00:00",
"current_sign_in_at": "2022-01-01T00:00:00"
},
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00"
}
],
"links": {
"next": "{STATUSPAL_HOST}/api/v2/status_pages/subdomain/members?after=cUrSoR",
"prev": "text"
},
"meta": {
"total_count": 100
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The membership was created
Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
There was a validation error
Unexpected error.
POST /api/v2/status_pages/{subdomain}/members HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"member": {
"email": "jane@doe.com",
"role": "v",
"enabled": true,
"lang": "en"
}
}{
"member": {
"id": 5,
"email": "jane@doe.com",
"role": "v",
"enabled": true,
"user": {
"id": 1,
"last_sign_in_at": "2022-01-01T00:00:00",
"current_sign_in_at": "2022-01-01T00:00:00"
},
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00"
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of a membership
The membership was updated
Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
There was a validation error
Unexpected error.
PUT /api/v2/status_pages/{subdomain}/members/{memberId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"member": {
"role": "v",
"enabled": true
}
}{
"member": {
"id": 5,
"email": "jane@doe.com",
"role": "v",
"enabled": true,
"user": {
"id": 1,
"last_sign_in_at": "2022-01-01T00:00:00",
"current_sign_in_at": "2022-01-01T00:00:00"
},
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00"
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of a membership
Member deleted successfully
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
DELETE /api/v2/status_pages/{subdomain}/members/{memberId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated