Meetings - List Meetings | Webex for Developers

List Meetings

Retrieves details for meetings with a specified meeting number, web link, meeting type, etc. Please note that there are various products in the Webex Suite such as Meetings and Events. Currently, only meetings of the Meetings product are supported by this API, meetings of others in the suite are not supported. Ad-hoc meetings created by Create a Meeting with adhoc of true and a roomId will not be listed, but the ended and ongoing ad-hoc meeting instances will be listed.

If meetingNumber is specified, the operation returns an array of meeting objects specified by the meetingNumber. Each object in the array can be a scheduled meeting or a meeting series depending on whether the current parameter is true or false, and each object contains the simultaneous interpretation object. When meetingNumber is specified, parameters of from, to, meetingType, state, isModified and siteUrl will be ignored. Please note that meetingNumber, webLink and roomId are mutually exclusive and they cannot be specified simultaneously.
If webLink is specified, the operation returns an array of meeting objects specified by the webLink. Each object in the array is a scheduled meeting, and each object contains the simultaneous interpretation object. When webLink is specified, parameters of current, from, to, meetingType, state, isModified and siteUrl will be ignored. Please note that meetingNumber, webLink and roomId are mutually exclusive and they cannot be specified simultaneously.
If roomId is specified, the operation returns an array of meeting objects of the Webex space specified by the roomId. When roomId is specified, parameters of current, meetingType, state and isModified will be ignored. The meeting objects are queried on the user's preferred site if no siteUrl is specified; otherwise, queried on the specified site. meetingNumber, webLink and roomId are mutually exclusive and they cannot be specified simultaneously.
If state parameter is specified, the returned array only has items in the specified state. If state is not specified, return items of all states.
If meetingType equals "meetingSeries", the scheduledType parameter can be "meeting", "webinar" or null. If scheduledType is specified, the returned array only has items of the specified scheduled type; otherwise, it has items of "meeting" and "webinar".
If meetingType equals "scheduledMeeting", the scheduledType parameter can be "meeting", "webinar", "personalRoomMeeting" or null. If scheduledType is specified, the returned array only has items of the specified scheduled type; otherwise, it has items of all scheduled types.
If meetingType equals "meeting", the scheduledType parameter can be "meeting", "webinar" or null. If scheduledType is specified, the returned array only has items of the specified scheduled type; otherwise, it has items of "meeting" and "webinar". Please note that ended or in-progress meeting instances of personal room also fall into the category of "meeting" scheduledType.
If meetingType equals "meeting", a maximum of 10000 meeting instances can be listed even if pagination is enabled.
If isModified parameter is specified, the returned array only has items which have been modified to exceptional meetings. This parameter only applies to scheduled meeting.
If any of the hasChat, hasRecording, hasTranscription, hasClosedCaption, hasPolls and hasQA parameters is specified, the meetingType must be "meeting" and state must be "ended". These parameters are null by default.
The current parameter only applies to meeting series. If it's false, the start and end attributes of each returned meeting series object are for the first scheduled meeting of that series. If it's true or not specified, the start and end attributes are for the scheduled meeting which is ready to start or join or the upcoming scheduled meeting of that series.
If from and to are specified, the operation returns an array of meeting objects in that specified time range.
If the parameter siteUrl has a value, the operation lists meetings on the specified site; otherwise, lists meetings on the user's all sites. All available Webex sites of the user can be retrieved by Get Site List API.
trackingCodes is not supported for ended meeting instances.
A full admin or a content admin can list all the ended and ongoing meeting instances of the organization he manages with the meeting:admin_schedule_read scope and meetingType=meeting parameter.
To learn more about which attributes are available for different meeting states, please refer to Available Meeting Attributes for Different Meeting States.

Request Header

password: Meeting password. Required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost or invitee of the meeting.
timezone: Time zone for time stamps in response body, defined in conformance with the IANA time zone database. The default value is UTC if not specified.

GET/v1/meetings

Query Parameters

meetingNumber

string

Meeting number for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.

webLink

string

URL encoded link to information page for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive.

roomId

string

Associated Webex space ID for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive.

meetingType

string

Meeting type for the meeting objects being requested. This parameter will be ignored if meetingNumber, webLink or roomId is specified.

Possible values: meetingSeries, scheduledMeeting, meeting

Default: meetingSeries

state

string

