Status Page Subscriber
Get Status Page Subscriber
Endpoint to retrieve a single Status Page Subscriber by ID
post/status-page-subscriber/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Status Page Subscriber to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"subscriberEmail": true,
"slackWorkspaceName": true,
"language": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"statusPageId": "123e4567-e89b-12d3-a456-426614174000",
"subscriberEmail": {
"_type": "Email",
"value": "user@example.com"
},
"subscriberPhone": {
"_type": "Phone",
"value": "+1-555-123-4567"
},
"subscriberWebhook": "https://short.url/abc123",
"slackWorkspaceName": "Example short text",
"microsoftTeamsWorkspaceName": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"language": "de",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"isSubscriptionConfirmed": true,
"isUnsubscribed": true,
"unsubscribedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"isAddedByTeam": true,
"sendYouHaveSubscribedMessage": true,
"isSubscribedToAllResources": true,
"isSubscribedToAllEventTypes": true,
"statusPageResources": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"statusPageEventTypes": {
"key": "value",
"nested": {
"data": 123
}
},
"internalNote": "# Heading\n\nThis is **markdown** content"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.