List active incidents for a status page

Returns a paginated list of active incidents for the status page identified by the custom domain.

GET /api/v1/incidents.json

List active incidents for a status page

cURL

curl --request GET \
  --url https://{custom_domain}/api/v1/incidents.json

200

{
  "page": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "time_zone": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "incidents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "monitoring_at": "2023-11-07T05:31:56Z",
      "resolved_at": "2023-11-07T05:31:56Z",
      "shortlink": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "incident_updates": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "<string>",
          "body": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "display_at": "2023-11-07T05:31:56Z",
          "custom_tweet": "<string>",
          "deliver_notifications": true,
          "tweet_id": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123
  }
}

Query Parameters

page · integer

Page number

per_page · integer

Number of incidents per page (max 100)

Response

200

application/json

incidents found

page · object

Show child attributes

incidents · object[]

Show child attributes

pagination · object

Show child attributes