Skip to main content
POST
Get greeting
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
id
integer
required

The greeting ID.

Response

200 - application/json

Greeting details.

id
integer

The greeting ID.

type
enum<string>

The greeting type.

  • normal — displayed on every visit.
  • announcement — displayed once per visitor.
Available options:
normal,
announcement
active
boolean

True when the greeting is active.

active_from
string<date-time>

The ISO 8601 date-time when the greeting becomes active (if set).

active_until
string<date-time>

The ISO 8601 date-time when the greeting stops being active (if set).

name
string

The greeting name.

group
integer | null

The ID of the group the greeting is assigned to.

rules
object[]

An array of rule objects that define when the greeting should be triggered.

Maximum array length: 10
properties
object

The additional properties for the greeting as key-value pairs.

rich_message
object

The rich message content of the greeting.