v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBIncidents
Get a list of incidents
Get all incidents for the user's organization.
get/api/v2/incidents
Query parameters
includeIncidentRelatedObject[]
Specifies which types of related objects should be included in the response.
page[size]integer
Example:10
Size for a given page. The maximum allowed value is 100.
page[offset]integer
Specific offset to use as the beginning of the returned page.
Response
OK
Example response
{
"data": [
{
"attributes": {
"created": "2020-04-21T15:34:08.627205+00:00",
"creation_idempotency_key": null,
"customer_impact_duration": 0,
"customer_impact_end": null,
"customer_impact_scope": null,
"customer_impact_start": null,
"customer_impacted": false,
"detected": "2020-04-14T00:00:00+00:00",
"incident_type_uuid": "00000000-0000-0000-0000-000000000001",
"modified": "2020-09-17T14:16:58.696424+00:00",
"public_id": 1,
"resolved": null,
"severity": "SEV-1",
"time_to_detect": 0,
"time_to_internal_response": 0,
"time_to_repair": 0,
"time_to_resolve": 0,
"title": "Example Incident"
},
"id": "00000000-aaaa-0000-0000-000000000000",
"relationships": {
"attachments": {
"data": [
{
"id": "00000000-9999-0000-0000-000000000000",
"type": "incident_attachments"
},
{
"id": "00000000-1234-0000-0000-000000000000",
"type": "incident_attachments"
}
]
},
"commander_user": {
"data": {
"id": "00000000-0000-0000-cccc-000000000000",
"type": "users"
}
},
"created_by_user": {
"data": {
"id": "00000000-0000-0000-cccc-000000000000",
"type": "users"
}
},
"integrations": {
"data": [
{
"id": "00000000-0000-0000-4444-000000000000",
"type": "incident_integrations"
},
{
"id": "00000000-0000-0000-5555-000000000000",
"type": "incident_integrations"
}
]
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-cccc-000000000000",
"type": "users"
}
}
},
"type": "incidents"
},
{
"attributes": {
"created": "2020-04-21T15:34:08.627205+00:00",
"creation_idempotency_key": null,
"customer_impact_duration": 0,
"customer_impact_end": null,
"customer_impact_scope": null,
"customer_impact_start": null,
"customer_impacted": false,
"detected": "2020-04-14T00:00:00+00:00",
"incident_type_uuid": "00000000-0000-0000-0000-000000000002",
"modified": "2020-09-17T14:16:58.696424+00:00",
"public_id": 2,
"resolved": null,
"severity": "SEV-5",
"time_to_detect": 0,
"time_to_internal_response": 0,
"time_to_repair": 0,
"time_to_resolve": 0,
"title": "Example Incident 2"
},
"id": "00000000-1111-0000-0000-000000000000",
"relationships": {
"attachments": {
"data": [
{
"id": "00000000-9999-0000-0000-000000000000",
"type": "incident_attachments"
}
]
},
"commander_user": {
"data": {
"id": "00000000-aaaa-0000-0000-000000000000",
"type": "users"
}
},
"created_by_user": {
"data": {
"id": "00000000-aaaa-0000-0000-000000000000",
"type": "users"
}
},
"integrations": {
"data": [
{
"id": "00000000-0000-0000-0001-000000000000",
"type": "incident_integrations"
},
{
"id": "00000000-0000-0000-0002-000000000000",
"type": "incident_integrations"
}
]
},
"last_modified_by_user": {
"data": {
"id": "00000000-aaaa-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "incidents"
}
],
"included": [
{
"type": "users"
}
],
"meta": {
"pagination": {
"next_offset": 1000,
"offset": 10,
"size": 1000
}
}
}