v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB

Heads Up

List Heads Ups

post/announcements/v1/announcement:ListHeadsUpManage

Request body

page_sizeinteger

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'

page_tokenstring

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='

sort_field'SORT_FIELD_UNKNOWN_UNSPECIFIED' | 'SORT_FIELD_PUBLISHED_AT' | 'SORT_FIELD_TITLE'

SORT_FIELD_UNKNOWN_UNSPECIFIED: Defaults to published_at

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.

next_page_tokenstring

If there are more results than those appearing in this response, then next_page_token is included. If empty then there are no more results. To get the next set of results, call the same method again using the value of next_page_token as page_token. For Example: 'ODFBMzQ3MDYtNzQxNy00RDZGLThDNjE1MEFDMkM4MTQ3NDQ='

totalinteger

Total number of HeadsUps found