Skip to main content
GET
/
conversations
List conversations
curl --request GET \
  --url https://api.example.com/conversations
{
  "data": [
    {
      "id": 1,
      "type": "direct",
      "title": "",
      "created_at": 123,
      "updated_at": 123,
      "latest_message": {},
      "mute_rule": 123,
      "unread_message_count": 0,
      "participants": [
        {
          "id": 1,
          "first_name": "John",
          "last_name": "Doe",
          "name": "John Doe",
          "title": "Manager",
          "active": true,
          "avatar": {},
          "archived_at": 123,
          "participant_type": "<string>",
          "subtext": "Manager - HQ (Sales)",
          "department": {
            "id": 10,
            "name": "Sales"
          },
          "unit": {
            "id": 5,
            "name": "HQ"
          }
        }
      ],
      "publish": {
        "created_at": 123,
        "updated_at": 123
      },
      "archived_at": 123
    }
  ]
}

Query Parameters

status
enum<string>

Filter by conversation status

Available options:
unread,
archived
keyword
string

Search in conversation title or participant names

participants
integer[]

Filter by exact set of participant user IDs (finds or excludes conversations with exactly these users)

limit
integer
default:10

Number of items per page (1–100)

page
integer

Page number for pagination

Response

200 - application/json

Paginated list of conversations.

data
object[]