Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Investigations

List Investigations

get/incidents/v1/investigations

Query parameters

searchstring

optional. a string to match results against

filters.investigation_ids.valuesstring[]

list of values that should match

filters.status_ids.valuesstring[]

list of values that should match

filters.site_ids.valuesstring[]

list of values that should match

filters.title.termstring

The term to search for

filters.title.match_behaviour'MatchBehaviourPartial' | 'MatchBehaviourExact'

Optional. The matching behaviour of this term

  • MatchBehaviourPartial: Partially match the term
  • MatchBehaviourExact: Exactly match the term
filters.description.termstring

The term to search for

filters.description.match_behaviour'MatchBehaviourPartial' | 'MatchBehaviourExact'

Optional. The matching behaviour of this term

  • MatchBehaviourPartial: Partially match the term
  • MatchBehaviourExact: Exactly match the term
filters.created_at.fromstring date-time

Optional. The start point for the filter. if not specified, the from component of the range will not apply

filters.created_at.tostring date-time

Optional. The end point for the filter. if not specified, the to component of the range will not apply

filters.modified_at.fromstring date-time

Optional. The start point for the filter. if not specified, the from component of the range will not apply

filters.modified_at.tostring date-time

Optional. The end point for the filter. if not specified, the to component of the range will not apply

filters.created_by.valuesstring[]

list of values that should match

filters.owned_by.valuesstring[]

list of values that should match

filters.linked_issue_ids.valuesstring[]

list of values that should match

filters.linked_action_ids.valuesstring[]

list of values that should match

filters.linked_inspection_ids.valuesstring[]

list of values that should match

filters.category_ids.valuesstring[]

list of values that should match

sort.field'InvestigationsSortFieldCreatedAt' | 'InvestigationsSortFieldModifiedAt' | 'InvestigationsSortFieldTitle' | 'InvestigationsSortFieldStatus' | 'InvestigationsSortFieldUniqueID' | 'InvestigationsSortFieldCategoryName'

optional. the field to sort by

  • InvestigationsSortFieldCreatedAt: created sort field
  • InvestigationsSortFieldModifiedAt: modified at sort field
  • InvestigationsSortFieldTitle: title sort field
  • InvestigationsSortFieldStatus: status sort field
  • InvestigationsSortFieldUniqueID: unique ID sort field
  • InvestigationsSortFieldCategoryName: category name sort field
sort.order'InvestigationsSortOrderAsc' | 'InvestigationsSortOrderDesc'

optional. the order to sort results

  • InvestigationsSortOrderAsc: ascending sort order
  • InvestigationsSortOrderDesc: descending sort order
page_sizeinteger required

required. The number of results to return

page_tokenstring

optional. next page token from a previous response to continue fetching further results

Response

A successful response.

next_page_tokenstring

a token which can be used to fetch further results