Skip to main content
GET
Retrieve Conversation

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Path Parameters

id
string
required

Conversation ID.

Response

Requested Conversation

Response model for a conversation.

id
string
required

Unique identifier of the object in the database.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

agent_id
string
required

ID of agent managing the conversation.

status
ToStartConversationStatus · object
required

Status for conversation that has not yet started.

user_name
string | null

Name of the user.

user_email
string | null

Email of the user.

tags
Tags · object

Tags for the conversation.