### Create Components for Page Access User (POST) - cURL Example

Source: https://developer.statuspage.io/index

Example of creating components for a page access user via cURL. Demonstrates the POST request with the necessary headers and JSON payload.

```bash
curl -X POST https://api.statuspage.io/v1/pages/{page_id}/page_access_users/{page_access_user_id}/components \
-H "Authorization: OAuth <api_token>" \
-H "Content-Type: application/json" \
-d '{
  "component_ids": ["string"]
}'
```

--------------------------------

### Add Components to Page Access User (PATCH) - cURL Example

Source: https://developer.statuspage.io/index

Example of how to add components to a page access user using cURL. This demonstrates the HTTP method, endpoint, and payload structure.

```bash
curl -X PATCH https://api.statuspage.io/v1/pages/{page_id}/page_access_users/{page_access_user_id}/components \
-H "Authorization: OAuth <api_token>" \
-H "Content-Type: application/json" \
-d '{
  "component_ids": ["string"]
}'
```

--------------------------------

### Statuspage Page Access User Response Example

Source: https://developer.statuspage.io/index

An example of the JSON response received after successfully adding a page access user. It includes the user's ID, associated page ID, email, creation timestamp, and other relevant details.

```json
{
  "id": "q9jz6tkg4yhl",
  "page_id": "string",
  "email": "user@example.com",
  "external_login": "string",
  "page_access_group_id": "string",
  "page_access_group_ids": [ ],
  "created_at": "2025-09-02T12:35:58Z",
  "updated_at": "2025-09-02T12:35:58Z"
}
```

--------------------------------

### Statuspage Page Object Example

Source: https://developer.statuspage.io/index

Example JSON structure representing a Statuspage object. This includes a comprehensive set of attributes detailing the page's configuration, branding, subscription settings, and appearance customization options.

```json
{
  "id": "v5dsxt49fx47",
  "created_at": "2025-09-02T12:35:58Z",
  "updated_at": "2025-09-02T12:35:58Z",
  "name": "My Company Status",
  "page_description": "string",
  "headline": "string",
  "branding": "string",
  "subdomain": "your-subdomain.statuspage.io",
  "domain": "status.mycompany.com",
  "url": "https://www.mycompany.com",
  "support_url": "string",
  "hidden_from_search": true,
  "allow_page_subscribers": true,
  "allow_incident_subscribers": true,
  "allow_email_subscribers": true,
  "allow_sms_subscribers": true,
  "allow_rss_atom_feeds": true,
  "allow_webhook_subscribers": true,
  "notifications_from_email": "no-reply@status.mycompany.com",
  "notifications_email_footer": "string",
  "activity_score": 0,
  "twitter_username": "string",
  "viewers_must_be_team_members": true,
  "ip_restrictions": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "time_zone": "UTC",
  "css_body_background_color": "string",
  "css_font_color": "string",
  "css_light_font_color": "string",
  "css_greens": "string",
  "css_yellows": "string",
  "css_oranges": "string",
  "css_blues": "string",
  "css_reds": "string",
  "css_border_color": "string",
  "css_graph_color": "string",
  "css_link_color": "string",
  "css_no_data": "string",
  "favicon_logo": "string",
  "transactional_logo": "string",
  "hero_cover": "string",
  "email_logo": "string",
  "twitter_logo": "string"
}
```

--------------------------------

### Components: Get List

Source: https://developer.statuspage.io/index

Retrieves a list of all components. This provides an overview of all system components being monitored.

```REST
GET /components
```

--------------------------------

### Replace Components for Page Access User (PUT) - cURL Example

Source: https://developer.statuspage.io/index

Example of how to replace components for a page access user using cURL. This shows the PUT request to the API endpoint with the updated component list.

```bash
curl -X PUT https://api.statuspage.io/v1/pages/{page_id}/page_access_users/{page_access_user_id}/components \
-H "Authorization: OAuth <api_token>" \
-H "Content-Type: application/json" \
-d '{
  "component_ids": ["string"]
}'
```

--------------------------------

### Get Component Groups - JSON Response

Source: https://developer.statuspage.io/index

