Conversations List

GET

/api/v1/accounts/{account_id}/conversations

Conversations

List all the conversations with pagination

Response Example

200 - Example 1

{
    "data": {
        "meta": {
            "mine_count": 0,
            "unassigned_count": 0,
            "assigned_count": 0,
            "all_count": 0
        },
        "payload": [
            {
                "id": 0,
                "messages": [
                    {
                        "content": "string",
                        "content_type": "text",
                        "content_attributes": {},
                        "message_type": "incoming",
                        "created_at": 0,
                        "private": true,
                        "attachment": {},
                        "sender": {},
                        "conversation_id": 0
                    }
                ],
                "account_id": 0,
                "inbox_id": 0,
                "status": "open",
                "timestamp": "string",
                "contact_last_seen_at": "string",
                "agent_last_seen_at": "string",
                "unread_count": 0,
                "additional_attributes": {},
                "custom_attributes": {
                    "attribute_key": "attribute_value",
                    "priority_conversation_number": 3
                },
                "meta": {
                    "sender": {
                        "id": 0,
                        "name": "string",
                        "thumbnail": "string",
                        "channel": "string"
                    },
                    "assignee": {
                        "id": 0,
                        "uid": "string",
                        "name": "string",
                        "available_name": "string",
                        "display_name": "string",
                        "email": "string",
                        "account_id": 0,
                        "role": "agent",
                        "confirmed": true,
                        "custom_attributes": {},
                        "accounts": [
                            {
                                "id": 0,
                                "name": "string",
                                "role": "administrator"
                            }
                        ]
                    }
                }
            }
        ]
    }
}

Request

Path Params

account_id

string

required

Query Params

assignee_type

enum<string>

optional

Filter conversations by assignee type.

Allowed values:

meunassignedallassigned

Default:

all

status

enum<string>

optional

Filter by conversation status.

Allowed values:

allopenresolvedpendingsnoozed

Default:

open

string

optional

Filters conversations with messages containing the search term

inbox_id

integer

optional

team_id

integer

optional

labels

array[string]

optional

page

integer

optional

paginate through conversations

Default:

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

data

object

optional