RIringcentral
Registrants

Get Registrant

Returns a Registrant by ID.

A caller must be an authorized user: either a host of the webinar or an IT Admin: a user from host's account with "WebinarSettings" permission.

get/webinar/registration/v1/sessions/{sessionId}/registrants/{registrantId}

Request

Path parameters

sessionIdstring required

Identifier of the Session.

registrantIdstring required

Identifier of the Session Registrant

Query parameters

includeQuestionnaireboolean

Indicates if registrant's "questionnaire" should be returned

Response

Successful response

idstring

Internal object ID

creationTimestring date-time required

Object creation time

lastModifiedTimestring date-time required

Object last modification time

firstNamestring required

First (given) name

lastNamestring required

Last (family) name

emailstring email required

User's contact email

joinUristring uri

The personalized URI for this registrant to join the Webinar

cancellationUristring uri

The personalized URI for this registrant to cancel the registration

registeredPostWebinarboolean nullable

Indicates if the registrant was registered to on-demand webinar

visitorIdstring

Visitor ID passed from registration page

externalIdstring

ID of a registrant passed from external system

registrationTimestring date-time

Registration time (can be earlier than "creationTime" due to indirect persistence)

ipAddressstring ipv4

IP address of the registrant's user agent

sourcestring

Registration channel source (coming from registration URI)

participantIdstring

ID of session participant (from Runtime Service - if this registrant attended the webinar)

Example response

{
  "id": "78654321",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "joinUri": "https://v.ringcentral.com/w/a/join/iuyef77fsj473wn10ashjfk34",
  "cancellationUri": "https://abcde12345.webinar.ringcentral.com/register?jlt=iuyef77fsj473wn10ashjfk34&action=cancel",
  "questionnaire": [
    {
      "questionId": "123456789"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.