GET
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
/
{conversation_id}
Conversation Details
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id} \
  --header 'api_access_token: <api-key>'
{
  "id": 123,
  "messages": [
    {
      "id": 123,
      "content": "<string>",
      "account_id": 123,
      "inbox_id": 123,
      "conversation_id": 123,
      "message_type": 0,
      "created_at": 123,
      "updated_at": 123,
      "private": true,
      "status": "sent",
      "source_id": "<string>",
      "content_type": "text",
      "content_attributes": {},
      "sender_type": "contact",
      "sender_id": 123,
      "external_source_ids": {},
      "additional_attributes": {},
      "processed_message_content": "<string>",
      "sentiment": {},
      "conversation": {},
      "attachment": {},
      "sender": {}
    }
  ],
  "account_id": 123,
  "uuid": "<string>",
  "additional_attributes": {},
  "agent_last_seen_at": 123,
  "assignee_last_seen_at": 123,
  "can_reply": true,
  "contact_last_seen_at": 123,
  "custom_attributes": {},
  "inbox_id": 123,
  "labels": [
    "<string>"
  ],
  "muted": true,
  "snoozed_until": 123,
  "status": "open",
  "created_at": 123,
  "updated_at": 123,
  "timestamp": "<string>",
  "first_reply_created_at": 123,
  "unread_count": 123,
  "last_non_activity_message": {
    "id": 123,
    "content": "<string>",
    "account_id": 123,
    "inbox_id": 123,
    "conversation_id": 123,
    "message_type": 0,
    "created_at": 123,
    "updated_at": 123,
    "private": true,
    "status": "sent",
    "source_id": "<string>",
    "content_type": "text",
    "content_attributes": {},
    "sender_type": "contact",
    "sender_id": 123,
    "external_source_ids": {},
    "additional_attributes": {},
    "processed_message_content": "<string>",
    "sentiment": {},
    "conversation": {},
    "attachment": {},
    "sender": {}
  },
  "last_activity_at": 123,
  "priority": "<string>",
  "waiting_since": 123,
  "sla_policy_id": 123,
  "applied_sla": {},
  "sla_events": [
    {}
  ],
  "meta": {
    "sender": {
      "additional_attributes": {},
      "availability_status": "<string>",
      "email": "<string>",
      "id": 123,
      "name": "<string>",
      "phone_number": "<string>",
      "blocked": true,
      "identifier": "<string>",
      "thumbnail": "<string>",
      "custom_attributes": {},
      "last_activity_at": 123,
      "created_at": 123
    },
    "channel": "<string>",
    "assignee": {
      "id": 123,
      "access_token": "<string>",
      "account_id": 123,
      "available_name": "<string>",
      "avatar_url": "<string>",
      "confirmed": true,
      "display_name": "<string>",
      "message_signature": "<string>",
      "email": "<string>",
      "hmac_identifier": "<string>",
      "inviter_id": 123,
      "name": "<string>",
      "provider": "<string>",
      "pubsub_token": "<string>",
      "role": "agent",
      "ui_settings": {},
      "uid": "<string>",
      "type": "<string>",
      "custom_attributes": {},
      "accounts": [
        {
          "id": 123,
          "name": "<string>",
          "status": "<string>",
          "active_at": "2023-11-07T05:31:56Z",
          "role": "administrator",
          "permissions": [
            "<string>"
          ],
          "availability": "<string>",
          "availability_status": "<string>",
          "auto_offline": true,
          "custom_role_id": 123,
          "custom_role": {}
        }
      ]
    },
    "hmac_verified": true
  }
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

​
conversation_id
integer
required

The numeric ID of the conversation

Response

Success

​
id
number

ID of the conversation

​
messages
object[]
​
account_id
number

Account Id

​
uuid
string

UUID of the conversation

​
additional_attributes
object

The object containing additional attributes related to the conversation

​
agent_last_seen_at
number

The last activity at of the agent

​
assignee_last_seen_at
number

The last activity at of the assignee

​
can_reply
boolean

Whether the conversation can be replied to

​
contact_last_seen_at
number

The last activity at of the contact

​
custom_attributes
object

The object to save custom attributes for conversation, accepts custom attributes key and value

​
inbox_id
number

ID of the inbox

​
labels
string[]

The labels of the conversation

​
muted
boolean

Whether the conversation is muted

​
snoozed_until
number

The time at which the conversation will be unmuted

​
status
enum<string>

The status of the conversation

Available options:
open,
resolved,
pending
​
created_at
number

The time at which conversation was created

​
updated_at
number

The time at which conversation was updated

​
timestamp
string

The time at which conversation was created

​
first_reply_created_at
number

The time at which the first reply was created

​
unread_count
number

The number of unread messages

​
last_non_activity_message
object
​
last_activity_at
number

The last activity at of the conversation

​
priority
string

The priority of the conversation

​
waiting_since
number

The time at which the conversation was waiting

​
sla_policy_id
number

The ID of the SLA policy

​
applied_sla
object

The applied SLA

​
sla_events
object[]

SLA event objects

​
meta
object