Example JSON response for retrieving component groups, showing details like ID, name, components, and timestamps.

```json
[
  {
    "id": "r5q41j8lqvyn",
    "page_id": "string",
    "name": "API Components",
    "description": "string",
    "components": [
      "abc123",
      "abc124"
],
    "position": "string",
    "created_at": "2025-09-02T12:35:59Z",
    "updated_at": "2025-09-02T12:35:59Z"
}

]
```

--------------------------------

### Get Subscriber Count Response Sample

Source: https://developer.statuspage.io/index

Example JSON response for the subscriber count endpoint, showing the number of subscribers for each type.

```json
{
  "email": 0,
  "sms": 0,
  "webhook": 0,
  "integration_partner": 0,
  "slack": 0,
  "teams": 0

}
```

--------------------------------

### Get Subscriber Histogram Response Sample

Source: https://developer.statuspage.io/index

Example JSON response for the subscriber histogram endpoint, detailing counts for various subscriber types and states.

```json
{
  "email": {
    "active": 0,
    "unconfirmed": 0,
    "quarantined": 0,
    "total": 0
  },
  "sms": {
    "active": 0,
    "unconfirmed": 0,
    "quarantined": 0,
    "total": 0
  },
  "webhook": {
    "active": 0,
    "unconfirmed": 0,
    "quarantined": 0,
    "total": 0
  },
  "integration_partner": {
    "active": 0,
    "unconfirmed": 0,
    "quarantined": 0,
    "total": 0
  },
  "slack": {
    "active": 0,
    "unconfirmed": 0,
    "quarantined": 0,
    "total": 0
  },
  "teams": {
    "active": 0,
    "unconfirmed": 0,
    "quarantined": 0,
    "total": 0
  }

}
```

--------------------------------

### Statuspage API: Get Uptime Data for Component Group

Source: https://developer.statuspage.io/index

Retrieves uptime data for a component group, provided at least one component has uptime showcase enabled. This endpoint requires page_id and id as path parameters, and supports optional query parameters like skip_related_events, start, and end dates.

```http
get /pages/{page_id}/component-groups/{id}/uptime
```

--------------------------------

### Get a List of Statuspage Components

Source: https://developer.statuspage.io/index

This snippet demonstrates how to retrieve a list of components associated with a specific Statuspage. It outlines the GET request to the components endpoint, including the page_id path parameter and optional query parameters for pagination (page, per_page).

```Bash
curl https://api.statuspage.io/v1/pages/{page_id}/components \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get Subscribers List Request Sample (Curl)

Source: https://developer.statuspage.io/index

Demonstrates how to fetch a list of subscribers using a cURL command. It includes the API endpoint and authorization header.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/subscribers \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Templates: Get List

Source: https://developer.statuspage.io/index

Retrieves a list of all available notification templates. This allows you to see the available templates for use.

```REST
GET /templates
```

--------------------------------

### Get a List of Metric Providers

Source: https://developer.statuspage.io/index

Fetches a list of all metric providers configured for a specific page. Authentication with an API key is required.

```Shell
curl https://api.statuspage.io/v1/pages/{page_id}/metrics_providers \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Pages: Get List of Pages

Source: https://developer.statuspage.io/index

Retrieves a list of all pages within the system. This endpoint provides an overview of available pages.

```REST
GET /pages
```

--------------------------------

### Get Incidents List (Curl)

Source: https://developer.statuspage.io/index

This snippet demonstrates how to fetch a list of incidents for a given page ID using cURL. It requires an API key for authorization and specifies the HTTP GET method.

```bash
curl https://api.statuspage.io/v1/pages/{page_id}/incidents \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Authentication: API Key in Header

Source: https://developer.statuspage.io/index

Example of authenticating with the Statuspage API using an API key passed in the Authorization header. This is required to fetch page profile information.

```bash
curl -H "Authorization: OAuth 89a229ce1a8dbcf9ff30430fbe35eb4c0426574bca932061892cefd2138aa4b1" \
  https://api.statuspage.io/v1/pages/gytm4qzbx9t6.json
