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.

  • 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. When meetingNumber is specified, parameters of from, to, meetingType, state, isModified, participantEmail 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. When webLink is specified, parameters of current, from, to, meetingType, state, isModified, participantEmail 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 specified by the roomId. When roomId is specified, parameters of from, to, current, meetingType, state, isModified, participantEmail and siteUrl will be ignored. Please note that 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 isModified parameter is specified, the returned array only has items which have been modified to exceptional meetings. This parameter only applies to scheduled meeting.

  • The current parameter only applies to meeting series. If it's true, 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 preferred site. All available Webex sites and preferred site of the user can be retrieved by Get Site List API.

Request Header

  • password: Meeting password. It's 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 master 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 Teams space room ID for the space 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
participantEmail
string

Meeting participant email address for the meeting objects being requested. This parameter only applies when meetingType is meeting, and it will be ignored if meetingNumber, webLink or roomId is specified.

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.
to
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 will return details for meetings that are hosted by that user.

siteUrl
string

URL of the Webex site which the API lists meetings from. If not specified, the API lists meetings from user's preferred site. All available Webex sites and preferred site 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.

Body Parameters
items
array

Meetings array

id
stringrequired

Unique identifier for meeting. If it's a meeting series, the id is used to identify the entire series; if it's a scheduled meeting from a series, the id is used to identify that scheduled meeting; if it's a meeting instance that is happening or has happened, the id is used to identify that instance.

meetingNumber
string

Meeting number. This attribute applies to meeting series, scheduled meeting and meeting instance, but it does not apply to meeting instances which have ended.

title
stringrequired

Meeting title. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

agenda
string

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

password
stringrequired

Meeting password. This attribute applies to meeting series, scheduled meeting and in-progress meeting instance, but it does not apply to meeting instances which have ended. It can be modified for meeting series or scheduled meeting by Update a Meeting API.

phoneAndVideoSystemPassword
string

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

meetingType
enumrequired

Meeting type.

meetingSeries
string

Master of a scheduled series of meetings which consists of one or more scheduled meeting based on a recurrence rule.

scheduledMeeting
string

Instance from a master meeting series.

meeting
string

meeting instance that is actually happening or has happened.

state
enumrequired

Meeting state.

active
string

This state only applies to meeting series. It indicates that one or more future scheduled meeting exist for this meeting series.

scheduled
string

This state only applies to scheduled meeting. It indicates that the meeting is scheduled in the future.

ready
string

This state only applies to scheduled meeting. It indicates that this scheduled meeting is ready to start or join now.

lobby
string

This state only applies to meeting instance. It indicates that a locked meeting has been joined by participants, but no hosts have joined.

inProgress
string

This state applies to meeting series and meeting instance. For meeting series, this state indicates that an instance of this series is happening now; for meeting instance, it indicates that the meeting has been joined and unlocked.

ended
string

This state applies to scheduled meeting and meeting instance. For scheduled meeting, it indicates that this scheduled meeting was started and is now over; for meeting instance, this state indicates that this meeting instance has concluded.

missed
string

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

expired
string

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

timezone
stringrequired

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

start
stringrequired

Start time for meeting in ISO 8601 compliant format. If the meeting is a meeting series, start is the date and time the first meeting of the series starts; if the meeting is a meeting series and current filter is true, start is the date and time the upcoming or ongoing meeting of the series starts; if the meeting is a scheduled meeting from a meeting series, start is the date and time when that scheduled meeting starts; if the meeting is a meeting instance that has happened or is happening, start is the date and time that instance actually starts. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

end
stringrequired

End time for meeting in ISO 8601 compliant format. If the meeting is a meeting series, end is the date and time the first meeting of the series ends; if the meeting is a meeting series and current filter is true, end is the date and time the upcoming or ongoing meeting of the series ends; if the meeting is a scheduled meeting from a meeting series, end is the date and time when that scheduled meeting ends; if the meeting is a meeting instance that has happened, end is the date and time that instance actually ends; if a meeting intance is in progress, end is not available. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

recurrence
string

Meeting series recurrence rule (conforming with RFC 2445), applying only to recurring meeting series. It does not apply to meeting series with only one scheduled meeting. This attribute can be modified for meeting series by Update a Meeting API.

hostUserId
stringrequired

Unique identifier for meeting host. It's in the format of Base64Encode(ciscospark://us/PEOPLE/hostUserId). For example, a hostUserId is 7BABBE99-B43E-4D3F-9147-A1E9D46C9CA0, the actual value for it is Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA=.

hostDisplayName
stringrequired

Display name for meeting host.

hostEmail
stringrequired

Email address for meeting host.

hostKey
stringrequired

Key for joining meeting as host.

siteUrl
stringrequired

Site URL for the meeting.

webLink
stringrequired

Link to meeting information page where meeting client will be launched if the meeting is ready for 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 Teams space. This attribute only applies to space meeting.

enabledAutoRecordMeeting
boolean