Meeting state for the meeting objects being requested. If not specified, return meetings of all states. This parameter will be ignored if meetingNumber, webLink or roomId is specified. Details of an ended meeting will only be available 15 minutes after the meeting has ended. inProgress meetings are not fully supported. The API will try to return details of an inProgress meeting 15 minutes after the meeting starts. However, it may take longer depending on the traffic. See the Webex Meetings guide for more information about the states of meetings.

Possible values: active, scheduled, ready, lobby, inProgress, ended, missed, expired

scheduledType

string

Scheduled type for the meeting objects being requested.

Possible values: meeting, webinar, personalRoomMeeting

isModified

boolean

Flag identifying whether a meeting has been modified. Only applies to scheduled meetings. If true, only return modified scheduled meetings; if false, only return unmodified scheduled meetings; if not specified, all scheduled meetings will be returned.

Default: null

hasChat

boolean

Flag identifying whether a meeting has a chat log. Only applies to ended meeting instances. If true, only return meeting instances which have chats; if false, only return meeting instances which have no chats; if not specified, all meeting instances will be returned.

Default: null

hasRecording

boolean

Flag identifying meetings which have been recorded. Only applies to ended meeting instances. If true, only return meeting instances which have been recorded; if false, only return meeting instances which have not been recorded; if not specified, all meeting instances will be returned.

Default: null

hasTranscription

boolean

Flag identifying meetings with transcripts. Only applies to ended meeting instances. If true, only return meeting instances which have transcripts; if false, only return meeting instances which have no transcripts; if not specified, all meeting instances will be returned.

Default: null

hasClosedCaption

boolean

Flag identifying meetings with closed captions. Only applies to ended meeting instances. If true, only return meeting instances which have closed captions; if false, only return meeting instances which have no closed captions; if not specified, all meeting instances will be returned.

Default: null

hasPolls

boolean

Flag identifying meetings with polls. Only applies to ended meeting instances. If true, only return meeting instances which have polls; if false, only return meeting instances which have no polls; if not specified, all meeting instances will be returned.

Default: null

hasQA

boolean

Flag identifying meetings with Q&A. Only applies to ended meeting instances. If true, only return meeting instances which have Q&A; if false, only return meeting instances which have no Q&A; if not specified, all meeting instances will be returned.

Default: null

current

boolean

Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where meetingNumber is specified and the meeting is not an exceptional meeting from a meeting series. If it's true, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's false, return the entire meeting series.

Default: true

from

string

Start date and time (inclusive) in any ISO 8601 compliant format for the meeting objects being requested. from cannot be after to. This parameter will be ignored if meetingNumber, webLink or roomId is specified.

Default: When `meetingType` is `meetingSeries` or `scheduledMeeting` by explicitly setting it or defaulting to this value, the `from` if not specified equals `to` minus 7 days; if `to` is also not specified, the default value for `from` is the current date and time. When `meetingType` is `meeting`, the `from` if not specified equals `to` minus 7 days; if `to` is also not specified, the default value for `from` is 7 days before the current date and time.

String

End date and time (exclusive) in any ISO 8601 compliant format for the meeting objects being requested. to cannot be before from. This parameter will be ignored if meetingNumber, webLink or roomId is specified.

Default: When `meetingType` is `meetingSeries` or `scheduledMeeting` by explicitly setting it or defaulting to this value, the `to` if not specified equals `from` plus 7 days; if `from` is also not specified, the default value for `to` is 7 days after current date and time. When `meetingType` is `meeting`, the `to` if not specified equals `from` plus 7 days; if `from` is also not specified, the default value for `to` is the current date and time.

max

number

Limit the maximum number of meetings in the response, up to 100. This parameter will be ignored if meetingNumber, webLink or roomId is specified.

Default: 10

hostEmail

string

Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API returns meetings as if the user calling the API were the user of hostEmail themself, and the meetings returned by the API include the meetings where the user of hostEmail is the meeting host and those where they are an invitee.

siteUrl

string

URL of the Webex site which the API lists meetings from. If not specified, the API lists meetings from user's all sites. All available Webex sites of the user can be retrieved by Get Site List API.

integrationTag

string

External key created by an integration application. This parameter is used by the integration application to query meetings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.

Response Properties

items

array[MeetingSeriesObjectForListMeeting]

Meetings array.

string

