Skip to main content
POST
List greetings
Required scopes: greetings:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
groups
integer[]

An array of group IDs to filter greetings. Defaults to all accessible groups. Cannot be used with page_id.

page_id
string

The page ID for pagination. When provided, groups and limit parameters are ignored as they are encoded in the page ID. Cannot be used with groups or limit.

limit
integer
default:100

The number of greetings per page. Cannot be used with page_id.

Required range: x <= 100

Response

200 - application/json

A list of greetings.

greetings
object[]

An array of greeting objects.

found_greetings
integer

The total number of greetings.

next_page_id
string

The page ID for the next page of results. Returned only if more results are available.