```

--------------------------------

### Create Metric Payload - JSON

Source: https://developer.statuspage.io/index

Example JSON payload for creating a metric for a metrics provider. Includes fields like name, metric_identifier, transform, and display properties.

```JSON
{
  "metric": {
    "name": "string",
    "metric_identifier": "string",
    "transform": "string",
    "application_id": "string",
    "suffix": "string",
    "y_axis_min": 0,
    "y_axis_max": 0,
    "y_axis_hidden": true,
    "display": true,
    "decimal_places": 0,
    "tooltip_description": "string"
  }
}
```

--------------------------------

### Get Metrics for Page Access User (GET)

Source: https://developer.statuspage.io/index

Retrieves the metrics associated with a specific page access user. Supports pagination using 'page' and 'per_page' query parameters.

```bash
curl -X GET https://api.statuspage.io/v1/pages/{page_id}/page_access_users/{page_access_user_id}/metrics?page=1&per_page=100 \
-H "Authorization: api_key"
```

--------------------------------

### Page Access User Components: Get Components

Source: https://developer.statuspage.io/index

Retrieves the list of components assigned to a page access user. This shows which components the user can interact with.

```REST
GET /pages/{page_id}/users/{user_id}/components
```

--------------------------------

### Unsubscribed Subscriber Sample

Source: https://developer.statuspage.io/index

An example of a single unsubscribed subscriber object, including their ID, contact details, and subscription status.

```json
{
  "id": "cn9ydclfyxb9",
  "skip_confirmation_notification": true,
  "mode": "email",
  "email": "foo@example2.com",
  "endpoint": "http://example.com/",
  "phone_number": "202-555-0105",
  "phone_country": "US",
  "display_phone_number": "+1 (202) 555-0105",
  "obfuscated_channel_name": "#*******an",
  "workspace_name": "Atlassian",
  "quarantined_at": "2025-09-02T12:35:58Z",
  "purge_at": "2025-09-02T12:35:58Z",
  "components": [
    "p77tb9txn8rq"
],
  "page_access_user_id": "20vtwzfh6nvn",
  "created_at": "2025-09-02T12:35:58Z"
}
```

--------------------------------

### Components: Get Uptime Data

Source: https://developer.statuspage.io/index

Retrieves uptime data for a specific component. This is useful for performance monitoring and historical analysis.

```REST
GET /components/{component_id}/uptime
```

--------------------------------

### Components: Get Specific Component

Source: https://developer.statuspage.io/index

Retrieves details for a specific component by its ID. This provides comprehensive information about a single component.

```REST
GET /components/{component_id}
```

--------------------------------

### Subscriber Response Sample - JSON

Source: https://developer.statuspage.io/index

Example JSON structure for a successful response when retrieving or updating subscriber information. It includes details like ID, subscription mode, contact information, and associated components.

```json
{
  "id": "cn9ydclfyxb9",
  "skip_confirmation_notification": true,
  "mode": "email",
  "email": "foo@example2.com",
  "endpoint": "http://example.com/",
  "phone_number": "202-555-0105",
  "phone_country": "US",
  "display_phone_number": "+1 (202) 555-0105",
  "obfuscated_channel_name": "#*******an",
  "workspace_name": "Atlassian",
  "quarantined_at": "2025-09-02T12:35:58Z",
  "purge_at": "2025-09-02T12:35:58Z",
  "components": [
    "p77tb9txn8rq"
  ],
  "page_access_user_id": "20vtwzfh6nvn",
  "created_at": "2025-09-02T12:35:58Z"
}
```

--------------------------------

### Create Subscriber Request Payload

Source: https://developer.statuspage.io/index

Example JSON payload for creating a new subscriber. Specifies the subscriber's type (e.g., 'email') and potentially other details.

```json
{
  "subscribers": "string",
  "type": "email"

}
```

--------------------------------

### Subscribers: Get List

Source: https://developer.statuspage.io/index

Retrieves a list of all subscribers for a page. This endpoint provides details on all subscribed users.

```REST
GET /subscribers
```

--------------------------------

### Get Components for Page Access User

Source: https://developer.statuspage.io/index

Retrieves the components associated with a specific page access user. Requires the page ID and page access user ID. Supports pagination parameters like 'page' and 'per_page'.

```bash
curl https://api.statuspage.io/v1/pages/{page_id}/page_access_users/{page_access_user_id}/components \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get List of Component Groups