Unique identifier for meeting. For a meeting series, the id is used to identify the entire series. For scheduled meetings from a series, the id is used to identify that scheduled meeting. For a meeting instance that is in progress or has concluded, the id is used to identify that instance.

meetingNumber

string

Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.

title

string

Meeting title. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

agenda

string

Meeting agenda. The agenda can be a maximum of 1300 characters long. This attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

password

string

Meeting password. Applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

phoneAndVideoSystemPassword

string

8-digit numeric password used to join a meeting from audio and video devices. This attribute applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended.

meetingType

enum

Meeting type.

meetingSeries

string

Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a recurrence rule. When a non-recurring meeting is scheduled with no recurrence, its meetingType is also meetingSeries which is a meeting series with only one occurrence in Webex meeting modeling.

scheduledMeeting

string

Instance from a primary meeting series.

meeting

string

Meeting instance that is in progress or has completed.

state

enum

Meeting state.

active

string

Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.

scheduled

string

Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.

ready

string

Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.

lobby

string

Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.

inProgress

string

Applies to meeting series and meeting instances. For a meeting series, indicates that an instance of this series is happening now. For a meeting instance, indicates that the meeting has been joined and unlocked.

ended

string

Applies to scheduled meetings and meeting instances. For scheduled meetings, indicates that the meeting was started and is now over. For meeting instances, indicates that the meeting instance has concluded.

missed

string

This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.

expired

string

This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.

hostDidJoin

boolean

Only applies to meeting series in the inProgress state, scheduled meetings in the ready state, and meeting instances in the inProgress state, whether or not the meeting host joined the meeting. If true, the meeting host has joined the meeitng even if they dropped off; otherwise, the meeting host hasn't ever join the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if attendeeDidJoin is true and hostDidJoin is false.

attendeeDidJoin

boolean

Only applies to meeting series in the inProgress state, scheduled meetings in the ready state, and meeting instances in the inProgress state. Whether or not anyone has joined the meeting. If true, the meeting host or any attendee has joined the meeting; otherwise, no one has joined the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if attendeeDidJoin is true and hostDidJoin is false.

timezone

string

Time zone of start and end, conforming with the IANA time zone database.

start

string

Start time for meeting in ISO 8601 compliant format. If the meetingType of a meeting is meetingSeries, start is the scheduled start time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, start is the date and time the upcoming or ongoing meeting of the series starts. If the meetingType of a meeting is scheduledMeeting, start is the scheduled start time of this occurrence. If the meetingType of a meeting is meeting, start is the actual start time of the meeting instance. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

end

string

End time for a meeting in ISO 8601 compliant format. If the meetingType of a meeting is meetingSeries, end is the scheduled end time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, end is the date and time the upcoming or ongoing meeting of the series ends. If the meetingType of a meeting is scheduledMeeting, end is the scheduled end time of this occurrence. If the meetingType of a meeting is meeting, end is the actual end time of the meeting instance. If a meeting instance is in progress, end is not available. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

recurrence

string

Meeting series recurrence rule (conforming with RFC 2445). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Can be modified for a meeting series using the Update a Meeting API. Multiple days or dates for monthly or yearly recurrence rule are not supported, only the first day or date specified is taken. For example, "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10,11,12" is not supported and it will be partially supported as "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10".

hostUserId

string

Unique identifier for the meeting host.

hostDisplayName

string

Display name for the meeting host.

hostEmail

string

Email address for the meeting host.

hostKey

string

Key for joining the meeting as host.

siteUrl

string

Site URL for the meeting.

webLink

string

Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.

sipAddress

string

SIP address for callback from a video system.

dialInIpAddress

string

IP address for callback from a video system.

roomId

string

Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings.

enabledAutoRecordMeeting

boolean

Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

allowAnyUserToBeCoHost

boolean

Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by a siteUrl parameter when creating the meeting. If not specified, it's a user's preferred site. The allowAnyUserToBeCoHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

enabledJoinBeforeHost

boolean

Whether or not to allow any attendee to join the meeting before the host joins the meeting. The enabledJoinBeforeHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

enableConnectAudioBeforeHost

boolean

Whether or not to allow any attendee to connect to audio before the host joins the meeting. Only applicable if the enabledJoinBeforeHost attribute is set to true. The enableConnectAudioBeforeHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

joinBeforeHostMinutes

