Skip to main content
GET
/
v2
/
alerts
List
curl --request GET \
  --url https://api.incident.io/v2/alerts
{
  "alerts": [
    {
      "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66",
      "attributes": [
        {
          "array_value": [
            {
              "catalog_entry": {
                "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
                "id": "01FCNDV6P870EA6S7TK1DSYDG0",
                "name": "Primary On-call"
              },
              "label": "Payments Team",
              "literal": "SEV123"
            }
          ],
          "attribute": {
            "array": false,
            "id": "01GW2G3V0S59R238FAHPDS1R66",
            "name": "service",
            "required": false,
            "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"
          },
          "value": {
            "catalog_entry": {
              "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
              "id": "01FCNDV6P870EA6S7TK1DSYDG0",
              "name": "Primary On-call"
            },
            "label": "Payments Team",
            "literal": "SEV123"
          }
        }
      ],
      "created_at": "2021-08-17T13:28:57.801578Z",
      "deduplication_key": "4293868629",
      "description": "CPU on the payments service has exceeded 75 percent for 5 minutes",
      "id": "01GW2G3V0S59R238FAHPDS1R66",
      "resolved_at": "2021-08-17T14:28:57.801578Z",
      "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123",
      "status": "firing",
      "title": "*errors.withMessage: PG::Error failed to connect",
      "updated_at": "2021-08-17T13:28:57.801578Z"
    }
  ],
  "pagination_meta": {
    "after": "01FCNDV6P870EA6S7TK1DSYDG0",
    "page_size": 25
  }
}

Query Parameters

​
page_size
integer<int64>
default:25
required

Number of alerts to return per page

Required range: 1 <= x <= 50
Example:

25

​
after
string

If provided, pass this as the 'after' param to load the next page

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
deduplication_key
object

Filter on alert deduplication key. The accepted operator is 'is'.

Example:
{ "is": ["01GBSQF3FHF7FWZQNWGHAVQ804"] }
​
status
object

Filter on alert status. The accepted operators are 'one_of', or 'not_in'.

Example:
{ "one_of": ["firing"] }
​
created_at
object

Filter on alert created at timestamp. Accepted operators are 'gte', 'lte' and 'date_range'.

Example:
{ "gte": ["2025-01-01"] }

Response

200 - application/json

OK response.

​
alerts
object[]
required
Example:
[
  {
    "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66",
    "attributes": [
      {
        "array_value": [
          {
            "catalog_entry": {
              "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
              "id": "01FCNDV6P870EA6S7TK1DSYDG0",
              "name": "Primary On-call"
            },
            "label": "Payments Team",
            "literal": "SEV123"
          }
        ],
        "attribute": {
          "array": false,
          "id": "01GW2G3V0S59R238FAHPDS1R66",
          "name": "service",
          "required": false,
          "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"
        },
        "value": {
          "catalog_entry": {
            "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "name": "Primary On-call"
          },
          "label": "Payments Team",
          "literal": "SEV123"
        }
      }
    ],
    "created_at": "2021-08-17T13:28:57.801578Z",
    "deduplication_key": "4293868629",
    "description": "CPU on the payments service has exceeded 75 percent for 5 minutes",
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "resolved_at": "2021-08-17T14:28:57.801578Z",
    "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123",
    "status": "firing",
    "title": "*errors.withMessage: PG::Error failed to connect",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
]
​
pagination_meta
object
required
Example:
{
  "after": "01FCNDV6P870EA6S7TK1DSYDG0",
  "page_size": 25
}