---
title: Retrieve chat details - Beeper Developer Docs
---

Deprecated

GET/v0/get-chat

- Beeper Desktop API server http\://localhost:23373/v0/get-chat

Retrieve chat details including metadata, participants, and latest message. **Use [`GET /v1/chats/{chatID}`](/desktop-api-reference/resources/chats/methods/retrieve/index.md) instead.**

## Parameters

### Query Parameters

**chatID**

required

Unique identifier of the chat to retrieve. Not available for iMessage chats. Participants are limited by ‘maxParticipantCount’.

string

##### Example

```
!NCdzlIaMjZUmvmvyHU:beeper.com
```

Unique identifier of the chat to retrieve. Not available for iMessage chats. Participants are limited by ‘maxParticipantCount’.

**maxParticipantCount**

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

integer

default: 20 nullable >= -1 <= 500

##### Example

```
50
```

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

## Responses

### 200

Tool executed successfully

Select media typeapplication/json

object

**id**

required

Unique identifier of the chat (room/thread ID, same as id) across Beeper.

string

##### Example

```
!NCdzlIaMjZUmvmvyHU:beeper.com
```

**localChatID**

Local chat ID specific to this Beeper Desktop installation.

string

nullable

**accountID**

required

Beeper account ID this chat belongs to.

string

**network**

required

Display-only human-readable network name (e.g., ‘WhatsApp’, ‘Messenger’). You MUST use ‘accountID’ to perform actions.

string

##### Example

```
WhatsApp
```

**title**

required

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

string

**type**

required

Chat type: ‘single’ for direct messages, ‘group’ for group chats.

string

Allowed values: single group

**participants**

required

Chat participants information.

object

**items**

required

Participants returned for this chat (limited by the request; may be a subset).

Array\<object>

A person on or reachable through Beeper. Values are best-effort and can vary by network.

object

**id**

required

Stable Beeper user ID. Use as the primary key when referencing a person.

string

**username**

Human-readable handle if available (e.g., ‘@alice’). May be network-specific and not globally unique.

string

**phoneNumber**

User’s phone number in E.164 format (e.g., ‘+14155552671’). Omit if unknown.

string

**email**

Email address if known. Not guaranteed verified.

string

**fullName**

Display name as shown in clients (e.g., ‘Alice Example’). May include emojis.

string

**imgURL**

Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.

string

**cannotMessage**

True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.

boolean

**isSelf**

True if this user represents the authenticated account’s own identity.

boolean

**hasMore**

required

True if there are more participants than included in items.

boolean

**total**

required

Total number of participants in the chat.

integer

**lastActivity**

Timestamp of last activity. Chats with more recent activity are often more important.

string format: date-time

##### Example

```
2025-08-31T23:30:12.520Z
```

**unreadCount**

required

Number of unread messages.

integer

##### Example

```
3
```

**lastReadMessageSortKey**

Any of:

- [integer](#tab-panel-59)
- [string](#tab-panel-60)

integer

string

**isArchived**

True if chat is archived.

boolean

**isMuted**

True if chat notifications are muted.

boolean

**isPinned**

True if chat is pinned.

boolean

##### Example

```
{
  "id": "!instagram_mattwondra:local-instagram.localhost",
  "localChatID": "1229391",
  "accountID": "local-instagram_ba_eRfQMmnSNy_p7Ih7HL7RduRpKFU",
  "network": "Instagram",
  "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
}
```

### 400

Invalid request parameters

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 401

Access token is missing or invalid

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 403

Access token does not have the required scope

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 404

Resource not found

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 422

Unprocessable entity - validation error

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 429

Too many requests - rate limit exceeded

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string

### 500

Internal server error

Select media typeapplication/json

object

**error**

required

Error message

string

**code**

Error code

string

**details**

Additional error details

object

***key***

additional properties

string