number

Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the enabledJoinBeforeHost attribute is set to true. The joinBeforeHostMinutes attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API. Valid options for a meeting are 0, 5, 10, and 15, and valid options for a webinar are 0, 15, 30, 45, and 60. The default is 0 if not specified.

excludePassword

boolean

Whether or not to exclude the meeting password from the email invitation.

publicMeeting

boolean

Whether or not to allow the meeting to be listed on the public calendar.

reminderTime

number

The number of minutes before the meeting begins, that an email reminder is sent to the host.

unlockedMeetingJoinSecurity

enum

Specifies how the people who aren't on the invite can join the unlocked meeting.

allowJoin

string

If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.

allowJoinWithLobby

string

If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.

blockFromJoin

string

If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.

sessionTypeId

number

Unique identifier for a meeting session type for the user. This attribute is required when scheduling a webinar meeting. All available meeting session types enabled for the user can be retrieved using the List Meeting Session Types API.

scheduledType

enum

Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's personal room.

meeting

string

If the value of scheduledType attribute is meeting, it is a regular meeting.

webinar

string

If the value of scheduledType attribute is webinar, it is a webinar meeting.

personalRoomMeeting

string

If the value of scheduledType attribute is personalRoomMeeting, it is a meeting scheduled in the user's personal room.

enabledWebcastView

boolean

Whether or not webcast view is enabled.

panelistPassword

string

Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read password management for details. If not specified, a random password conforming to the site's password rules will be generated automatically.

phoneAndVideoSystemPanelistPassword

string

8-digit numeric panelist password to join a webinar meeting from audio and video devices.

enableAutomaticLock

boolean

Whether or not to automatically lock the meeting after it starts.

automaticLockMinutes

number

The number of minutes after the meeting begins, for automatically locking it.

allowFirstUserToBeCoHost

boolean

Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by the siteUrl parameter when creating the meeting. If not specified, it's a user's preferred site. The allowFirstUserToBeCoHost attribute can be modified for a meeting series or a scheduled meeting uisng the Update a Meeting API.

allowAuthenticatedDevices

boolean

Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

hasChat

boolean

Whether or not this meeting instance has chat.

hasRecording

boolean

Whether or not this meeting instance has been recorded. true if the meeting instance has been recorded even if the recording has been deleted.

hasTranscription

boolean

Whether or not this meeting instance has a transcription.

hasClosedCaption

boolean

Whether or not this meeting instance has closed captions.

hasPolls

boolean

Whether or not this meeting instance has polls.

hasQA

boolean

Whether or not this meeting instance has Q&A.

hasRegistration

boolean

Whether or not this meeting instance has a registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances.

hasRegistrants

boolean

Whether or not someone has registered a this meeting instance via the registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances.

hasPostEventSurvey

boolean

Whether this meeting instance has a survey and someone has responded to the survey. Only applies to ended webinar instances. Doesn't apply to meeting series, scheduled meetings, in-progress meeting or webinar instances, or ended meeting instances.

telephony

object

Information for callbacks from a meeting to phone or for joining a teleconference using a phone.

accessCode

string

Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the accessCode.

callInNumbers

array[object]

Array of call-in numbers for joining a teleconference from a phone.

label

string

Label for the call-in number.

Possible values: Call-in toll-free number (US/Canada)

callInNumber

string

Call-in number to join the teleconference from a phone.

Possible values: 123456789

tollType

enum

Type of toll for the call-in number.

toll

string

tollFree

string

links

object

HATEOAS information of global call-in numbers for joining a teleconference from a phone.

rel

string

Link relation describing how the target resource is related to the current context (conforming with RFC5998).

href

string

Target resource URI (conforming with RFC5998).

method

string

Target resource method (conforming with RFC5998).

meetingOptions

object

Meeting options.

enabledChat

boolean

Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.

enabledVideo

boolean

Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.

enabledPolling

boolean

Whether or not to allow any attendee to poll in the meeting. Can only be set true for a webinar. The value of this attribute depends on the session type for a meeting. Please contact your site admin if this attribute is not available. Not supported if the site has been migrated to the Webex Suite meeting platform.

enabledNote

boolean

Whether or not to allow any attendee to take notes in the meeting. The value of this attribute also depends on the session type. Not supported if the site has been migrated to the Webex Suite meeting platform.

noteType

enum

