Get the conversation details based on the conversation ID

http
GET https://services.leadconnectorhq.com/conversations/{conversationId}

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
conversationIdstringYestDtDnQdgm2LXpyiqYvZ6Conversation ID as string

Responses

200 - Successful response
  • contactId (string, required): Unique identifier of the contact associated with this conversation Example: ve9EPM428kjkvShlRW1KT

  • locationId (string, required): Unique identifier of the business account where this conversation takes place Example: ve9EPM428kjkvShlRW1KT

  • deleted (boolean, required): Flag indicating if this conversation has been moved to trash/deleted Example: False

  • inbox (boolean, required): Flag indicating if this conversation is currently in the main inbox view Example: True

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

  • unreadCount (number, required): Number of messages in this conversation that have not been read by the user Example: 1

  • assignedTo (string): Unique identifier of the team member currently responsible for handling this conversation Example: ve9EPM428kjkvShlRW1KT

  • id (string, required): Unique identifier for this specific conversation thread Example: ve9EPM428kjkvShlRW1KT

  • starred (boolean): Flag indicating if this conversation has been marked as important/starred by the user Example: True

json
{
  "contactId": "ve9EPM428kjkvShlRW1KT",
  "locationId": "ve9EPM428kjkvShlRW1KT",
  "deleted": false,
  "inbox": true,
  "type": 0,
  "unreadCount": 1,
  "assignedTo": "ve9EPM428kjkvShlRW1KT",
  "id": "ve9EPM428kjkvShlRW1KT",
  "starred": true
}
400 - Bad Request
json
{}
401 - Unauthorized
json
{}

Example

curl -X GET 'https://services.leadconnectorhq.com/conversations/YOUR_conversationId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?