Get Conversation

GET 
/conversations/:conversationId

Get the conversation details based on the conversation ID

Request

Version stringrequired

API Version

Available optionsv3

conversationId stringrequired

Conversation ID as string

application/json

Successful response

application/json

Schema

Schema

contactIdstringrequired

Unique identifier of the contact associated with this conversation

locationIdstringrequired

Unique identifier of the business location where this conversation takes place

deletedbooleanrequired

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

inboxbooleanrequired

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

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

assignedTostring

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

idstringrequired

Unique identifier for this specific conversation thread

starredboolean

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

Example (auto)

{
  "contactId": "ve9EPM428kjkvShlRW1KT",
  "locationId": "ve9EPM428kjkvShlRW1KT",
  "deleted": false,
  "inbox": true,
  "type": 0,
  "unreadCount": 1,
  "assignedTo": "ve9EPM428kjkvShlRW1KT",
  "id": "ve9EPM428kjkvShlRW1KT",
  "starred": true
}