Whether note taking is enabled. If the value of enabledNote is false, users cannot set this attribute and get the default value allowAll. Not supported if the site has been migrated to the Webex Suite meeting platform.

allowAll

string

If the value of noteType attribute is allowAll, all participants can take notes.

allowOne

string

If the value of noteType attribute is allowOne, only a single note taker is allowed.

enabledFileTransfer

boolean

Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.

enabledUCFRichMedia

boolean

Whether or not to allow any attendee to share Universal Communications Format media files in the meeting. The value of this attribute also depends on the sessionType. Not supported if the site has been migrated to the Webex Suite meeting platform.

attendeePrivileges

object

Attendee Privileges. This attribute is not supported for a webinar.

enabledShareContent

boolean

Whether or not to allow any attendee to share content in the meeting.

enabledSaveDocument

boolean

Whether or not to allow any attendee to save shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.

enabledPrintDocument

boolean

Whether or not to allow any attendee to print shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.

enabledAnnotate

boolean

Whether or not to allow any attendee to annotate shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.

enabledViewParticipantList

boolean

Whether or not to allow any attendee to view participants.

enabledViewThumbnails

boolean

Whether or not to allow any attendee to see a small preview image of any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.

enabledRemoteControl

boolean

Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.

enabledViewAnyDocument

boolean

Whether or not to allow any attendee to view any shared documents or slides when they are shared as files in the content viewer instead of in a window or application.

enabledViewAnyPage

boolean

Whether or not to allow any attendee to scroll through any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.

enabledContactOperatorPrivately

boolean

Whether or not to allow any attendee to contact the operator privately.

enabledChatHost

boolean

Whether or not to allow any attendee to chat with the host in private.

enabledChatPresenter

boolean

Whether or not to allow any attendee to chat with the presenter in private.

enabledChatOtherParticipants

boolean

Whether or not to allow any attendee to chat with other participants in private.

registration

object

Meeting registration. When this option is enabled, meeting invitees must register personal information in order to join the meeting. Meeting invitees will receive an email with a registration link for the registration. When the registration form has been submitted and approved, an email with a real meeting link will be received. By clicking that link the meeting invitee can join the meeting. Please note that meeting registration does not apply to a meeting when it's a recurring meeting with a recurrence field or no password, or the Join Before Host option is enabled for the meeting. See Register for a Meeting in Cisco Webex Meetings for details.

autoAcceptRequest

boolean

Whether or not meeting registration requests are accepted automatically.

requireFirstName

boolean

Whether or not a registrant's first name is required for meeting registration.

requireLastName

boolean

Whether or not a registrant's last name is required for meeting registration.

requireEmail

boolean

Whether or not a registrant's email is required for meeting registration.

requireJobTitle

boolean

Whether or not a registrant's job title is shown or required for meeting registration.

requireCompanyName

boolean

Whether or not a registrant's company name is shown or required for meeting registration.

requireAddress1

boolean

Whether or not a registrant's first address field is shown or required for meeting registration.

requireAddress2

boolean

Whether or not a registrant's second address field is shown or required for meeting registration.

requireCity

boolean

Whether or not a registrant's city is shown or required for meeting registration.

requireState

boolean

Whether or not a registrant's state is shown or required for meeting registration.

requireZipCode

boolean

Whether or not a registrant's postal code is shown or required for meeting registration.

requireCountryRegion

boolean

Whether or not a registrant's country or region is shown or required for meeting registration.

requireWorkPhone

boolean

Whether or not a registrant's work phone number is shown or required for meeting registration.

requireFax

boolean

Whether or not a registrant's fax number is shown or required for meeting registration.

maxRegisterNum

number

Maximum number of meeting registrations. This only applies to meetings. The maximum number of participants for meetings and webinars, with the limit based on the user capacity and controlled by a toggle at the site level. The default maximum number of participants for webinars is 10000, but the actual maximum number of participants is limited by the user capacity.

integrationTags

array[string]

External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc.

simultaneousInterpretation

object

Simultaneous interpretation information for the meeting.

enabled

boolean

Whether or not simultaneous interpretation is enabled.

interpreters

array[InterpreterObjectForSimultaneousInterpretationOfGetOrListMeeting]

Interpreters for meeting.

string

Unique identifier for meeting interpreter.

languageCode1

string

Forms a set of simultaneous interpretation channels together with languageCode2. Standard language format from ISO 639-1 code. Read ISO 639-1 for details.

