Webex Meetings — Meetings. 45 operations. Lead operation: List Meetings By an Admin. Self-contained Naftiko capability covering one Webex business surface.
naftiko: 1.0.0-alpha2
info:
label: Webex Meetings — Meetings
description: 'Webex Meetings — Meetings. 45 operations. Lead operation: List Meetings By an Admin. Self-contained Naftiko
capability covering one Webex business surface.'
tags:
- Webex
- Meetings
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
WEBEX_API_KEY: WEBEX_API_KEY
capability:
consumes:
- type: http
namespace: meeting-meetings
baseUri: ''
description: Webex Meetings — Meetings business capability. Self-contained, no shared references.
resources:
- name: admin-meetings
path: /admin/meetings
operations:
- name: adminlistmeetings
method: GET
description: List Meetings By an Admin
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingNumber
in: query
type: string
description: Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually
exclusive. If it's an exceptional meeting from a meeting seri
- name: webLink
in: query
type: string
description: URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink`
are mutually exclusive.
- name: current
in: query
type: boolean
description: Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting
series. This parameter only applies to scenarios where `m
- name: timezone
in: header
type: string
description: e.g. UTC
- name: admin-meetings-meetingId
path: /admin/meetings/{meetingId}
operations:
- name: admingetmeetingbyid
method: GET
description: Get a Meeting By an Admin
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting being requested.
required: true
- name: current
in: query
type: boolean
description: Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting
ready to join or start or the upcoming meeting of the meet
- name: timezone
in: header
type: string
description: e.g. UTC
- name: meetings
path: /meetings
operations:
- name: createmeeting
method: POST
description: Create a Meeting
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: listmeetings
method: GET
description: List Meetings
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingNumber
in: query
type: string
description: Meeting number for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId` are
mutually exclusive. If it's an exceptional meeting from a me
- name: webLink
in: query
type: string
description: URL encoded link to information page for the meeting objects being requested. `meetingNumber`, `webLink`
and `roomId` are mutually exclusive.
- name: roomId
in: query
type: string
description: Associated Webex space ID for the meeting objects being requested. `meetingNumber`, `webLink` and `roomId`
are mutually exclusive.
- name: meetingSeriesId
in: query
type: string
description: Unique identifier for the meeting series. The meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Web
- name: max
in: query
type: number
description: Limit the maximum number of meetings in the response, up to 100. This parameter is ignored if `meetingNumber`,
`webLink` or `roomId` is specified. The default v
- name: from
in: query
type: string
description: '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. '
- name: to
in: query
type: string
description: 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. `t
- name: meetingType
in: query
type: string
description: Meeting type for the meeting objects being requested. This parameter will be ignored if `meetingNumber`,
`webLink` or `roomId` is specified.
- name: state
in: query
type: string
description: Meeting state for the meeting objects being requested. If not specified, return meetings of all states.
This parameter will be ignored if `meetingNumber`, `webL
- name: scheduledType
in: query
type: string
description: Scheduled type for the meeting objects being requested.
- name: isModified
in: query
type: boolean
description: Flag identifying whether a meeting has been modified. Only applies to scheduled meetings. If `true`,
only return modified scheduled meetings; if `false`, only r
- name: hasChat
in: query
type: boolean
description: 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
- name: hasRecording
in: query
type: boolean
description: Flag identifying meetings which have been recorded. Only applies to ended meeting instances. If true,
only return meeting instances which have been recorded; if
- name: hasTranscription
in: query
type: boolean
description: Flag identifying meetings with transcripts. Only applies to ended meeting instances. If `true`, only
return meeting instances which have transcripts; if `false`
- name: hasSummary
in: query
type: boolean
description: Flag identifying meetings with summaries. Only applies to ended meeting instances. If `true`, only
return meeting instances which have summaries; if `false`, on
- name: hasClosedCaption
in: query
type: boolean
description: Flag identifying meetings with closed captions. Only applies to ended meeting instances. If `true`,
only return meeting instances which have closed captions; if
- name: hasPolls
in: query
type: boolean
description: Flag identifying meetings with polls. Only applies to ended meeting instances. If `true`, only return
meeting instances which have polls; if `false`, only retur
- name: hasQA
in: query
type: boolean
description: 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 me
- name: hasSlido
in: query
type: boolean
description: Flag identifying meetings with Slido interactions. Only applies to ended meeting instances. If `true`,
only return meeting instances which have Slido interactio
- name: current
in: query
type: boolean
description: Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting
series. This parameter only applies to scenarios where th
- name: hostEmail
in: query
type: string
description: 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 spe
- name: siteUrl
in: query
type: string
description: 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 c
- name: integrationTag
in: query
type: string
description: 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
- name: password
in: header
type: string
description: e.g. BgJep@4323
- name: timezone
in: header
type: string
description: e.g. UTC
- name: meetings-controls
path: /meetings/controls
operations:
- name: getmeetingcontrol
method: GET
description: Get Meeting Control Status
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: query
type: string
description: Unique identifier for the meeting. Does not support meeting IDs for a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Room
required: true
- name: updatemeetingcontrol
method: PUT
description: Update Meeting Control Status
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: query
type: string
description: Unique identifier for the meeting. Does not support meeting IDs for a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Room
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: meetings-join
path: /meetings/join
operations:
- name: meetingjoin
method: POST
description: Join a Meeting
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: meetings-reassignHost
path: /meetings/reassignHost
operations:
- name: reassignhost
method: POST
description: Reassign Meetings to a New Host
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: siteUrl
in: header
type: string
description: e.g. example.webex.com
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: meetings-sessionTypes
path: /meetings/sessionTypes
operations:
- name: listmeetingsessiontypes
method: GET
description: List Meeting Session Types
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: hostEmail
in: query
type: string
description: Email address for the user. 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
- name: siteUrl
in: query
type: string
description: Webex site URL to query. If `siteUrl` is not specified, the users' preferred site will be used. If
the authorization token has the admin-level scopes, the admin
- name: meetings-sessionTypes-sessionTypeId
path: /meetings/sessionTypes/{sessionTypeId}
operations:
- name: getmeetingsessiontypebyid
method: GET
description: Get a Meeting Session Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: sessionTypeId
in: path
type: number
description: A unique identifier for the sessionType.
required: true
- name: hostEmail
in: query
type: string
description: Email address for the user. 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
- name: siteUrl
in: query
type: string
description: Webex site URL to query. If `siteUrl` is not specified, the users' preferred site will be used. If
the authorization token has the admin-level scopes, the admin
- name: meetings-templates
path: /meetings/templates
operations:
- name: listtemplates
method: GET
description: List Meeting Templates
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateType
in: query
type: string
description: Meeting template type for the meeting template objects being requested. If not specified, return meeting
templates of all types.
- name: locale
in: query
type: string
description: Locale for the meeting template objects being requested. If not specified, return meeting templates
of the default `en_US` locale. Refer to [Meeting Template Lo
- name: isDefault
in: query
type: boolean
description: The value is `true` or `false`. If it's `true`, return the default meeting templates; if it's `false`,
return the non-default meeting templates. If it's not spe
- name: isStandard
in: query
type: boolean
description: The value is `true` or `false`. If it's `true`, return the standard meeting templates; if it's `false`,
return the non-standard meeting templates. If it's not s
- name: hostEmail
in: query
type: string
description: 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 spe
- name: siteUrl
in: query
type: string
description: URL of the Webex site which the API lists meeting templates from. If not specified, the API lists meeting
templates from user's preferred site. All available We
- name: meetings-templates-templateId
path: /meetings/templates/{templateId}
operations:
- name: gettemplatebyid
method: GET
description: Get a Meeting Template
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: templateId
in: path
type: string
description: Unique identifier for the meeting template being requested.
required: true
- name: hostEmail
in: query
type: string
description: 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 spe
- name: timezone
in: header
type: string
description: e.g. UTC
- name: meetings-trackingCodes
path: /meetings/trackingCodes
operations:
- name: getmeetinghosttrackingcodes
method: GET
description: List Meeting Tracking Codes
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: siteUrl
in: query
type: string
description: 'URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves
the tracking code from the user''s preferred site. All '
- name: service
in: query
type: string
description: Service for schedule or sign-up pages.
required: true
- name: hostEmail
in: query
type: string
description: Email address for the meeting host. This parameter is only used if a user or application calling the
API has the admin-level scopes. The admin may specify the e
- name: meetings-meetingId
path: /meetings/{meetingId}
operations:
- name: getmeetingbyid
method: GET
description: Get a Meeting
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting being requested.
required: true
- name: current
in: query
type: boolean
description: Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting
ready to join or start or the upcoming meeting of the meet
- name: hostEmail
in: query
type: string
description: 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 spe
- name: password
in: header
type: string
description: e.g. BgJep@4323
- name: timezone
in: header
type: string
description: e.g. UTC
- name: patchmeeting
method: PATCH
description: Patch a Meeting
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled
meetings. It doesn't apply to ended or in-progress meeti
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: updatemeeting
method: PUT
description: Update a Meeting
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled
meetings. It doesn't apply to ended or in-progress meeti
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: deletemeeting
method: DELETE
description: Delete a Meeting
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting to be deleted. This parameter applies to meeting series and scheduled
meetings. It doesn't apply to ended or in-progress meeti
required: true
- name: hostEmail
in: query
type: string
description: 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 spe
- name: sendEmail
in: query
type: boolean
description: Whether or not to send emails to host and invitees. It is an optional field and default value is true.
- name: meetings-meetingId-breakoutSessions
path: /meetings/{meetingId}/breakoutSessions
operations:
- name: listbreakoutsessions
method: GET
description: List Meeting Breakout Sessions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting. This parameter applies to meeting series, scheduled meeting and
ended or ongoing meeting instance objects. Please note that c
required: true
- name: hostEmail
in: header
type: string
description: e.g. `[email protected]` (string, optional) - Email address for the meeting host. This parameter
is only used if the user or application calling the API
- name: updatebreakoutsessions
method: PUT
description: Update Meeting Breakout Sessions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting. Does not support meeting IDs for a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Room
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: deletebreakoutsessions
method: DELETE
description: Delete Meeting Breakout Sessions
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting. This parameter applies to meeting series and scheduled meetings.
It doesn't apply to ended or in-progress meeting instances.
required: true
- name: sendEmail
in: query
type: boolean
description: Whether or not to send emails to host and invitees. It is an optional field and default value is true.
- name: hostEmail
in: header
type: string
description: e.g. `[email protected]` (string, optional) - Email address for the meeting host. This parameter
is only used if the user or application calling the API
- name: meetings-meetingId-end
path: /meetings/{meetingId}/end
operations:
- name: endmeeting
method: POST
description: End a Meeting
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting to be ended.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: meetings-meetingId-interpreters
path: /meetings/{meetingId}/interpreters
operations:
- name: createinterpreter
method: POST
description: Create a Meeting Interpreter
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting to which the interpreter is to be assigned.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: listinterpreters
method: GET
description: List Meeting Interpreters
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting for which interpreters are being requested. The meeting can be meeting
series, scheduled meeting or meeting instance which has
required: true
- name: hostEmail
in: query
type: string
description: 'Email address for the meeting host. This parameter is only used if the user or application calling
the API has the admin on-behalf-of scopes. If set, the admin '
- name: meetings-meetingId-interpreters-interpreterId
path: /meetings/{meetingId}/interpreters/{interpreterId}
operations:
- name: getinterpreterbyid
method: GET
description: Get a Meeting Interpreter
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting to which the interpreter has been assigned.
required: true
- name: interpreterId
in: path
type: string
description: Unique identifier for the interpreter whose details are being requested.
required: true
- name: hostEmail
in: query
type: string
description: 'Email address for the meeting host. This parameter is only used if the user or application calling
the API has the admin on-behalf-of scopes. If set, the admin '
- name: updateinterpreterbyid
method: PUT
description: Update a Meeting Interpreter
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting whose interpreters were belong to.
required: true
- name: interpreterId
in: path
type: string
description: Unique identifier for the interpreter whose details are being requested.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: deleteinterpreterbyid
method: DELETE
description: Delete a Meeting Interpreter
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting whose interpreters were belong to.
required: true
- name: interpreterId
in: path
type: string
description: Unique identifier for the interpreter to be removed.
required: true
- name: hostEmail
in: query
type: string
description: 'Email address for the meeting host. This parameter is only used if the user or application calling
the API has the admin on-behalf-of scopes. If set, the admin '
- name: sendEmail
in: query
type: boolean
description: If `true`, send email to the interpreter.
- name: meetings-meetingId-invitationSources
path: /meetings/{meetingId}/invitationSources
operations:
- name: createinvitationsources
method: POST
description: Create Invitation Sources
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting. Only the meeting ID of a scheduled webinar is supported for this
API.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: listinvitationsources
method: GET
description: List Invitation Sources
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting. Only the meeting ID of a scheduled webinar is supported for this
API.
required: true
- name: hostEmail
in: header
type: string
description: e.g. [email protected]
- name: personId
in: header
type: string
description: e.g. Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI
- name: meetings-meetingId-registrants
path: /meetings/{meetingId}/registrants
operations:
- name: createregistrant
method: POST
description: Register a Meeting Registrant
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs
of scheduled meetings, meeting instances, or scheduled pers
required: true
- name: current
in: query
type: boolean
description: Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting
ready to join or start or the upcoming meeting of the meet
- name: hostEmail
in: query
type: string
description: 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 spe
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: listmeetingregistrants
method: GET
description: List Meeting Registrants
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: meetingId
in: path
type: string
description: Unique identifier for the meeting. Only the ID of the meeting series is supported for meetingId. IDs
of scheduled meetings, meeting instances, or scheduled pers
required: true
- name: max
in: query
type: number
description: Limit the maximum number of registrants in the response, up to 100. The default is 10.
- name: hostEmail
in: query
type: string
description: 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 spe
- name: current
in: query
type: boolean
description: Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting
ready to join or start or the upcoming meeting of the meet
- name: email
in: query
type: string
description: Registrant's email to filter registrants.
- name: registrationTimeFrom
in: query
type: string
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/capabilities/meeting-meetings.yaml