---
title: "Retrieve chat details"
method: GET
path: "/v1/chats/{chatID}"
tags: ["Chats"]
---

# Retrieve chat details

`GET /v1/chats/{chatID}`

Retrieve chat details including metadata, participants, and latest message

## Path parameters

- `chatID` string, required — Unique identifier of the chat.

## Query parameters

- `maxParticipantCount` integer, nullable — Maximum number of participants to return. Use -1 for all; otherwise 0–500. Defaults to all (-1).

## Response `200`

Request executed successfully

- Chat
  - `id` string, required — Unique identifier of the chat across Beeper.
  - `localChatID` string, nullable — Local chat ID specific to this Beeper Desktop installation.
  - `accountID` string, required — Account ID this chat belongs to.
  - `title` string, 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.
  - `participants` object, required — Chat participants information.
    - `items` object[], required — Participants returned for this chat (limited by the request; may be a subset).
      - `id` string, required — Stable Beeper user ID. Use as the primary key when referencing a person.
      - `username` string — Human-readable handle if available (e.g., '@alice'). May be network-specific and not globally unique.
      - `phoneNumber` string — User's phone number in E.164 format (e.g., '+14155552671'). Omit if unknown.
      - `email` string — Email address if known. Not guaranteed verified.
      - `fullName` string — Display name as shown in clients (e.g., 'Alice Example'). May include emojis.
      - `imgURL` string — Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.
      - `cannotMessage` boolean — True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.
      - `isSelf` boolean — True if this user represents the authenticated account's own identity.
    - `hasMore` boolean, required — True if there are more participants than included in items.
    - `total` integer, required — Total number of participants in the chat.
  - `lastActivity` string, date-time — Timestamp of last activity.
  - `unreadCount` integer, required — Number of unread messages.
  - `lastReadMessageSortKey` string — Last read message sortKey.
  - `isArchived` boolean — True if chat is archived.
  - `isMuted` boolean — True if chat notifications are muted.
  - `isPinned` boolean — True if chat is pinned.

## Other responses

- `400` — Invalid request parameters
- `401` — Access token is missing or invalid
- `403` — Access token does not have the required scope
- `404` — Resource not found
- `422` — Unprocessable entity - validation error
- `429` — Too many requests - rate limit exceeded
- `500` — Internal server error

---

[API](https://skmtc.net/beeper/apis/beeper-desktop-api.md) · [All operations](https://skmtc.net/beeper/apis/beeper-desktop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beeper/beeper-desktop-api/revisions/5a8ac7b545c4/schema)