languageCode2

string

Forms a set of simultaneous interpretation channels together with languageCode1. Standard language format from ISO 639-1 code. Read ISO 639-1 for details.

string

Email address of meeting interpreter.

displayName

string

Display name of meeting interpreter.

trackingCodes

array[TrackingCodeItemForGetMeetingObject]

Tracking codes information.

name

string

Name for the tracking code.

value

string

Value for the tracking code.

enabledAudioWatermark

boolean

Whether or not the audio watermark is enabled.

enabledVisualWatermark

boolean

Whether or not the visual watermark is enabled.

visualWatermarkOpacity

number

Opacity level for visual watermark.

audioConnectionOptions

object

Audio connection options.

audioConnectionType

enum

Choose how meeting attendees join the audio portion of the meeting.

webexAudio

string

Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.

VoIP

string

Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.

other

string

Other teleconference services.

none

string

The way of attendees join the audio portion of the meeting is the default value.

enabledTollFreeCallIn

boolean

Whether or not to show toll-free call-in numbers.

enabledGlobalCallIn

boolean

Whether or not to show global call-in numbers to attendees.

enabledAudienceCallBack

boolean

Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.

entryAndExitTone

enum

Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.

beep

string

All call-in users joining the meeting will hear the beep.

announceName

string

All call-in users joining the meeting will hear their names.

noTone

string

Turn off beeps and name announcements.

allowHostToUnmuteParticipants

boolean

Whether or not to allow the host to unmute participants.

allowAttendeeToUnmuteSelf

boolean

Whether or not to allow attendees to unmute themselves.

muteAttendeeUponEntry

boolean

Whether or not to auto-mute attendees when attendees enter meetings.

requireAttendeeLogin

boolean

Require attendees to sign in before joining the webinar.

restrictToInvitees

boolean

Restrict webinar to invited attendees only.

Response Codes

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

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The 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.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The 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.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The 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.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too 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.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/meetings{?meetingNumber,webLink,roomId,meetingType,state,scheduledType,isModified,hasChat,hasRecording,hasTranscription,hasClosedCaption,hasPolls,hasQA,current,max,from,to,hostEmail,siteUrl,integrationTag}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.
password
timezone

Query Parameters

