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

External APIs for registrants management

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

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

This API exposes 4 operations across 2 paths, and defines 19 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.

4 operations 2 paths 19 schemas 1 DELETE2 GET1 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 Registrants 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 4

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

Registrants 4

External APIs for registrants management

GET
/webinar/registration/v1/sessions/{sessionId}/registrants
List Session Registrants
rcwRegListRegistrants 4 params → 200400403404500
POST
/webinar/registration/v1/sessions/{sessionId}/registrants
Create Registrant
rcwRegCreateRegistrant 1 param body → 201400403404409500
GET
/webinar/registration/v1/sessions/{sessionId}/registrants/{registrantId}
Get Registrant
rcwRegGetRegistrant 3 params → 200403404500
DELETE
/webinar/registration/v1/sessions/{sessionId}/registrants/{registrantId}
Delete Registrant
rcwRegDeleteRegistrant 2 params → 204403404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are RcwPagingForwardModel (4 properties), RegistrantListResource (2 properties), ApiError (2 properties), RcwBaseContactModel (2 properties). Each schema is shown below with its type and property counts.

ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
RegQuestionBaseModel
object
1 property 1 required
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
VariableAnswerModel
RegistrantListResource
object
2 properties 2 required
RcwEmailModel
string
User's contact email
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
RegistrantModelWithQuestionnaire
RcwResourceBaseModel
RcwPagingForwardModel
object
4 properties 2 required
RcwImmutableResourceIdModel
object
1 property
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
RegAnswerModel
RegistrantModelResponsePostWithQuestionnaire
RegistrantBaseModelWithQuestionnaire
RcwBaseContactModel
object
2 properties
RegistrantMinimalModel
FixedAnswerModel
RegistrantBaseModel

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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