v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

Chats

Get Chat

Returns information about a chat by ID.

Note 'Chat' is a general name for all types of threads including Personal (user's own me-chat), Direct (one on one chat), Group (chat of 3-15 participants without specific name), Team (chat of 2 and more participants, with a specific name), Everyone (company chat including all employees, with a specific name)."

get/team-messaging/v1/chats/{chatId}

Path parameters

chatIdstring required

Internal identifier of a chat. If tilde (~) is specified, then /me (Personal) chat will be returned

Response

idstring

Internal identifier of a chat

type'Everyone' | 'Team' | 'Group' | 'Direct' | 'Personal'

Type of chat

publicboolean

For 'Team' chat type only. Team access level.

namestring

For 'Team','Everyone' chats types only. Chat name.

descriptionstring

For 'Team','Everyone' chats types only. Chat description.

status'Active' | 'Archived'

For 'Team' chat type only. Team status.

creationTimestring date-time

Chat creation datetime in ISO 8601 format

lastModifiedTimestring date-time

Chat last change datetime in ISO 8601 format