GET
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations
{
  "data": {
    "meta": {
      "mine_count": 123,
      "unassigned_count": 123,
      "assigned_count": 123,
      "all_count": 123
    },
    "payload": [
      {
        "id": 123,
        "messages": [
          {
            "content": "<string>",
            "content_type": "text",
            "content_attributes": {},
            "message_type": "incoming",
            "created_at": 123,
            "private": true,
            "attachment": {},
            "sender": {},
            "conversation_id": 123
          }
        ],
        "account_id": 123,
        "inbox_id": 123,
        "status": "open",
        "timestamp": "<string>",
        "contact_last_seen_at": "<string>",
        "agent_last_seen_at": "<string>",
        "unread_count": 123,
        "additional_attributes": {},
        "custom_attributes": {
          "attribute_key": "attribute_value",
          "priority_conversation_number": 3
        },
        "meta": {
          "sender": {
            "id": 123,
            "name": "<string>",
            "thumbnail": "<string>",
            "channel": "<string>"
          },
          "assignee": {
            "id": 123,
            "uid": "<string>",
            "name": "<string>",
            "available_name": "<string>",
            "display_name": "<string>",
            "email": "<string>",
            "account_id": 123,
            "role": "agent",
            "confirmed": true,
            "custom_attributes": {},
            "accounts": [
              {
                "id": 123,
                "name": "<string>",
                "role": "administrator"
              }
            ]
          }
        }
      }
    ]
  }
}

Path Parameters

​
account_id
integer
required

The numeric ID of the account

Query Parameters

​
assignee_type
enum<string>
default:all

Filter conversations by assignee type.

Available options:
me,
unassigned,
all,
assigned
​
status
enum<string>
default:open

Filter by conversation status.

Available options:
all,
open,
resolved,
pending,
snoozed
​
q
string

Filters conversations with messages containing the search term

​
inbox_id
integer
​
team_id
integer
​
labels
string[]
​
page
integer
default:1

paginate through conversations

Response

200
application/json
Success

The response is of type object.