Skip to main content
GET
/
api
/
v1
/
chats
/
{chatId}
Get chat details
curl --request GET \
  --url http://localhost:{port}/api/v1/chats/{chatId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "isGroup": true,
  "unreadCount": 123,
  "timestamp": 123,
  "pinned": true,
  "muted": true,
  "archived": true,
  "description": "<string>",
  "owner": "<string>",
  "participants": [
    {
      "id": "<string>",
      "name": "<string>",
      "isAdmin": true,
      "isModerator": true
    }
  ],
  "groupSettings": {
    "sendMessages": "all",
    "editInfo": "all"
  }
}

Authorizations

Authorization
string
header
required

JWT token authentication

Path Parameters

chatId
string
required

ID of the chat to retrieve

Response

Chat details retrieved successfully

id
string
required

Chat ID

name
string
required

Chat name

isGroup
boolean
required

Whether the chat is a group

unreadCount
integer

Number of unread messages

timestamp
number

Timestamp of the last message

pinned
boolean

Whether the chat is pinned

muted
boolean

Whether the chat is muted

archived
boolean

Whether the chat is archived

description
string

Chat description (for groups)

owner
string

Group owner ID

participants
object[]

Group participants

groupSettings
object

Group settings