Incidents
List Incidents
Lists incidents.
AuthorizationBearer <token>
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
Query Parameters
applies_to_parts?array<string>
Filters for incidents that apply to any of the provided parts.
created_by?array<string>
Filters for incidents created by any of the provided users.
cursor?string
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
Format
textcustom_fields?object
Filters for custom fields.
Empty Object
limit?integer
The maximum number of items.
Format
int32mode?string
The iteration mode to use, otherwise if not set, then "after" is used.
Value in
"after" | "before"owned_by?array<string>
Filters for incidents owned by any of the provided users.
pia?array<string>
Filters for incidents with any of the provided PIAs.
playbooks?array<string>
Filters for incidents with any of the provided playbooks.
related_docs?array<string>
Filters for incidents with any of the provided related docs.
reported_by?array<integer>
Filters for incidents with any of the provided reporters.
severity?array<integer>
Filters for incidents containing any of the provided severities.
sort_by?array<string>
The list of fields to sort the items by and how to sort them.
source?array<integer>Deprecated
Filters for incidents with any of the provided sources.
stage?array<string>
Filters for incidents in any of the provided stages.
staged_info.is_staged?boolean
Filters for issues that are staged.
subtype?array<string>
Filters for incidents with any of the provided subtypes.
sync_metadata.external_reference?array<string>
Filters for issues with this specific external reference.
sync_metadata.last_sync_in.status?array<sync-metadata-filter-sync-in-filter-status>
Filters for works with selected sync statuses.
sync_metadata.last_sync_in.sync_history?array<string>
Filters for works modified with selected sync history.
sync_metadata.last_sync_in.sync_unit?array<string>
Filters for works modified with selected sync units.
sync_metadata.last_sync_out.status?array<sync-metadata-filter-sync-out-filter-status>
Filters for works with selected sync statuses.
sync_metadata.last_sync_out.sync_history?array<string>
Filters for works modified with selected sync history.
sync_metadata.last_sync_out.sync_unit?array<string>
Filters for works modified with selected sync units.
sync_metadata.origin_system?array<string>
Filters for issues synced from this specific origin system.
title?array<string>
Filters for incidents by the provided titles.
Response Body
curl -X GET "https://api.devrev.ai/incidents.list?applies_to_parts=string&created_by=DEVU-12345&cursor=string&custom_fields=&limit=0&mode=after&owned_by=string&pia=ARTICLE-12345&playbooks=ARTICLE-12345&related_docs=ARTICLE-12345&reported_by=0&severity=0&sort_by=string&source=0&stage=string&staged_info.is_staged=true&subtype=string&sync_metadata.external_reference=string&sync_metadata.last_sync_in.status=failed&sync_metadata.last_sync_in.sync_history=string&sync_metadata.last_sync_in.sync_unit=string&sync_metadata.last_sync_out.status=failed&sync_metadata.last_sync_out.sync_history=string&sync_metadata.last_sync_out.sync_unit=string&sync_metadata.origin_system=string&title=string"{
"incidents": [
{
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"acknowledged_date": "2023-01-01T12:00:00.000Z",
"actual_close_date": "2023-01-01T12:00:00.000Z",
"applies_to_parts": [
{
"type": "capability",
"display_id": "string",
"id": "string",
"name": "string",
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
}
}
],
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"body": "string",
"custom_fields": {},
"custom_schema_fragments": [
"don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
],
"identified_date": "2023-01-01T12:00:00.000Z",
"impact": {
"count": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"customer_ids": [
{
"display_id": "string",
"id": "string",
"display_name": "string"
}
]
},
"mitigated_date": "2023-01-01T12:00:00.000Z",
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"pia": [
{
"display_id": "string",
"id": "string",
"article_type": "article",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
},
"title": "string"
}
],
"playbooks": [
{
"display_id": "string",
"id": "string",
"article_type": "article",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
},
"title": "string"
}
],
"reported_by": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"severity": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"source": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"stage": {
"stage": {
"display_id": "string",
"id": "string",
"name": "string"
},
"state": {
"display_id": "string",
"id": "string",
"is_final": true,
"name": "string"
}
},
"stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
"subtype": "string",
"sync_metadata": {
"external_reference": "string",
"last_sync_in": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"last_sync_out": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"origin_system": "string"
},
"tags": [
{
"tag": {
"display_id": "string",
"id": "string",
"name": "string",
"style_new": {
"color": "string"
}
},
"value": "string"
}
],
"target_close_date": "2023-01-01T12:00:00.000Z",
"title": "string"
}
],
"next_cursor": "string",
"prev_cursor": "string"
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}