Whether or not meeting is recorded automatically. This attribute can be modified for meeting series or scheduled meeting by 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 siteUrl parameter when creating the meeting; if not specified, it's user's preferred site. The allowAnyUserToBeCoHost attribute can be modified for meeting series or scheduled meeting by 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 meeting series or scheduled meeting by Update a Meeting API.

enableConnectAudioBeforeHost
boolean

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

joinBeforeHostMinutes
number

the number of minutes an attendee can join the meeting before the meeting start time and the host joins. This attribute is only applicable if the enabledJoinBeforeHost attribute is set to true. The joinBeforeHostMinutes attribute can be modified for meeting series or scheduled meeting by Update a Meeting API. Valid options are 0, 5, 10 and 15. Default is 0 if not specified.

excludePassword
boolean

Whether or not to exclude password from the meeting 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, for sending an email reminder to the host.

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 siteUrl parameter when creating the meeting; if not specified, it's user's preferred site. The allowFirstUserToBeCoHost attribute can be modified for meeting series or scheduled meeting by 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 meeting series or scheduled meeting by Update a Meeting API.

telephony
objectrequired

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

accessCode
stringrequired

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
arrayrequired

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

links
object

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

rel
stringrequired

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

href
stringrequired

Target resource URI (conforming with RFC5998).

method
stringrequired

Target resource method (conforming with RFC5998).

registration
object

Meeting registration. When this option is enabled, meeting invitee must register personal information in order to join the meeting. Meeting invitee 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 recurrence field or it has no password, or the Join Before Host option is enabled for the meeting. Read Register for a Meeting in Cisco Webex Meetings for details.

autoAcceptRequest
boolean

Whether or not meeting registration request is accepted automatically.

requireFirstName
boolean

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

requireLastName
boolean

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

requireEmail
boolean

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

requireJobTitle
boolean

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

requireCompanyName
boolean

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

requireAddress1
boolean

Whether or not registrant's 1st address is required for meeting registration.

requireAddress2
boolean

Whether or not registrant's 2nd address is required for meeting registration.

requireCity
boolean

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

requireState
boolean

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

requireZipCode
boolean

Whether or not registrant's zip code is required for meeting registration.

requireCountryRegion
boolean

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

requireWorkPhone
boolean

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

requireFax
boolean

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

integrationTags
array

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

Response Properties
items
array

Meetings array

id
string

Unique identifier for meeting. If it's a meeting series, the id is used to identify the entire series; if it's a scheduled meeting from a series, the id is used to identify that scheduled meeting; if it's a meeting instance that is happening or has happened, the id is used to identify that instance.

meetingNumber
string

Meeting number. This attribute applies to meeting series, scheduled meeting and meeting instance, but it does not apply to meeting instances which have ended.

title
string

Meeting title. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

agenda
string

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

password
string

Meeting password. This attribute applies to meeting series, scheduled meeting and in-progress meeting instance, but it does not apply to meeting instances which have ended. It can be modified for meeting series or scheduled meeting by Update a Meeting API.

phoneAndVideoSystemPassword
string

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

meetingType
enum

Meeting type.

meetingSeries
string

Master of a scheduled series of meetings which consists of one or more scheduled meeting based on a recurrence rule.

scheduledMeeting
string

Instance from a master meeting series.

meeting
string

meeting instance that is actually happening or has happened.

state
enum

Meeting state.

active
string

This state only applies to meeting series. It indicates that one or more future scheduled meeting exist for this meeting series.

scheduled
string

This state only applies to scheduled meeting. It indicates that the meeting is scheduled in the future.

ready
string

This state only applies to scheduled meeting. It indicates that this scheduled meeting is ready to start or join now.

lobby
string

This state only applies to meeting instance. It indicates that a locked meeting has been joined by participants, but no hosts have joined.

inProgress
string

This state applies to meeting series and meeting instance. For meeting series, this state indicates that an instance of this series is happening now; for meeting instance, it indicates that the meeting has been joined and unlocked.

ended
string

This state applies to scheduled meeting and meeting instance. For scheduled meeting, it indicates that this scheduled meeting was started and is now over; for meeting instance, this state indicates that this meeting instance has concluded.

missed
string

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

expired
string

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

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 meeting is a meeting series, start is the date and time the first meeting of the series starts; if the meeting is a meeting series and current filter is true, start is the date and time the upcoming or ongoing meeting of the series starts; if the meeting is a scheduled meeting from a meeting series, start is the date and time when that scheduled meeting starts; if the meeting is a meeting instance that has happened or is happening, start is the date and time that instance actually starts. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

end
string

End time for meeting in ISO 8601 compliant format. If the meeting is a meeting series, end is the date and time the first meeting of the series ends; if the meeting is a meeting series and current filter is true, end is the date and time the upcoming or ongoing meeting of the series ends; if the meeting is a scheduled meeting from a meeting series, end is the date and time when that scheduled meeting ends; if the meeting is a meeting instance that has happened, end is the date and time that instance actually ends; if a meeting intance is in progress, end is not available. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

