List Meetings of a Meeting Series

Lists scheduled meeting and meeting instances of a meeting series identified by meetingSeriesId.

Each scheduled meeting or meeting instance of a meeting series has its own start, end, etc. Thus, for example, when a daily meeting has been scheduled from 2019-04-01 to 2019-04-10, there are 10 scheduled meeting instances in this series, one instance for each day, and each one has its own attributes. When a scheduled meeting has been started and ended or is happening, there are even more ended or in-progress meeting instances.

Use this operation to list scheduled meeting and meeting instances of a meeting series within a specific date range.

Long result sets are split into pages.

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
meetingSeriesId
stringrequired

Unique identifier for the meeting series.

max
number

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

Default: 10
from
string

Start date and time (inclusive) for the range for which meetings are to be returned in any ISO 8601 compliant format. from cannot be after to.

Default: When `meetingType` is `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) for the range for which meetings are to be returned in any ISO 8601 compliant format. to cannot be before from.

Default: When `meetingType` is `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.
meetingType
string

Meeting type for the meeting objects being requested. If not specified, return meetings of all types.

Possible values: scheduledMeeting, meeting
state
string

Meeting state for the meetings being requested. If not specified, return meetings of all states. 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: scheduled, ready, lobby, inProgress, ended, missed
isModified
boolean

Flag identifying whether or not only to retrieve scheduled meeting instances which have been modified. This parameter only applies to scheduled meetings. If it's true, only return modified scheduled meetings; if it's false, only return unmodified scheduled meetings; if not specified, all scheduled meetings will be returned.

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 meetings that are hosted by that user.

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.

meetingSeriesId
string

Unique identifier for meeting series. It only apples to scheduled meeting and meeting instance. If it's a scheduled meeting from a series or a meeting instance that is happening or has happened, the meetingSeriesId is the id of the master series.

scheduledMeetingId
string

Unique identifier for scheduled meeting which current meeting is associated with. It only apples to meeting instance which is happening or has happened. It's the id of the scheduled meeting this instance is associated with.

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.

isModified
boolean

This state only applies to scheduled meeting. Flag identifying whether or not the scheduled meeting has been modified.

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.

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.

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.

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.

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{?meetingSeriesId,meetingType,state,isModified,max,from,to,hostEmail}
Log in to try the API.
Header
Query Parameters
  • Unique identifier for the meeting series.
  • Limit the maximum number of meetings in the response, up to 100.
  • Start date and time (inclusive) for the range for which meetings are to be returned in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.
  • End date and time (exclusive) for the range for which meetings are to be returned in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`.
  • Meeting type for the meeting objects being requested. If not specified, return meetings of all types.
  • Meeting state for the meetings being requested. If not specified, return meetings of all states. 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.
  • Flag identifying whether or not only to retrieve scheduled meeting instances which have been modified. This parameter only applies to scheduled meetings. If it's `true`, only return modified scheduled meetings; if it's `false`, only return unmodified scheduled meetings; if not specified, all scheduled meetings will be returned.
  • 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 meetings that are hosted by that user.
https://webexapis.com/v1/meetings?meetingSeriesId=25bbf831-5be9-4c25-b4b0-9b592c8a086b&max=100&from=2019-03-18T09:30:00+08:00&to=2019-03-25T09:30:00+08:00&meetingType=%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&isModified=false&hostEmail=john.andersen@example.com
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,
            "allowFirstUserToBeCoHost": false,
            "allowAuthenticatedDevices": false,
            "telephony": {
                "accessCode": "1234567890",
                "callInNumbers": [
                    {
                        "label": "US Toll",
                        "callInNumber": "123456789",
                        "tollType": "toll"
                    }
                ],
                "links": [
                    {
                        "rel": "globalCallinNumbers",
                        "href": "/api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers",
                        "method": "GET"
                    }
                ]
            }
        },
        {
            "id": "870f51ff287b41be84648412901e0402_I_167427437874906709",
            "meetingSeriesId": "870f51ff287b41be84648412901e0402",
            "scheduledMeetingId": "870f51ff287b41be84648412901e0402_20191101T120000Z",
            "title": "Example Daily Meeting",
            "agenda": "Example Agenda",
            "meetingType": "meeting",
            "excludePassword": false,
            "publicMeeting": false,
            "state": "ended",
            "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"
        },
        {
            "id": "870f51ff287b41be84648412901e0402_20191102T120000Z",
            "meetingSeriesId": "870f51ff287b41be84648412901e0402",
            "meetingNumber": "123456789",
            "title": "Example Daily Meeting",
            "agenda": "Example Agenda",
            "password": "BgJep@43",
            "phoneAndVideoSystemPassword": "12345678",
            "meetingType": "scheduledMeeting",
            "state": "scheduled",
            "isModified": false,
            "timezone": "UTC",
            "start": "2019-11-02T12:00:00Z",
            "end": "2019-11-02T13: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,
            "allowFirstUserToBeCoHost": false,
            "allowAuthenticatedDevices": false,
            "telephony": {
                "accessCode": "1234567890",
                "callInNumbers": [
                    {
                        "label": "US Toll",
                        "callInNumber": "123456789",
                        "tollType": "toll"
                    }
                ],
                "links": [
                    {
                        "rel": "globalCallinNumbers",
                        "href": "/api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers",
                        "method": "GET"
                    }
                ]
            }
        },
        {
            "id": "870f51ff287b41be84648412901e0402_I_167549011372279170",
            "meetingSeriesId": "870f51ff287b41be84648412901e0402",
            "scheduledMeetingId": "870f51ff287b41be84648412901e0402_20191101T120000Z",
            "title": "Example Daily Meeting",
            "agenda": "Example Agenda",
            "meetingType": "meeting",
            "state": "ended",
            "excludePassword": false,
            "publicMeeting": false,
            "timezone": "UTC",
            "start": "2019-11-02T12:07:30Z",
            "end": "2019-11-02T12:58:53Z",
            "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_167549011372279170"
        }
    ]
}