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 Tasks API

The Tasks API from RingCentral — 3 operation(s) for tasks.

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

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

This API exposes 6 operations across 3 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.

6 operations 3 paths 9 schemas 1 DELETE2 GET1 PATCH2 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 Tasks 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 6

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

Tasks 6
GET
/team-messaging/v1/tasks/{taskId}
Get Task
readTaskNew 1 param → 200400403404
DELETE
/team-messaging/v1/tasks/{taskId}
Delete Task
deleteTaskNew 1 param → 204403404
PATCH
/team-messaging/v1/tasks/{taskId}
Update Task
patchTaskNew 1 param body → 200400403404
POST
/team-messaging/v1/tasks/{taskId}/complete
Complete Task
completeTaskNew 1 param body → 204400403404
GET
/team-messaging/v1/chats/{chatId}/tasks
List Chat Tasks
listChatTasksNew 10 params → 200400403404
POST
/team-messaging/v1/chats/{chatId}/tasks
Create Task
createTaskNew 1 param body → 201400403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are TMTaskInfo (18 properties), TMCreateTaskRequest (10 properties), TMUpdateTaskRequest (10 properties), TaskAttachment (4 properties). Each schema is shown below with its type and property counts.

TMTaskInfo
object
18 properties
TMCreateTaskRequest
object
10 properties 2 required
TMTaskList
object
2 properties
TaskRecurrenceInfo
object
Task information
4 properties
TaskAttachment
object
4 properties
TMNavigationInfo
object
2 properties
TMCompleteTaskRequest
object
3 properties
TMAttachmentInfo
object
2 properties
TMUpdateTaskRequest
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-tasks-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