List Issues

post

https://api.safetyculture.io/tasks/v1/incidents/list

The issues list endpoint allow you to retrieve all the issues that meet a certain criteria. The presence of next_page_token indicates that there are more results for this search. The request can specify the number of issues that will be returned using the optional parameter page_size. It accepts non-negative numbers with a default of 20 and maximum value of 100.

Returned issues can be filtered using the filters argument. They can also be sorted by providing the sort_field and sort_direction options.

Body Params

GetIncidentsRequest represents the parameters to GetIncidents.

page_size

int32

Optional. Number of issues to be returned in a single request.
This must be a value between 1 and 100, any values outside of this range
will be ignored. The presence of next_page_token in the response
indicates that more results might be available.

page_token

string

Optional. If present, then retrieve the next batch of results from the
preceding call to this method. page_token must be the value of
next_page_token from the previous response. The values of other method
parameters should be identical to those in the previous call.
This can be used to retrieve more than 100 issues with multiple API
calls. For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='

sort_field

string

enum

Defaults to SORT_FIELD_UNKNOWN

The options available to sort the issues by.
By default, the issues will be returned by the date they were last
modified in descending order. This should be used in combination with
SortDirection to determine how issues are sorted. If either
SortField or SortDirection is missing, the default sort order will be
used.

SORT_FIELD_UNKNOWN: SORT_FIELD_UNKNOWN will return the default sort order.
PRIORITY: PRIORITY will sort the issues by incident priority.
DATE_DUE: DATE_DUE will sort the issues by due date.
CREATED_AT: CREATED_AT will sort the issues by the date they were created.
MODIFIED_AT: MODIFIED_AT will sort the issues by the date they were last
modified.
OCCURRED_AT: OCCURRED_AT will sort the issues by the date they occurred at.

Allowed:

sort_direction

string

enum

Defaults to SORT_DIRECTION_UNKNOWN

The options available to define the sort direction.

SORT_DIRECTION_UNKNOWN: SORT_DIRECTION_UNKNOWN will return the default sort direction.
ASC: ASC will return the sorted issues in ascending order.
DESC: DESC will return the sorted issues in descending order.

Allowed:

filters

array of objects

Optional. An array of filters can be provided in the request to filter the
issues.

filters

Responses

200A successful response.

defaultAn unexpected error response.