recurrence
string

Meeting series recurrence rule (conforming with RFC 2445), applying only to recurring meeting series. It does not apply to meeting series with only one scheduled meeting. This attribute can be modified for meeting series by Update a Meeting API.

hostUserId
string

Unique identifier for meeting host. It's in the format of Base64Encode(ciscospark://us/PEOPLE/hostUserId). For example, a hostUserId is 7BABBE99-B43E-4D3F-9147-A1E9D46C9CA0, the actual value for it is Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA=.

hostDisplayName
string

Display name for meeting host.

hostEmail
string

Email address for meeting host.

hostKey
string

Key for joining meeting as host.

siteUrl
string

Site URL for the meeting.

webLink
string

Link to meeting information page where meeting client will be launched if the meeting is ready for 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 Teams space. This attribute only applies to space meeting.

enabledAutoRecordMeeting
boolean

Whether or not meeting is recorded automatically. This attribute can be modified for meeting series or scheduled meeting by 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 siteUrl parameter when creating the meeting; if not specified, it's user's preferred site. The allowAnyUserToBeCoHost attribute can be modified for meeting series or scheduled meeting by 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 meeting series or scheduled meeting by Update a Meeting API.

enableConnectAudioBeforeHost
boolean

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

joinBeforeHostMinutes
number

the number of minutes an attendee can join the meeting before the meeting start time and the host joins. This attribute is only applicable if the enabledJoinBeforeHost attribute is set to true. The joinBeforeHostMinutes attribute can be modified for meeting series or scheduled meeting by Update a Meeting API. Valid options are 0, 5, 10 and 15. Default is 0 if not specified.

excludePassword
boolean

Whether or not to exclude password from the meeting 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, for sending an email reminder to the host.

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 siteUrl parameter when creating the meeting; if not specified, it's user's preferred site. The allowFirstUserToBeCoHost attribute can be modified for meeting series or scheduled meeting by 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 meeting series or scheduled meeting by Update a Meeting API.

telephony
object

Information for callbacks from 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

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

label

Label for call-in number.

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

Call-in number to join teleconference from a phone.

Possible values: 123456789
tollType

Type of toll for the call-in number.

Possible values: toll, tollFree
links
object

HATEOAS information of global call-in numbers for joining 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).

registration
object

Meeting registration. When this option is enabled, meeting invitee must register personal information in order to join the meeting. Meeting invitee 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 recurrence field or it has no password, or the Join Before Host option is enabled for the meeting. Read Register for a Meeting in Cisco Webex Meetings for details.

autoAcceptRequest
boolean

Whether or not meeting registration request is accepted automatically.

requireFirstName
boolean

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

requireLastName
boolean

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

requireEmail
boolean

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

requireJobTitle
boolean

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

requireCompanyName
boolean

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

requireAddress1
boolean

Whether or not registrant's 1st address is required for meeting registration.

requireAddress2
boolean

Whether or not registrant's 2nd address is required for meeting registration.

requireCity
boolean

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

requireState
boolean

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

requireZipCode
boolean

Whether or not registrant's zip code is required for meeting registration.

requireCountryRegion
boolean

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

requireWorkPhone
boolean

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

requireFax
boolean

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

integrationTags
array

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

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.
GET
/v1/meetings{?meetingNumber,webLink,roomId,meetingType,state,participantEmail,isModified,current,max,from,to,hostEmail,siteUrl,integrationTag}
Log in to try the API.
Header
Query Parameters
  • 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 master meeting series is returned.
  • URL encoded link to information page for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive.
  • Associated Teams space room ID for the space meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are mutually exclusive.
  • Meeting type for the meeting objects being requested. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
  • 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/api/guides/webex-meetings-rest-api) guide for more information about the states of meetings.
  • Meeting participant email address for the meeting objects being requested. This parameter only applies when `meetingType` is `meeting`, and it will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
  • 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.
  • 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.
  • 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.
  • Limit the maximum number of meetings in the response, up to 100. This parameter will be ignored if `meetingNumber`, `webLink` or `roomId` is specified.
  • 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 will return details for meetings that are hosted by that user.
  • URL of the Webex site which the API lists meetings from. If not specified, the API lists meetings from user's preferred site. All available Webex sites and preferred site of the user can be retrieved by `Get Site List` API.
  • 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&participantEmail=john.andersen@example.com&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",
            "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,
            "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"
                    }
                ]
            },
            "integrationTags": [
                "dbaeceebea5c4a63ac9d5ef1edfe36b9",
                "85e1d6319aa94c0583a6891280e3437d",
                "27226d1311b947f3a68d6bdf8e4e19a1"
            ]
        },
        {
            "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",
            "integrationTags": [
                "dbaeceebea5c4a63ac9d5ef1edfe36b9",
                "85e1d6319aa94c0583a6891280e3437d",
                "27226d1311b947f3a68d6bdf8e4e19a1"
            ]
        }
    ]
}