Skip to main content
GET
Get a recipient in a conversation

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

conversation_id
string
required
id
string
required

Response

The recipient.

A recipient in a conversation. Company members carry status and last_online; other recipients, such as contacts and bots, carry email and phone instead.

avatar_background
string | null
required

Hex color (without #) behind the recipient's avatar.

avatar_url
string | null
required

Thumbnail URL of the recipient's avatar. Null for a discarded recipient.

blocked
boolean | null
required

Whether you have blocked this recipient.

conversation_messaging_enabled?
boolean | null
required

Whether in-app messaging is enabled for this recipient in the conversation.

country_name
string | null
required

The recipient's country.

discarded_at
string<date-time> | null
required

When the recipient was discarded, or null while active.

first_name
string | null
required
id
integer
required

The recipient ID.

image_url
string | null
required

Full-size avatar image URL. Null for a discarded recipient.

last_name
string | null
required
left_conversation_at
string<date-time> | null
required

When the recipient left or was removed from the conversation, or null while still in it.

pro_user
boolean | null
required

Whether the member's membership carries a paid plan.

receivable_id
integer
required

ID of the member, contact, or bot this recipient represents.

receivable_type
string
required

What the recipient represents, such as a company member, a contact, or a bot.

email
string | null

The recipient's email address. Omitted for company members.

last_online
string<date-time> | null

When the member was last online. Present only for company members.

phone
string | null

The recipient's phone number. Omitted for company members.

status
string | null

Presence status for company members: online, away, or offline. Present only for company members.