Source: https://developer.statuspage.io/index

Retrieves a list of all component groups for a given page. Supports pagination using 'page' and 'per_page' query parameters. Authentication is required.

```http
GET /pages/{page_id}/component-groups
```

--------------------------------

### Statuspage API: Get List of Metrics

Source: https://developer.statuspage.io/index

Retrieves a list of metrics for a given page. Requires the page_id as a path parameter.

```http
get /pages/{page_id}/metrics
```

--------------------------------

### Resend Confirmation Response Sample - JSON

Source: https://developer.statuspage.io/index

Example JSON structure for a response when resending a subscriber confirmation. It typically includes a message indicating the status.

```json
{
  "message": "string"
}
```

--------------------------------

### Create a Statuspage Component

Source: https://developer.statuspage.io/index

This section details how to create a new component for a Statuspage. It includes the API endpoint, required path parameters (page_id), and an example JSON payload for the request body. The response codes indicate success (201) or failure (401, 422).

```JSON
{
  "component": {
    "description": "string",
    "status": "operational",
    "name": "string",
    "only_show_if_degraded": true,
    "group_id": "string",
    "showcase": true,
    "start_date": "2025-09-02"
  }
}
```

--------------------------------

### Add Page Access User Request (cURL)

Source: https://developer.statuspage.io/index

Example of how to add a page access user to a Statuspage using cURL. It demonstrates the necessary headers, including the Authorization token, and the JSON payload containing user information.

```bash
curl https://api.statuspage.io/v1/pages/{page_id}/page_access_users \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{ "page_access_user": { "external_login": "string", "email": "string", "page_access_group_ids": [ "string" ], "subscribe_to_components": true } }'
```

--------------------------------

### Get StatusPage Metrics List

Source: https://developer.statuspage.io/index

Fetches a list of metrics for a given page. Supports pagination with 'page' and 'per_page' query parameters. Requires API key authorization.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/metrics \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get Component Groups - Curl

Source: https://developer.statuspage.io/index

Retrieves a list of component groups for a given page. Requires page ID and an API key for authorization.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/component-groups \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get Subscribers List Response Sample (200)

Source: https://developer.statuspage.io/index

Presents a sample JSON array response when retrieving a list of subscribers. Each object in the array represents a subscriber with their details.

```json
[
  {
    "id": "cn9ydclfyxb9",
    "skip_confirmation_notification": true,
    "mode": "email",
    "email": "foo@example2.com",
    "endpoint": "http://example.com/",
    "phone_number": "202-555-0105",
    "phone_country": "US",
    "display_phone_number": "+1 (202) 555-0105",
    "obfuscated_channel_name": "#*******an",
    "workspace_name": "Atlassian",
    "quarantined_at": "2025-09-02T12:35:58Z",
    "purge_at": "2025-09-02T12:35:58Z",
    "components": [
      "p77tb9txn8rq"
    ],
    "page_access_user_id": "20vtwzfh6nvn",
    "created_at": "2025-09-02T12:35:58Z"
  }
]
```

--------------------------------

### Get StatusPage.io Page Data

Source: https://developer.statuspage.io/index

Retrieves detailed information about a StatusPage.io page, including branding, domain settings, and subscriber options. This is typically used to view the current configuration of a status page.

