Sign in

v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB
incidents

List Incidents

List service incidents with pagination and filtering

get/api/v1/incidents/

Query parameters

pageinteger nullable

The page number from which to start (0-based)

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25

The maximum number of items to return

search_fieldsIncidentProperties[]

String names of fields to search. Correspond by index to search field values

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'id' | 'description' | 'impact_category' | 'sessions_impacted' | 'markdown' | 'created_at' | 'updated_at' | 'organization_id' | 'sub_organization_id' | 'start_datetime' | 'end_datetime' | 'resolution_datetime'

Names of agent fields supported for filtering/sorting on list endpoint.

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsIncidentProperties[] nullable

The fields to include in the response

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z

The start datetime for filtering results

end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

The end datetime for filtering results

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "description": "Service outage in region X",
      "start_datetime": "2023-10-01T08:00:00Z",
      "resolution_datetime": "2023-10-01T12:00:00Z",
      "impact_category": "High",
      "sessions_impacted": 1500,
      "markdown": "**Incident Details**",
      "organization_id": 123,
      "sub_organization_id": 456,
      "sub_organization": "SubOrg A",
      "id": 1,
      "created_at": "2023-10-01T08:00:00Z",
      "updated_at": "2023-10-01T08:00:00Z",
      "last_updated_by": "user@mail.com"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}