APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Calling
Contact Center
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMeetings Test FileMembershipsMessagesMock API for integration testOrganizationsPeoplePlacesRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWebhooksWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog

Query Meeting Registrants

Meeting's host and cohost can query the list of registrants for a meeting with a specified meeting Id and registrants email.

POST/v1/meetings/{meetingId}/registrants/query
URI Parameters
meetingId
stringrequired

Unique identifier for the meeting.

Query Parameters
max
number

Limit the maximum number of registrants in the response, up to 100.

Default: 10
Body Parameters
status
enum

registrant's satus

approved
string

registrant have been approved

pending
string

registrant is in pending list wait host / cohost audit

rejected
string

registrant have been rejected by host / cohost

orderType
enum

registrant order direction

DESC
string
ASC
string
orderBy
enum

registrant order field, default order by registrationTime

firstName
string

registrant's first name

lastName
string

registrant's last name

status
string

registrant's satus

email
string

registrant's email

emails
array[string]required

registrants email list

Possible values: bob@cisco.com
Response Properties
items
array[Registrant]

registrants array

registrantId
string

new Registrant's Id

status
enum

new registrant's satus

approved
string

registrant have been approved

pending
string

registrant is in pending list wait host / cohost audit

rejected
string

registrant have been rejected by host / cohost

firstName
string

registrant's first name

lastName
string

registrant's last name

email
string

registrant's email

jobTitle
string

registrant's job title

companyName
string

registrant's company

address1
string

registrant's address line 1

address2
string

registrant's address line 2

city
string

registrant's city name

state
string

registrant's state

zipCode
number

registrant's zip code

countryRegion
string

registrant's country or region

workPhone
string

registrant's work phone number

fax
string

registrant's country or region

registrationTime
string

new registrant's create date time

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
POST
/v1/meetings//registrants/query{?max}
Log in to try the API.
Header
Query Parameters
  • Limit the maximum number of registrants in the response, up to 100.
Body
  • registrant's satus
  • registrant order direction
  • registrant order field, default order by registrationTime
  • registrants email list
https://webexapis.com/v1/meetings/560d7b784f5143e3be2fc3064a5c4999/registrants/query?max=1000
{
  "status": "pending",
  "orderType": "DESC",
  "orderBy": "registrationTime",
  "emails": [
    "bob@cisco.com"
  ]
}
200 / OK
{
  "items": [
    {
      "registrantId": "123456",
      "status": "pending",
      "firstName": "bob",
      "lastName": "Lee",
      "email": "bob@cisco.com",
      "jobTitle": "manager",
      "companyName": "cisco",
      "address1": "address1 string",
      "address2": "address2 string",
      "city": "New York",
      "state": "New York",
      "zipCode": 123456,
      "countryRegion": "America",
      "workPhone": "+1 123456",
      "fax": "123456",
      "registrationTime": "2021-09-07T09:29:13+08:00"
    }
  ]
}