```JSON
{
  "id": "v5dsxt49fx47",
  "created_at": "2025-09-02T12:35:58Z",
  "updated_at": "2025-09-02T12:35:58Z",
  "name": "My Company Status",
  "page_description": "string",
  "headline": "string",
  "branding": "string",
  "subdomain": "your-subdomain.statuspage.io",
  "domain": "status.mycompany.com",
  "url": "https://www.mycompany.com",
  "support_url": "string",
  "hidden_from_search": true,
  "allow_page_subscribers": true,
  "allow_incident_subscribers": true,
  "allow_email_subscribers": true,
  "allow_sms_subscribers": true,
  "allow_rss_atom_feeds": true,
  "allow_webhook_subscribers": true,
  "notifications_from_email": "no-reply@status.mycompany.com",
  "notifications_email_footer": "string",
  "activity_score": 0,
  "twitter_username": "string",
  "viewers_must_be_team_members": true,
  "ip_restrictions": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "time_zone": "UTC",
  "css_body_background_color": "string",
  "css_font_color": "string",
  "css_light_font_color": "string",
  "css_greens": "string",
  "css_yellows": "string",
  "css_oranges": "string",
  "css_blues": "string",
  "css_reds": "string",
  "css_border_color": "string",
  "css_graph_color": "string",
  "css_link_color": "string",
  "css_no_data": "string",
  "favicon_logo": "string",
  "transactional_logo": "string",
  "hero_cover": "string",
  "email_logo": "string",
  "twitter_logo": "string"
}
```

--------------------------------

### Get Component Uptime Data

Source: https://developer.statuspage.io/index

Retrieves uptime data for a specific component on a Statuspage. Requires the page ID and component ID. The component must have uptime showcase enabled.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/components/{component_id} \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get List of Pages

Source: https://developer.statuspage.io/index

Retrieves a list of all pages associated with your StatusPage account. This operation requires an API key for authorization and returns a JSON array of page objects.

```curl
curl https://api.statuspage.io/v1/pages \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get Statuspage Page Information

Source: https://developer.statuspage.io/index

Retrieves details for a specific Statuspage page using its unique identifier. Requires an API key for authorization. The response includes various page attributes such as ID, creation date, name, URLs, and branding settings.

```bash
curl https://api.statuspage.io/v1/pages/{page_id} \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Page Access User Metrics: Get Metrics

Source: https://developer.statuspage.io/index

Retrieves the list of metrics assigned to a page access user. This shows which metrics the user can interact with.

```REST
GET /pages/{page_id}/users/{user_id}/metrics
```

--------------------------------

### StatusPage API: Get Incident Update Response Sample

Source: https://developer.statuspage.io/index

Provides a sample JSON response for retrieving an incident update. It includes details like incident ID, affected components, timestamps, and status.

```json
{
  "id": "string",
  "incident_id": "string",
  "affected_components": [
    {
      "code": "string",
      "name": "string",
      "old_status": "operational",
      "new_status": "operational"
}
],
  "body": "string",
  "created_at": "2025-09-02T12:35:59Z",
  "custom_tweet": "string",
  "deliver_notifications": true,
  "display_at": "2025-09-02T12:35:59Z",
  "status": "investigating",
  "tweet_id": "string",
  "twitter_updated_at": "2025-09-02T12:35:59Z",
  "updated_at": "2025-09-02T12:35:59Z",
  "wants_twitter_update": true

}
```

--------------------------------

### Get Page Access Groups

Source: https://developer.statuspage.io/index

Retrieves a list of page access groups for a given page. Supports GET requests and optional pagination parameters.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/page_access_groups \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### StatusPage API: Get Incident Subscribers Curl Request

Source: https://developer.statuspage.io/index

Demonstrates how to fetch a list of incident subscribers using a cURL command. It includes the necessary endpoint and authorization header.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/incidents/{incident_id}/subscribers \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get Component Details

Source: https://developer.statuspage.io/index

Retrieves the details of a specific component on a Statuspage. Requires the page ID and component ID. The response includes component attributes like ID, name, status, and timestamps.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/components/{component_id} \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Create Components for Page Access User (POST)

Source: https://developer.statuspage.io/index

Creates or associates components with a page access user. Requires API key authorization. The request body contains the list of component IDs to be added.

```json
{
  "component_ids": [
    "string"
  ]
}
```

--------------------------------

### Create Component Group

Source: https://developer.statuspage.io/index

Creates a new component group to organize components. A component group requires a name and can optionally include a description and a list of component IDs. Authentication is via API key.

```json
{
  "description": "string",
  "component_group": {
    "components": [
      "string"
    ],
    "name": "string"
  }
}
```

--------------------------------

### Get StatusPage Incident Templates (Curl)

Source: https://developer.statuspage.io/index

