List Incidents

GET

Lists incidents.

Query parameters

applies_to_partslist of stringsOptional

Filters for incidents that apply to any of the provided parts.

created_bylist of stringsOptional

Filters for incidents created by any of the provided users.

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

custom_fieldsobjectOptional

Filters for custom fields.

limitintegerOptional

The maximum number of items.

modeenumRequired

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
owned_bylist of stringsOptional

Filters for incidents owned by any of the provided users.

pialist of stringsOptional

Filters for incidents with any of the provided PIAs.

playbookslist of stringsOptional

Filters for incidents with any of the provided playbooks.

related_docslist of stringsOptional

Filters for incidents with any of the provided related docs.

reported_bylist of longsOptional

Filters for incidents with any of the provided reporters.

severitylist of longsOptional

Filters for incidents containing any of the provided severities.

sort_bylist of stringsOptional

The list of fields to sort the items by and how to sort them.

sourcelist of longsOptional

Filters for incidents with any of the provided sources.

stagelist of stringsOptional

Filters for incidents in any of the provided stages.

subtypelist of stringsOptional

Filters for incidents with any of the provided subtypes.

titlelist of stringsOptional

Filters for incidents by the provided titles.

Response

Success.

incidentslist of objects

The matching incidents.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Built with