v10

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-02-242335121.2 KB

Chats

Retrieve chat details

Retrieve chat details including metadata, participants, and latest message

get/v1/chats/{chatID}

Path parameters

chatIDstring required

Unique identifier of the chat.

Example:!NCdzlIaMjZUmvmvyHU:beeper.com

Unique identifier of the chat.

Query parameters

maxParticipantCountinteger nullable

Maximum number of participants to return. Use -1 for all; otherwise 0–500. Defaults to all (-1).

Example:50

Maximum number of participants to return. Use -1 for all; otherwise 0–500. Defaults to all (-1).

Response

Request executed successfully

idstring required

Unique identifier of the chat across Beeper.

localChatIDstring nullable

Local chat ID specific to this Beeper Desktop installation.

accountIDstring required

Account ID this chat belongs to.

titlestring required

Display title of the chat as computed by the client/server.

type'single' | 'group' required

Chat type: 'single' for direct messages, 'group' for group chats.

lastActivitystring date-time

Timestamp of last activity.

unreadCountinteger required

Number of unread messages.

lastReadMessageSortKeystring

Last read message sortKey.

isArchivedboolean

True if chat is archived.

isMutedboolean

True if chat notifications are muted.

isPinnedboolean

True if chat is pinned.

Example response

{
  "id": "!instagram_mattwondra:local-instagram.localhost",
  "localChatID": "1229391",
  "accountID": "local-instagram_ba_eRfQMmnSNy_p7Ih7HL7RduRpKFU",
  "title": "Matt Wondra",
  "type": "single",
  "participants": {
    "items": [
      {
        "id": "@mattwondra:local-instagram.localhost",
        "username": "mattwondra",
        "fullName": "Matt Wondra",
        "cannotMessage": false,
        "isSelf": false
      },
      {
        "id": "@batuhan:local-instagram.localhost",
        "username": "batuhan",
        "fullName": "Batuhan İçöz",
        "cannotMessage": false,
        "isSelf": true
      }
    ],
    "hasMore": false,
    "total": 2
  },
  "lastActivity": "2025-08-31T19:41:41.000Z",
  "unreadCount": 0,
  "lastReadMessageSortKey": "449706228480",
  "isArchived": false,
  "isMuted": false,
  "isPinned": false
}