This cURL command demonstrates how to retrieve a list of incident templates for a specific StatusPage. It requires an API key for authorization and specifies the page ID.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/incident_templates \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get Metric Provider Request (Curl)

Source: https://developer.statuspage.io/index

This cURL command demonstrates how to retrieve a specific metric provider using its ID and the page ID. It includes the necessary authorization header.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/metrics_providers/{metrics_provider_id} \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get Page Access User Metrics

Source: https://developer.statuspage.io/index

Retrieves metrics for a specific page access user. Requires page ID and page access user ID. Supports GET requests and returns JSON.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/page_access_users/{page_access_user_id}/metrics \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get Page Access Users

Source: https://developer.statuspage.io/index

Retrieves a list of page access users for a given page. Requires an API key for authorization. The response includes user details such as ID, email, and creation timestamps.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/page_access_users \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Statuspage API: Uptime Data Response Sample

Source: https://developer.statuspage.io/index

Sample response structure for retrieving uptime data, including date ranges, uptime percentage, outage durations, warnings, and related event information.

```json
{
  "range_start": "2020-01-15",
  "range_end": "2020-02-15",
  "uptime_percentage": 96.67,
  "major_outage": 86400,
  "partial_outage": 0,
  "warnings": [
    "End date was adjusted to today. See range_end field in response for end date used."
  ],
  "id": "string",
  "name": "string",
  "related_events": {
    "component_id": "string",
    "incidents": {
      "id": "string"
    }
  }
}
```

--------------------------------

### Get Scheduled Incidents using cURL

Source: https://developer.statuspage.io/index

This snippet shows how to retrieve a list of scheduled incidents for a specific page using the StatusPage API. It requires an API key for authorization and specifies the HTTP GET method.

```bash
curl https://api.statuspage.io/v1/pages/{page_id}/incidents/upcoming \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Get User Permissions

Source: https://developer.statuspage.io/index

Retrieves the permissions for a specific user within an organization. Requires an API key for authorization. The response includes the user ID and a list of pages with their associated permission settings.

```bash
curl https://api.statuspage.io/v1/organizations/{organization_id}/permissions/{user_id} \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

```json
{
  "user_id": "fqrlgywlyg0b",
  "pages": [
    {
      "page_id": "xt5lg2snyf17",
      "page_configuration": false,
      "incident_manager": true,
      "maintenance_manager": true
    },
    {
      "page_id": "b3h28dbb5xgb",
      "page_configuration": false,
      "incident_manager": true,
      "maintenance_manager": true
    }
  ]
}
```

--------------------------------

### Get List of Statuspage Page Access Users

Source: https://developer.statuspage.io/index

Retrieves a list of page access users for a given Statuspage. Supports filtering by email and pagination using 'page' and 'per_page' query parameters. Requires API key authorization.

```bash
curl -G https://api.statuspage.io/v1/pages/{page_id}/page_access_users \
  -H "Authorization: OAuth your-api-key-goes-here" \
  --data-urlencode "email=user@example.com" \
  --data-urlencode "page=1" \
  --data-urlencode "per_page=20"
```

--------------------------------

### Get StatusPage.io Incident via Curl

Source: https://developer.statuspage.io/index

This sample demonstrates how to retrieve a specific incident from StatusPage.io using a cURL command. It requires the page ID and incident ID, and uses an API key for authorization.

