Skip to main content
ConversationsVersion: v3

Get Conversation

GET/conversations/{conversationId}

Get the conversation details based on the conversation ID

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:conversations.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

conversationIdstringrequired

Conversation ID as string

Example:tDtDnQdgm2LXpyiqYvZ6

Response

Successful response

contactIdstringrequired

Unique identifier of the contact associated with this conversation

Example:ve9EPM428kjkvShlRW1KT
locationIdstringrequired

Unique identifier of the business location where this conversation takes place

Example:ve9EPM428kjkvShlRW1KT
deletedbooleanrequired

Flag indicating if this conversation has been moved to trash/deleted

Example:false
inboxbooleanrequired

Flag indicating if this conversation is currently in the main inbox view

Example:true
typenumberrequired

Communication channel type for this conversation: 1 (Phone), 2 (Email), 3 (Facebook Messenger), 4 (Review), 5 (Group SMS), 6 (Internal Chat - coming soon)

unreadCountnumberrequired

Number of messages in this conversation that have not been read by the user

Example:1
assignedTostring

Unique identifier of the team member currently responsible for handling this conversation

Example:ve9EPM428kjkvShlRW1KT
idstringrequired

Unique identifier for this specific conversation thread

Example:ve9EPM428kjkvShlRW1KT
starredboolean

Flag indicating if this conversation has been marked as important/starred by the user

Example:true