List Heads Up users

post

https://api.safetyculture.io/announcements/v1/announcement:ListHeadsUpUsers

List the assignees of a Heads Up, and displays the details for each assignee as well as their completion status to the Heads Up.

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

Body Params

The parameters for ListHeadsUpUsers

heads_up_id

string

required

UUID used to look up HeadsUp.

page_size

int32

Optional. Number of HeadsUps to be returned in a single request. Maximum
100. Non-positive values are ignored.

offset

int32

Number of users to offset, used with page_size indicates what page is
displayed

sort_field

string

enum

Defaults to SORT_FIELD_UNKNOWN_UNSPECIFIED

Allowed:

sort_direction

string

enum

Defaults to SORT_DIRECTION_UNSPECIFIED

Optional. Direction for sorting.

Allowed:

search_value

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

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.