Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Teams API

The Teams API from RingCentral — 9 operation(s) for teams.

RingCentral Teams API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Teams. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 9 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

13 operations 9 paths 9 schemas 1 DELETE3 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Teams API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 3 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Teams 13
GET
/team-messaging/v1/everyone
Get Everyone Chat
readGlipEveryoneNew → 200404
PATCH
/team-messaging/v1/everyone
Update Everyone Chat
patchGlipEveryoneNew body → 200404
GET
/team-messaging/v1/teams
List Teams
listGlipTeamsNew 2 params → 200
POST
/team-messaging/v1/teams
Create Team
createGlipTeamNew body → 201400
GET
/team-messaging/v1/teams/{chatId}
Get Team
readGlipTeamNew 1 param → 200404
DELETE
/team-messaging/v1/teams/{chatId}
Delete Team
deleteGlipTeamNew 1 param → 204403404
PATCH
/team-messaging/v1/teams/{chatId}
Update Team
patchGlipTeamNew 1 param body → 200400403404
POST
/team-messaging/v1/teams/{chatId}/remove
Remove Team Members
removeGlipTeamMembersNew 1 param body → 204400403404
POST
/team-messaging/v1/teams/{chatId}/join
Join Team
joinGlipTeamNew 1 param → 204205403404
POST
/team-messaging/v1/teams/{chatId}/archive
Archive Team
archiveGlipTeamNew 1 param → 204205403404
POST
/team-messaging/v1/teams/{chatId}/unarchive
Unarchive Team
unarchiveGlipTeamNew 1 param → 204205403404
POST
/team-messaging/v1/teams/{chatId}/leave
Leave Team
leaveGlipTeamNew 1 param → 204205403404
POST
/team-messaging/v1/teams/{chatId}/add
Add Team Members
addGlipTeamMembersNew 1 param body → 204400403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are TMTeamInfo (8 properties), EveryoneTeamInfo (6 properties), TMCreateTeamRequest (4 properties), TMUpdateTeamRequest (3 properties). Each schema is shown below with its type and property counts.

TMAddTeamMembersRequest
object
1 property 1 required
EveryoneTeamInfo
object
6 properties
TMTeamList
object
2 properties 1 required
TMTeamInfo
object
8 properties
TMNavigationInfo
object
2 properties
UpdateEveryoneTeamRequest
object
2 properties
TMUpdateTeamRequest
object
3 properties
TMCreateTeamRequest
object
4 properties 1 required
TMRemoveTeamMembersRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-teams-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API