```bash
curl https://api.statuspage.io/v1/pages/{page_id}/incidents/{incident_id} \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Components: Create Component

Source: https://developer.statuspage.io/index

Creates a new component. Components represent parts of your system that can have their status updated.

```REST
POST /components
```

--------------------------------

### Create Subscriber Response Sample (201)

Source: https://developer.statuspage.io/index

Provides a sample JSON response for a successfully created subscriber. It includes details such as the subscriber's ID, mode, contact information, and associated components.

```json
{
  "id": "cn9ydclfyxb9",
  "skip_confirmation_notification": true,
  "mode": "email",
  "email": "foo@example2.com",
  "endpoint": "http://example.com/",
  "phone_number": "202-555-0105",
  "phone_country": "US",
  "display_phone_number": "+1 (202) 555-0105",
  "obfuscated_channel_name": "#*******an",
  "workspace_name": "Atlassian",
  "quarantined_at": "2025-09-02T12:35:58Z",
  "purge_at": "2025-09-02T12:35:58Z",
  "components": [
    "p77tb9txn8rq"
  ],
  "page_access_user_id": "20vtwzfh6nvn",
  "created_at": "2025-09-02T12:35:58Z"
}
```

--------------------------------

### Get Specific Page Access User

Source: https://developer.statuspage.io/index

Retrieves details for a single page access user, identified by page ID and user ID. This GET request requires an API key for authentication and returns user-specific information.

```curl
curl https://api.statuspage.io/v1/pages/{page_id}/page_access_users/{page_access_user_id} \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

--------------------------------

### Create a Metric Provider

Source: https://developer.statuspage.io/index

Creates a new metric provider for a specified page. This operation requires API key authorization and accepts a JSON payload with metric provider configuration.

```JSON
{
  "metrics_provider": {
    "type": "string",
    "metric_base_uri": "string"
  }
}
```

--------------------------------

### Get Status Embed Config Settings

Source: https://developer.statuspage.io/index

Fetches the current status embed configuration settings for a given page. This operation requires an API key and the page ID. The response details various configuration parameters like position and color settings.

```bash
curl https://api.statuspage.io/v1/pages/{page_id}/status_embed_config \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X GET
```

```json
{
  "page_id": "string",
  "position": "string",
  "incident_background_color": "string",
  "incident_text_color": "string",
  "maintenance_background_color": "string",
  "maintenance_text_color": "string"
}
```

--------------------------------

### Create User

Source: https://developer.statuspage.io/index

Creates a new user within an organization. Requires API key authorization and accepts user details such as email, password, first name, and last name in the request body. The response includes the newly created user's information or relevant error codes.

```json
{
  "user": {
    "email": "string",
    "password": "string",
    "first_name": "string",
    "last_name": "string"
}

}
```

```json
{
  "id": "string",
  "organization_id": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "created_at": "2025-09-02T12:35:59Z",
  "updated_at": "2025-09-02T12:35:59Z"

}
```

--------------------------------

### Incidents: Get List

Source: https://developer.statuspage.io/index

Retrieves a list of all incidents. This includes active, resolved, and upcoming incidents.

```REST
GET /incidents
```

--------------------------------

### Subscribers: Get Unsubscribed List

Source: https://developer.statuspage.io/index

Retrieves a list of all subscribers who have unsubscribed. This can be used for managing opt-out lists.

```REST
GET /subscribers/unsubscribed
```

--------------------------------

### Authentication: API Key in Query Param

Source: https://developer.statuspage.io/index

Alternative method for authenticating with the Statuspage API by including the API key as a query parameter in the URL.

```bash
curl "https://api.statuspage.io/v1/pages/gytm4qzbx9t6.json?api_key=89a229ce1a8dbcf9ff30430fbe35eb4c0426574bca932061892cefd2138aa4b1"
```

--------------------------------

### Incident Postmortem: Get Postmortem

Source: https://developer.statuspage.io/index

Retrieves the postmortem details for an incident. This allows viewing the analysis and findings after an incident.

```REST
GET /incidents/{incident_id}/postmortem
```

--------------------------------

### Incidents: Get Scheduled Incidents

Source: https://developer.statuspage.io/index

Retrieves a list of scheduled incidents. This includes planned maintenance and other scheduled events.

```REST
GET /incidents/scheduled
```

--------------------------------

### StatusPage API: Create Incident Subscriber Response Sample

Source: https://developer.statuspage.io/index

Illustrates a sample JSON response when a new incident subscriber is successfully created. It details the subscriber's ID, contact information, and associated page.

