Retrieve chat details
GET /v0/get-chat
Retrieve chat details including metadata, participants, and latest message. Use GET /v1/chats/{chatID} instead.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Unique identifier of the chat to retrieve. Not available for iMessage chats. Participants are limited by ‘maxParticipantCount’.
Example
!NCdzlIaMjZUmvmvyHU:beeper.comUnique identifier of the chat to retrieve. Not available for iMessage chats. Participants are limited by ‘maxParticipantCount’.
Maximum number of participants to return. Use -1 for all; otherwise 0–500. Defaults to 20.
Example
50Maximum number of participants to return. Use -1 for all; otherwise 0–500. Defaults to 20.
Responses
Section titled “ Responses ”Tool executed successfully
object
Unique identifier of the chat (room/thread ID, same as id) across Beeper.
Example
!NCdzlIaMjZUmvmvyHU:beeper.comLocal chat ID specific to this Beeper Desktop installation.
Beeper account ID this chat belongs to.
Display-only human-readable network name (e.g., ‘WhatsApp’, ‘Messenger’). You MUST use ‘accountID’ to perform actions.
Example
WhatsAppDisplay title of the chat as computed by the client/server.
Chat type: ‘single’ for direct messages, ‘group’ for group chats.
Chat participants information.
object
Participants returned for this chat (limited by the request; may be a subset).
A person on or reachable through Beeper. Values are best-effort and can vary by network.
object
Stable Beeper user ID. Use as the primary key when referencing a person.
Human-readable handle if available (e.g., ‘@alice’). May be network-specific and not globally unique.
User’s phone number in E.164 format (e.g., ‘+14155552671’). Omit if unknown.
Email address if known. Not guaranteed verified.
Display name as shown in clients (e.g., ‘Alice Example’). May include emojis.
Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.
True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.
True if this user represents the authenticated account’s own identity.
True if there are more participants than included in items.
Total number of participants in the chat.
Timestamp of last activity. Chats with more recent activity are often more important.
Example
2025-08-31T23:30:12.520ZNumber of unread messages.
Example
3True if chat is archived.
True if chat notifications are muted.
True if chat is pinned.
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}Invalid request parameters
object
Error message
Error code
Additional error details
object
Access token is missing or invalid
object
Error message
Error code
Additional error details
object
Access token does not have the required scope
object
Error message
Error code
Additional error details
object
Resource not found
object
Error message
Error code
Additional error details
object
Unprocessable entity - validation error
object
Error message
Error code
Additional error details
object
Too many requests - rate limit exceeded
object
Error message
Error code
Additional error details
object
Internal server error
object
Error message
Error code
Additional error details