Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Heads Up

List Heads Up users

post/announcements/v1/announcement:ListHeadsUpUsers

Request body

heads_up_idstring required

UUID used to look up HeadsUp.

page_sizeinteger

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

offsetinteger

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

sort_field'SORT_FIELD_UNKNOWN_UNSPECIFIED' | 'SORT_FIELD_NAME' | 'SORT_FIELD_EMAIL' | 'SORT_FIELD_VIEWED_AT' | 'SORT_FIELD_ACKNOWLEDGED_AT'
  • SORT_FIELD_UNKNOWN_UNSPECIFIED: Defaults to NAME
sort_direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'
search_valuestring

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

Response

A successful response.

totalinteger

Total number of users found