RingCentral icon

RingCentral

Interact with RingCentral API - SMS, Voice, Fax, Meetings, and more

Team Messaging → Get Chats

AI-generated

Summary

Fetch team messaging chats from RingCentral with optional type filtering and pagination controls.

Inputs

  • authMode — Choose whether to use saved predefined credentials or supply an OAuth 2.0 access token dynamically.
  • accessToken — OAuth 2.0 access token used when dynamic authentication mode is selected.
  • serverUrl — Target RingCentral API environment (Production or Sandbox) when dynamic authentication mode is selected.
  • returnAll — Whether to fetch all available chats or limit the returned results.
  • limit — Maximum number of chat records to retrieve when Return All is disabled (up to 250).
  • filters — Optional filters, such as limiting results by chat type (Direct, Group, Team, or Personal Chat).

Output shape

a list of items

Returns an array of chat objects. When Return All is enabled, pagination is handled automatically up to the API limit.

Examples

Example 1: Get a list of all team messaging chats

Set Authentication Mode to 'Predefined Credentials' and enable Return All.

Example 2: Retrieve up to 50 team-type chats

Set Return All to false, set Limit to 50, and under Filters set Type to 'Team'.

Links

Discussion