```json
{
  "id": "cn9ydclfyxb9",
  "skip_confirmation_notification": true,
  "mode": "email",
  "email": "foo@example2.com",
  "endpoint": "http://example.com/",
  "phone_number": "202-555-0105",
  "phone_country": "US",
  "display_phone_number": "+1 (202) 555-0105",
  "obfuscated_channel_name": "#*******an",
  "workspace_name": "Atlassian",
  "quarantined_at": "2025-09-02T12:35:59Z",
  "purge_at": "2025-09-02T12:35:59Z",
  "components": [
    "p77tb9txn8rq"
],
  "page_access_user_id": "20vtwzfh6nvn",
  "created_at": "2025-09-02T12:35:59Z"

}
```

--------------------------------

### Incidents: Delete Incident

Source: https://developer.statuspage.io/index

Deletes a specific incident. Use this to remove an incident record, for example, if it was created in error.

```REST
DELETE /incidents/{incident_id}
```

--------------------------------

### Templates: Create Template

Source: https://developer.statuspage.io/index

Creates a new notification template. Templates are used for standardizing communication content.

```REST
POST /templates
```

--------------------------------

### Create a Metric for a Metric Provider

Source: https://developer.statuspage.io/index

Creates a new metric for a specified metric provider on a given page. This operation requires an API key for authorization and accepts a JSON payload containing metric details.

```JSON
{
  "metric": {
    "name": "string",
    "metric_identifier": "string",
    "transform": "string",
    "application_id": "string",
    "suffix": "string",
    "y_axis_min": 0,
    "y_axis_max": 0,
    "y_axis_hidden": true,
    "display": true,
    "decimal_places": 0,
    "tooltip_description": "string"
  }
}
```

--------------------------------

### Incident Subscribers: Get List

Source: https://developer.statuspage.io/index

Retrieves a list of subscribers for a specific incident. This shows who is currently subscribed to updates for that incident.

```REST
GET /incidents/{incident_id}/subscribers
```

--------------------------------

### Incidents: Get Specific Incident

Source: https://developer.statuspage.io/index

Retrieves details for a specific incident by its ID. This provides comprehensive information about a single incident.

```REST
GET /incidents/{incident_id}
```

--------------------------------

### Incidents: Get Unresolved Incidents

Source: https://developer.statuspage.io/index

Retrieves a list of all incidents that are currently unresolved. This focuses on active issues that require attention.

```REST
GET /incidents/unresolved
```

--------------------------------

### Add Page Access Users to Component

Source: https://developer.statuspage.io/index

Adds page access users to a specified component. Requires page and component identifiers, and a list of user IDs in the request body. Authentication is handled via an API key.

```bash
curl https://api.statuspage.io/v1/pages/{page_id}/components/{component_id}/page_access_users \
  -H "Authorization: OAuth your-api-key-goes-here" \
  -X POST \
  -d "page_access_user_ids[]=your-id"
```

--------------------------------

### Incidents: Get Upcoming Incidents

Source: https://developer.statuspage.io/index

Retrieves a list of upcoming incidents. This is useful for planning and communication regarding future events.

```REST
GET /incidents/upcoming
```

--------------------------------

### Generic Response Sample

Source: https://developer.statuspage.io/index

A sample JSON response indicating a message, often used for error or status reporting.

```json
{
  "message": "string"

}
```

--------------------------------

### StatusPage API: Create Incident Subscriber Request Sample

Source: https://developer.statuspage.io/index

Provides a sample JSON payload for creating a new incident subscriber. It includes fields for email, phone number, and notification preferences.

```json
{
  "subscriber": {
    "email": "string",
    "phone_country": "string",
    "phone_number": "string",
    "skip_confirmation_notification": true
}

}
```

--------------------------------

### Incidents: Get Active Maintenances

Source: https://developer.statuspage.io/index

Retrieves a list of currently active maintenance periods. This helps in monitoring ongoing scheduled work.

```REST
GET /incidents/maintenances
```

--------------------------------

### Subscribers: Get Subscriber

Source: https://developer.statuspage.io/index

Retrieves details for a specific subscriber. This endpoint provides information about a single subscriber's status and details.

```REST
GET /subscribers/{subscriber_id}
```

--------------------------------

### Subscribers: Get Count by Type

Source: https://developer.statuspage.io/index

Retrieves the count of subscribers, broken down by subscriber type. This provides insights into the distribution of subscriber types.

```REST
GET /subscribers/count
```