meetingNumber
string
Meeting number for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.
webLink
string
URL encoded link to information page for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive.
roomId
string
Associated Webex space ID for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive.
meetingType
string
Meeting type for the meeting objects being requested. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
state
string
Meeting state for the meeting objects being requested. If not specified, return meetings of all states. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified. Details of an `ended` meeting will only be available 15 minutes after the meeting has ended. `inProgress` meetings are not fully supported. The API will try to return details of an `inProgress` meeting 15 minutes after the meeting starts. However, it may take longer depending on the traffic. See the [Webex Meetings](/docs/meetings#meeting-states) guide for more information about the states of meetings.
scheduledType
string
Scheduled type for the meeting objects being requested.
isModified
boolean
Flag identifying whether a meeting has been modified. Only applies to scheduled meetings. If `true`, only return modified scheduled meetings; if `false`, only return unmodified scheduled meetings; if not specified, all scheduled meetings will be returned.
hasChat
boolean
Flag identifying whether a meeting has a chat log. Only applies to ended meeting instances. If `true`, only return meeting instances which have chats; if `false`, only return meeting instances which have no chats; if not specified, all meeting instances will be returned.
hasRecording
boolean
Flag identifying meetings which have been recorded. Only applies to ended meeting instances. If true, only return meeting instances which have been recorded; if false, only return meeting instances which have not been recorded; if not specified, all meeting instances will be returned.
hasTranscription
boolean
Flag identifying meetings with transcripts. Only applies to ended meeting instances. If `true`, only return meeting instances which have transcripts; if `false`, only return meeting instances which have no transcripts; if not specified, all meeting instances will be returned.
hasClosedCaption
boolean
Flag identifying meetings with closed captions. Only applies to ended meeting instances. If `true`, only return meeting instances which have closed captions; if `false`, only return meeting instances which have no closed captions; if not specified, all meeting instances will be returned.
hasPolls
boolean
Flag identifying meetings with polls. Only applies to ended meeting instances. If `true`, only return meeting instances which have polls; if `false`, only return meeting instances which have no polls; if not specified, all meeting instances will be returned.
hasQA
boolean
Flag identifying meetings with Q&A. Only applies to ended meeting instances. If `true`, only return meeting instances which have Q&A; if `false`, only return meeting instances which have no Q&A; if not specified, all meeting instances will be returned.
current
boolean
Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where `meetingNumber` is specified and the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series.
from
string
Start date and time (inclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested. `from` cannot be after `to`. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
to
String
End date and time (exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested. `to` cannot be before `from`. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
max
number
Limit the maximum number of meetings in the response, up to 100. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
hostEmail
string
Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API returns meetings as if the user calling the API were the user of `hostEmail` themself, and the meetings returned by the API include the meetings where the user of `hostEmail` is the meeting host and those where they are an invitee.
siteUrl
string
URL of the Webex site which the API lists meetings from. If not specified, the API lists meetings from user's all sites. All available Webex sites of the user can be retrieved by `Get Site List` API.
integrationTag
string
External key created by an integration application. This parameter is used by the integration application to query meetings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.

https://webexapis.com/v1/meetings?meetingNumber=123456789&webLink=https%253A%252F%252Fgo.webex.com%252Fgo%252Fj.php%253FMTID%253Dm066878aef4343e74c98b48439b71acfd&roomId=Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2&meetingType=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&state=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&scheduledType=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&isModified=false&hasChat=false&hasRecording=false&hasTranscription=false&hasClosedCaption=false&hasPolls=false&hasQA=false&current=false&from=2019-03-18T09:30:00+08:00&to=2019-03-25T09:30:00+08:00&max=100&hostEmail=john.andersen@example.com&siteUrl=example.webex.com&integrationTag=dbaeceebea5c4a63ac9d5ef1edfe36b9

200 / OK

{
    "items": [
        {
            "id": "870f51ff287b41be84648412901e0402_20191101T120000Z",
            "meetingSeriesId": "870f51ff287b41be84648412901e0402",
            "meetingNumber": "123456789",
            "title": "Example Daily Meeting",
            "agenda": "Example Agenda",
            "password": "BgJep@43",
            "phoneAndVideoSystemPassword": "12345678",
            "meetingType": "scheduledMeeting",
            "state": "ready",
            "hostDidJoin": true,
            "attendeeDidJoin": true,
            "isModified": false,
            "timezone": "UTC",
            "start": "2019-11-01T12:00:00Z",
            "end": "2019-11-01T13:00:00Z",
            "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
            "hostDisplayName": "John Andersen",
            "hostEmail": "john.andersen@example.com",
            "hostKey": "123456",
            "siteUrl": "site4-example.webex.com",
            "webLink": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e",
            "sipAddress": "123456789@site4-example.webex.com",
            "dialInIpAddress": "192.168.100.100",
            "enabledAutoRecordMeeting": false,
            "allowAnyUserToBeCoHost": false,
            "enabledJoinBeforeHost": false,
            "enableConnectAudioBeforeHost": false,
            "joinBeforeHostMinutes": 0,
            "excludePassword": false,
            "publicMeeting": false,
            "reminderTime": 10,
            "unlockedMeetingJoinSecurity": "allowJoin",
            "sessionTypeId": 3,
            "enableAutomaticLock": false,
            "automaticLockMinutes": 0,
            "allowFirstUserToBeCoHost": false,
            "allowAuthenticatedDevices": false,
            "telephony": {
                "accessCode": "1234567890",
                "callInNumbers": [
                    {
                        "label": "US Toll",
                        "callInNumber": "123456789",
                        "tollType": "toll"
                    }
                ],
                "links": [
                    {
                        "rel": "globalCallinNumbers",
                        "href": "/api/v1/meetings/870f51ff287b41be84648412901e0402_20191101T120000Z/globalCallinNumbers",
                        "method": "GET"
                    }
                ]
            },
            "meetingOptions": {
                "enabledChat": true,
                "enabledVideo": true,
                "enabledPolling": false,
                "enabledNote": true,
                "noteType": "allowAll",
                "enabledFileTransfer": false,
                "enabledUCFRichMedia": false
            },
            "attendeePrivileges": {
                "enabledShareContent": true,
                "enabledSaveDocument": false,
                "enabledPrintDocument": false,
                "enabledAnnotate": false,
                "enabledViewParticipantList": true,
                "enabledViewThumbnails": false,
                "enabledRemoteControl": true,
                "enabledViewAnyDocument": false,
                "enabledViewAnyPage": false,
                "enabledContactOperatorPrivately": false,
                "enabledChatHost": true,
                "enabledChatPresenter": true,
                "enabledChatOtherParticipants": true
            },
            "integrationTags": [
                "dbaeceebea5c4a63ac9d5ef1edfe36b9",
                "85e1d6319aa94c0583a6891280e3437d",
                "27226d1311b947f3a68d6bdf8e4e19a1"
            ],
            "scheduledType": "meeting",
            "enabledBreakoutSessions": true,
            "links": [
                {
                    "rel": "breakoutSessions",
                    "href":"/v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions",
                    "method": "GET"
                }
            ],
            "trackingCodes": [
                {
                    "name": "Department",
                    "value": "Engineering"
                },
                {
                    "name": "Division",
                    "value": "Full-time"
                }
            ],
            "enabledAudioWatermark": true,
            "enabledVisualWatermark": true,
            "visualWatermarkOpacity": 10,
            "audioConnectionOptions": {
                "audioConnectionType": "VoIP",
                "enabledTollFreeCallIn": false,
                "enabledGlobalCallIn": false,
                "enabledAudienceCallBack": false,
                "entryAndExitTone": "beep",
                "allowHostToUnmuteParticipants": false,
                "allowAttendeeToUnmuteSelf": true,
                "muteAttendeeUponEntry": false
            }
        },
        {
            "id": "870f51ff287b41be84648412901e0402_I_167427437874906709",
            "meetingSeriesId": "870f51ff287b41be84648412901e0402",
            "scheduledMeetingId": "870f51ff287b41be84648412901e0402_20191101T120000Z",
            "title": "Example Daily Meeting",
            "agenda": "Example Agenda",
            "meetingType": "meeting",
            "state": "ended",
            "excludePassword": false,
            "publicMeeting": false,
            "enableAutomaticLock": false,
            "timezone": "UTC",
            "start": "2019-11-01T12:12:15Z",
            "end": "2019-11-01T12:51:33Z",
            "hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
            "hostDisplayName": "John Andersen",
            "hostEmail": "john.andersen@example.com",
            "siteUrl": "site4-example.webex.com",
            "webLink": "https://site4-example.webex.com/site4/j.php?MTID=870f51ff287b41be84648412901e0402_I_167427437874906709",
            "hasChat": true,
            "hasRecording": true,
            "hasTranscription": true,
            "hasClosedCaption": true,
            "hasPolls": true,
            "hasQA": true,
            "meetingOptions": {
                "enabledChat": true,
                "enabledVideo": true,
                "enabledPolling": false,
                "enabledNote": true,
                "noteType": "allowAll",
                "enabledFileTransfer": false,
                "enabledUCFRichMedia": false
            },
            "attendeePrivileges": {
                "enabledShareContent": true,
                "enabledSaveDocument": false,
                "enabledPrintDocument": false,
                "enabledAnnotate": false,
                "enabledViewParticipantList": true,
                "enabledViewThumbnails": false,
                "enabledRemoteControl": true,
                "enabledViewAnyDocument": false,
                "enabledViewAnyPage": false,
                "enabledContactOperatorPrivately": false,
                "enabledChatHost": true,
                "enabledChatPresenter": true,
                "enabledChatOtherParticipants": true
            },
            "integrationTags": [
                "dbaeceebea5c4a63ac9d5ef1edfe36b9",
                "85e1d6319aa94c0583a6891280e3437d",
                "27226d1311b947f3a68d6bdf8e4e19a1"
            ],
            "scheduledType": "meeting",
            "enabledBreakoutSessions": true,
            "links": [
                {
                    "rel": "breakoutSessions",
                    "href":"/v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions",
                    "method": "GET"
                }
            ],
            "enabledVisualWatermark": true,
            "visualWatermarkOpacity": 10,
            "audioConnectionOptions": {
                "audioConnectionType": "webexAudio",
                "enabledTollFreeCallIn": true,
                "enabledGlobalCallIn": true,
                "enabledAudienceCallBack": false,
                "entryAndExitTone": "beep",
                "allowHostToUnmuteParticipants": false,
                "allowAttendeeToUnmuteSelf": true,
                "muteAttendeeUponEntry": false
            }
        }
    ]
}