Skip to main content
GET
/
conversations
/
{conversation}
Get a conversation
curl --request GET \
  --url https://api.example.com/conversations/{conversation}
{
  "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
}

Path Parameters

conversation
integer
required

Conversation ID

Response

The conversation.

id
integer
Example:

1

type
string

Conversation type: direct or group

Example:

"direct"

title
string

Conversation title (group only)

Example:

""

created_at
integer<int64>

Unix timestamp

updated_at
integer<int64>

Unix timestamp

latest_message
object

Latest message in the conversation

mute_rule
integer | null

Mute rule ID or null

unread_message_count
integer
Example:

0

participants
object[]

Conversation participants

publish
object
archived_at
integer<int64> | null

When the auth user archived this conversation