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

List Meeting Templates

Retrieves the list of meeting templates that is available for the authenticated user.

There are separate lists of meeting templates for different templateType, locale and siteUrl.

  • If templateType is specified, the operation returns an array of meeting template objects specified by the templateType; otherwise, returns an array of meeting template objects of all template types.

  • If locale is specified, the operation returns an array of meeting template objects specified by the locale; otherwise, returns an array of meeting template objects of the default en_US locale. Refer to Meeting Template Locales for all the locales supported by Webex.

  • If the parameter siteUrl has a value, the operation lists meeting templates on the specified site; otherwise, lists meeting templates on the user's preferred site. All available Webex sites and preferred site of the user can be retrieved by Get Site List API.

GET/v1/meetings/templates
Query Parameters
templateType
string

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

Possible values: meeting, webinar
locale
string

Locale for the meeting template objects being requested. If not specified, return meeting templates of the default en_US locale. Refer to Meeting Template Locales for all the locales supported by Webex.

Default: en_US
isDefault
boolean

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 specified, return both default and non-default meeting templates.

isStandard
boolean

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 specified, return both standard and non-standard meeting templates.

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 meeting templates that are available for that user.

siteUrl
string

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 Webex sites and preferred site of the user can be retrieved by Get Site List API.

Response Properties
items
array[TemplateObject]

Meeting templates array

id
string

Unique identifier for meeting template.

name
string

Meeting template name.

locale
string

Meeting template locale.

siteUrl
string

Site URL for the meeting template.

templateType
enum

Meeting template type.

meeting
string

Webex meeting.

webinar
string

Webex webinar.

isDefault
boolean

Whether or not the meeting template is a default template.

isStandard
boolean

Whether or not the meeting template is a standard template.

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/templates{?templateType,locale,isDefault,isStandard,hostEmail,siteUrl}
Log in to try the API.
Header
Query Parameters
  • Meeting template type for the meeting template objects being requested. If not specified, return meeting templates of all types.
  • Locale for the meeting template objects being requested. If not specified, return meeting templates of the default `en_US` locale. Refer to [Meeting Template Locales](/docs/meetings#meeting-template-locales) for all the locales supported by Webex.
  • 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 specified, return both default and non-default meeting templates.
  • 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 specified, return both standard and non-standard meeting templates.
  • 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 meeting templates that are available for that user.
  • 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 Webex sites and preferred site of the user can be retrieved by `Get Site List` API.
https://webexapis.com/v1/meetings/templates?templateType=%5Bobject%20Object%5D,%5Bobject%20Object%5D&locale=en_US&isDefault=false&isStandard=false&hostEmail=john.andersen@example.com&siteUrl=site4-example.webex.com
200 / OK
{
    "items": [
        {
            "id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM",
            "name": "Meeting template 1",
            "locale": "en_US",
            "siteUrl": "site4-example.webex.com",
            "templateType": "meeting",
            "isDefault": false,
            "isStandard": false
        },
        {
            "id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NjctTUMtZW5fVVMtTA",
            "name": "Meeting template 2",
            "locale": "en_US",
            "siteUrl": "site4-example.webex.com",
            "templateType": "meeting",
            "isDefault": false,
            "isStandard": true
        },
        {
            "id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6Ry0wLU1DLWVuX1VT",
            "name": "Webex Meetings Default",
            "locale": "en_US",
            "siteUrl": "site4-example.webex.com",
            "templateType": "meeting",
            "isDefault": true,
            "isStandard": true
        },
        {
            "id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA1NjctTUMtZW5fVVMtTA",
            "name": "Webinar template 1",
            "locale": "en_US",
            "siteUrl": "site4-example.webex.com",
            "templateType": "webinar",
            "isDefault": false,
            "isStandard": false
        },
        {
            "id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA4NzctTUMtZW5fVVMtTA",
            "name": "Webinar template 2",
            "locale": "en_US",
            "siteUrl": "site4-example.webex.com",
            "templateType": "webinar",
            "isDefault": false,
            "isStandard": false
        },
        {
            "id": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6Ry0yLU1DLWVuX1VTLUw",
            "name": "Webex Events Default",
            "locale": "en_US",
            "siteUrl": "site4-example.webex.com",
            "templateType": "webinar",
            "isDefault": false,
            "isStandard": true
        }
    ]
}