Skip to main content
GET
Retrieve a greeting

Authorizations

Authorization
string
header
required

A secret key (dk_live_…). Scopes: conversations:read, contacts:read, contacts:write, meetings:read, analytics:read, events:read, webhooks:write, knowledge:read, knowledge:write, agent:read, agent:write, experiments:read, experiments:write, privacy:write, chat:write.

Path Parameters

id
string
required

Response

OK

id
string
required
Pattern: ^gr_
Example:

"gr_m3k8wq"

object
string
required
Allowed value: "link_greeting"
name
string
required
text
string
required
Example:

"Hi {first|there}, want to see what we could do for {company|your team}?"

buttons
object[]
required
agent_note
string | null
required

What the agent is told about people shown this greeting.

fields
string[]
required
preview
object
required

How many links use it.

Required range: -9007199254740991 <= x <= 9007199254740991
results
object
required

The last 30 days: people who opened it, how many of them chatted, and how many booked. Your team's and test visits are left out.