API

List Heads Ups

post
https://api.safetyculture.io/announcements/v1/announcement:ListHeadsUpManage

Lists all Heads Ups in your organization.

This endpoint requires the "Heads Up: Manage" permission for all Heads Ups, or the "Heads Up: Create" permission for only listing Heads Ups you have created.

Body Params

The parameters for ListHeadsUpManage

The parameters for ListHeadsUpManage

int32

Optional. Number of HeadsUps to be returned in a single request. Maximum
100. Non-positive values are ignored. The presence of next_page_token in
the response indicates that more results might be available. For example:
'20'

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.
For example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='

string
enum
Defaults to SORT_FIELD_UNKNOWN_UNSPECIFIED
  • SORT_FIELD_UNKNOWN_UNSPECIFIED: Defaults to published_at
Allowed:
string
enum
Defaults to SORT_DIRECTION_UNSPECIFIED

Optional. Direction for sorting.

Allowed:
string

Optional. Search value that will Search on Title & any other relevant
field.

filters
object

Optional. Filters consists of an array of filter for listing incidents

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago