Webex Admin
The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings.…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
Endpoints 149
Calling Metrics
- GETWebex Calling Call Quality Stats
/v1/analytics/callQualityStatsReturns aggregated Webex Calling call and media-quality statistics for the authenticated organization. A call or media session is classified as good quality…
Service Apps
- POSTCreate Service App Access Token
/applications/:applicationId/tokenRetrieves an organization specific token pair for an already authorized Service App. Service Apps use machine accounts to make API calls on behalf of an…
Admin Audit Events
- GETList Admin Audit Events
/adminAudit/events?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&from=2018-01-01T13:12:11.789Z&to=2018-01-01T14:12:11.789ZList admin audit events in your organization. Several query parameters are available to filter the response. Long result sets will be split into pages. NOTE:… - GETList Admin Audit Event Categories
/adminAudit/eventCategoriesGet the list of all admin event categories.
Authorizations
- GETList authorizations for a user
/authorizationsLists all authorizations for a user. Either personId or personEmail must be provided. This API does not support pagination. - DELETEDelete authorization of org and client ID
/authorizations?clientId=C80fb9c7096bd8474627317ee1d7a817eff372ca9c9cee3ce43c3ea3e8d1511ecDeletes an authorization by org ID and client ID. - DELETEDelete authorization
/authorizations/:authorizationIdDeletes an authorization by authorization ID. Specify the authorization Id in the authorizationId parameter in the URI, which was listed in the list resource. - GETGet expiration status for a token
/authorizations/tokenExpiryEpoch-based expiration time for the token.
Classifications
- GETList classifications
/classificationsList all the space classifications configured in your org.
Data Sources
- POSTRegister a Data Source
/dataSourcesRegister a data source with the Webex BYODS system. Authenticate using a Service App with the spark-admin:datasource_write scope. Schema IDs determine the… - GETRetrieve All Data Sources
/dataSources/Lists all data sources registered by the Service App. Requires the spark-admin:datasource_read scope. - GETRetrieve Data Source Schemas
/dataSources/schemasLists the available data source schemas. A valid API access token is required, but no specific scope is needed. - GETRetrieve Details of a Specific Data Source Schema
/dataSources/schemas/:schemaIdRetrieves details for a specific data source schema by schema ID. A valid API access token is required, but no specific scope is needed. - GETRetrieve Data Source Details
/dataSources/:dataSourceIdRetrieves details for a data source by ID. Use a Service App token with the spark-admin:datasource_read scope. - PUTUpdate a Data Source
/dataSources/:dataSourceIdUpdates a data source. The fields you can update are audience, subject, nonce, url, and tokenLifetimeMinutes. You can set status from active to disabled only… - DELETEDelete a Data Source
/dataSources/:dataSourceIdDeletes a data source by ID. Specify the data source ID in the dataSourceId URI parameter.
Archive Users
- GETQuery Archive User
/identity/organizations/:orgId/v1/ArchivedUser?filter=username eq "test_user_1@example.com"Retrieves archived user information for the specified organization. Supported attributes are id, which is the unique identifier of a user in the system, and…
API - Domain Management
- POSTGet Domain Verification Token
/identity/organizations/:orgId/actions/getDomainVerificationTokenThis endpoint helps generate a token for a given domain within the specified organization. The user needs to add this token as a 'TXT' record to the DNS… - POSTVerify Domain
/identity/organizations/:orgId/actions/verifyDomainThis endpoint helps verify a given domain within the specified organization. This API verifies domain ownership by looking up and validating the 'TXT' record… - POSTClaim Domain
/identity/organizations/:orgId/actions/claimDomainThis endpoint helps claim the given domain within the specified organization. The domain needs to be verified before it can be claimed. Note <callout… - POSTUnverify Domain
/identity/organizations/:orgId/actions/unverifyDomainAfter you unclaim the domain, it will still be verified. Domain enforcement will still apply to the organization. The unverify endpoint helps to remove the… - POSTUnclaim Domain
/identity/organizations/:orgId/actions/unclaimDomainThis API is used to unclaim a domain for the organization. The domain will remain verified, and domain enforcement will still apply to the given organization.…
Identity Organization
- GETGet an organization
/identity/organizations/:orgId<br/> Authorization OAuth token rendered by identity broker. <br/> One of the following OAuth scopes is required: identity:organizations_rw… - PATCHUpdate an organization
/identity/organizations/:orgId<br/> Authorization OAuth token rendered by identity broker. <br/> One of the following OAuth scopes is required: identity:organizations_rw <br/> The… - PATCHUpdate Organization Authentication Configuration Settings
/identity/organizations/:orgId/authenticationConfigUpdate the authentication configuration details, by organizationID. Specify the organization ID in the orgId parameter in the URI. <br/> Authorization OAuth… - PATCHUpdate Organization Password Policy
/identity/organizations/:orgId/passwordPolicyUpdate Organization Password Policy, by organizationID. Specify the organization ID in the orgId parameter in the URI. <br/> Authorization OAuth token… - POSTGenerate OTP
/identity/organizations/:orgId/users/:userId/actions/generateOtpThis API allows an admin to generate a One-Time Password (OTP) for user accounts with userNameType set as partner-upn. The OTP is used by users to log in to…
Events
- GETList Events
/eventsList events in your organization. Several query parameters are available to filter the events returned in the response. Long result sets will be split into… - GETGet Event Details
/events/:eventIdShows details for an event, by event ID. Specify the event ID in the eventId parameter in the URI.
Groups
- GETList and Search Groups
/groupsList groups in your organization. * Set the includeMembers parameter to true to return group members. The total number of members returned is limited to 500.… - POSTCreate a Group
/groupsCreate a new group for a given organization. The group may optionally be created with group members. - GETGet Group Details
/groups/:groupIdGet details for a group, by ID. Optionally, the members may be retrieved with this request. The maximum number of members returned is 500. - DELETEDelete a Group
/groups/:groupIdRemove a group from the system. Specify the group ID in the groupId parameter in the URI. - PATCHUpdate a Group
/groups/:groupIdUpdate the group details, by ID. Specify the group ID in the groupId parameter in the URI. - GETGet Group Members
/groups/:groupId/membersGets the members of a group. * The default maximum members returned is 500. * Control parameters is available to page through the members and to control the…
Guest Management
- POSTCreate a Guest
/guests/tokenCreate a new token for a single guest user. The Service App that creates the guest must have the scope guest-issuer:write. Guests are implicitly created by… - GETGet Guest Count
/guests/countTo retrieve the number of guests, the scopes guest-issuer:read or guest-issuer:write are needed.
Historical Analytics APIs
- GETHistorical Data related to Messaging
/v1/analytics/messagingMetrics/dailyTotalsReturns daily aggregates of various metrics related to Webex messaging. <div><Callout type="error">The base URL for these APIs is analytics.webexapis.com,… - GETHistorical Data related to Room Devices
/v1/analytics/roomDeviceMetrics/dailyTotalsReturns daily aggregates of various metrics related to Room Devices. <div><Callout type="error">The base URL for these APIs is analytics.webexapis.com, which… - GETHistorical Data related to Meetings
/v1/analytics/meetingsMetrics/aggregates?siteUrl=cisco.webex.comReturn aggregates of various metrics related to meetings for a given Webex site over a specified time range. <div><Callout type="error">The base URL for these…
Hybrid Clusters
- GETList Hybrid Clusters
/hybrid/clustersList hybrid clusters for an organization. If no orgId is specified, the default is the organization of the authenticated user. Only an admin auth token with… - GETGet Hybrid Cluster Details
/hybrid/clusters/:hybridClusterIdShows details for a hybrid cluster, by ID. Only an admin auth token with the spark-admin:hybrid_clusters_read scope can see cluster details.
Hybrid Connectors
- GETList Hybrid Connectors
/hybrid/connectorsList hybrid connectors for an organization. If no orgId is specified, the default is the organization of the authenticated user. Only an admin auth token with… - GETGet Hybrid Connector Details
/hybrid/connectors/:connectorIdShows details for a hybrid connector, by ID. Only an admin auth token with the spark-admin:hybrid_connectors_read scope can see connector details.
Licenses
- GETList Licenses
/licensesList all licenses for a given organization. If no orgId is specified, the default is the organization of the authenticated user. Response properties that are… - GETGet License Details
/licenses/:licenseIdShows details for a license, by ID. Specify the license ID in the licenseId parameter in the URI. Use the optional query parameter includeAssignedTo to get a… - PATCHAssign Licenses to Users
/licenses/usersAssign licenses and attendee siteUrls to existing users. Only an admin can assign licenses. Only existing users can be assigned a license. Assign meeting…
Live Monitoring
- POSTGet Live Meeting metrics categorized by Country
/livemonitoring/liveMeetingsByCountryRetrieve live meeting metrics categorized by country for a specific meeting site or for all meeting sites owned by the customer. To retrieve live monitoring…
Meeting Qualities
- GETGet Meeting Qualities
/meeting/qualities?meetingId=e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470Get quality data for a meeting, by meetingId. Only organization administrators can retrieve meeting quality data.
Organization Contacts
- POSTCreate a Contact
/contacts/organizations/:orgId/contactsCreating a new contact for a given organization requires an org admin role. At least one of the following body parameters: phoneNumbers, emails, sipAddresses… - GETGet a Contact
/contacts/organizations/:orgId/contacts/:contactIdShows details for an organization contact by ID. Specify the organization ID in the orgId parameter in the URI, and specify the contact ID in the contactId… - DELETEDelete a Contact
/contacts/organizations/:orgId/contacts/:contactIdRemove a contact from the organization. Only an admin can remove a contact. Specify the organization ID in the orgId parameter in the URI, and specify the… - PATCHUpdate a Contact
/contacts/organizations/:orgId/contacts/:contactIdUpdate details for contact by ID. Only an admin can update a contact. Specify the organization ID in the orgId parameter in the URI, and specify the contact… - GETList Contacts
/contacts/organizations/:orgId/contacts/searchList contacts in the organization. The default limit is 100. keyword can be the value of "displayName", "firstName", "lastName", "email". An empty string of… - POSTBulk Create or Update Contacts
/contacts/organizations/:orgId/contacts/bulkCreate or update contacts in bulk. Update an existing contact by specifying the contact ID in the contactId parameter in the request body. - POSTBulk Delete Contacts
/contacts/organizations/:orgId/contacts/bulk/deleteDelete contacts in bulk.
Organizations
- GETList Organizations
/organizationsList all organizations visible by your account. The results will not be paginated. - GETGet Organization Details
/organizations/:orgIdShows details for an organization, by ID. Specify the org ID in the orgId parameter in the URI. - DELETEDelete Organization
/organizations/:orgIdDeletes an organization, by ID. It may take up to 10 minutes for the organization to be deleted after the response is returned. <br/><br/> Specify the org ID…
Partner Administrators
- GETGet all customers managed by a partner admin
/partner/organizations?managedBy=Y2LZY29ZCGFYAZOVL3VZL1BFT1BMRS9JOTYWOTZIYI1KYTRHLTQ3NZETYTC2ZI1KNDEZODQWZWVM1TQGet all customer organizations managed by given partner admin, in the managedBy request parameter. The managedBy user typically has the role of a Partner… - GETGet all partner admins assigned to a customer
/partner/organizations/:orgId/partnerAdminsFor a given customer, get all the partner admins with their role details. This does not include partner admins who have access through Customer Groups. This… - POSTAssign partner admin to a customer
/partner/organizations/:orgId/partnerAdmin/:personId/assignAssign a specific Partner Admin to a customer organization. The partner admin is a user that has the Partner Administrator role. Other partner roles, such as… - DELETEUnassign partner admin from a customer
/partner/organizations/:orgId/partnerAdmin/:personId/unassignUnassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the… - DELETERevoke all partner admin roles for a given person ID
/partner/organizations/partnerAdmin/:personIdRevoke all partner administrator roles from a user, thereby revoking access to Partner Hub and all managed customer organizations. This action does not grant…
Partner Reports/Templates
- GETList Reports
/partner/reportsLists all reports previously generated from a given region. Use query parameters to filter the response. The parameters are optional. To access this endpoint,… - POSTCreate a Report
/partner/reportsCreate a new report. A new report can be created using templateId available from the _List Report Templates_ API. For each templateId, there are a set of… - GETGet Report Details
/partner/reports/:reportIdShows details for a report by report ID. Specify the report ID in the reportId parameter in the URI. To access this endpoint, you must use an administrator… - DELETEDelete a Report
/partner/reports/:reportIdRemove a report from the system. Specify the report ID in the reportId parameter in the URI To access this endpoint, you must use an administrator token with… - GETList Report Templates
/partner/reports/templatesList report templates. Report templates are available for use with the Partner Reports API. To access this endpoint, you must use an administrator token with…
People
- GETList People
/peopleList people in your organization. For most users, either the email or displayName parameter is required. Admin users can omit these fields and list all users… - POSTCreate a Person
/peopleCreate a new user account for a given organization. Only an admin can create a new user account. At least one of the following body parameters is required to… - GETGet Person Details
/people/:personIdShows details for a person, by ID. Response properties associated with a user's presence status, such as status or lastActivity, will only be displayed for… - PUTUpdate a Person
/people/:personIdUpdate details for a person, by ID. Specify the person ID in the personId parameter in the URI. Only an admin can update a person details. Include all details… - DELETEDelete a Person
/people/:personIdRemove a person from the system. Required Administrator Roles: The following administrators have permission to use this API: Customer Organization: Full… - GETGet My Own Details
/people/meGet profile details for the authenticated user. This is the same as GET /people/{personId} using the Person ID associated with your Auth token. Admin users…
Recording Report
- GETList of Recording Audit Report Summaries
/recordingReport/accessSummaryLists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return. Only recording… - GETGet Recording Audit Report Details
/recordingReport/accessDetail?recordingId=4f914b1dfe3c4d11a61730f18c0f5387Retrieves details for a recording audit report with a specified recording ID. Only recording audit report details of meetings hosted by or shared with the… - GETList Meeting Archive Summaries
/recordingReport/meetingArchiveSummariesLists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return. Meeting archive summaries are… - GETGet Meeting Archive Details
/recordingReport/meetingArchives/:archiveIdRetrieves details for a meeting archive report with a specified archive ID, which contains recording metadata. Meeting archive details are only available to…
Recordings
- GETList Recordings
/recordings<div><Callout type="warning">This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for… - POSTQuery Recordings
/recordings/queryQueries recordings with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and… - GETList Recordings For an Admin or Compliance Officer
/admin/recordings<div><Callout type="warning">This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for… - POSTQuery Recordings For an Admin or Compliance Officer
/admin/recordings/queryQueries recordings for an admin or compliance officer with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number… - DELETEDelete a Recording By an Admin
/admin/recordings/:recordingIdRemoves a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host,… - GETGet Recording Details
/recordings/:recordingIdRetrieves details for a recording with a specified recording ID. Only recordings of meetings hosted by or shared with the authenticated user may be retrieved.… - DELETEDelete a Recording
/recordings/:recordingIdRemoves a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the… - POSTMove Recordings into the Recycle Bin
/recordings/softDeleteMove recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by Restore Recordings from Recycle Bin API. If you'd… - POSTRestore Recordings from Recycle Bin
/recordings/restoreRestore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin. * If… - POSTPurge Recordings from Recycle Bin
/recordings/purgePurge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin. Only recordings of meetings hosted by the… - POSTShare a Recording
/recordings/:recordingId/accessListShare or unshare a recording with other users by recording ID and email addresses. - POSTShare a Recording Link
/recordings/accessListShare or unshare a recording with other users by recording link and email addresses. - GETList Group Recordings
/group/recordingsList group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and… - GETGet Group Recording Details
/group/recordings/:recordingIdRetrieves details for a group recording for a service app which has group recording access. * Only recordings which are in the available status and not shared…
Report Templates
- GETList Report Templates
/report/templatesList all the available report templates that can be generated. CSV (comma separated value) reports for Webex services are only supported for organizations…
Reports
- GETList Reports
/reportsLists all reports. Use query parameters to filter the response. The parameters are optional. However, from and to parameters should be provided together.… - POSTCreate a Report
/reportsCreate a new report. For each templateId, there are a set of validation rules that need to be followed. For example, for templates belonging to Webex, the… - GETGet Report Details
/reports/:reportIdShows details for a report, by report ID. Specify the report ID in the reportId parameter in the URI. Notes: CSV reports for Webex suite services are only… - DELETEDelete a Report
/reports/:reportIdRemove a report from the system. Specify the report ID in the reportId parameter in the URI CSV reports for Webex suite services are only supported for…
Resource Group Memberships
- GETList Resource Group Memberships
/resourceGroup/membershipsLists all resource group memberships for an organization. Use query parameters to filter the response. - GETList Resource Group Memberships V2
/resourceGroup/memberships/v2Lists all resource group memberships for an organization having filtering option based on entity type (User / Workspace). Use query parameters to filter the… - GETGet Resource Group Membership Details
/resourceGroup/memberships/:resourceGroupMembershipIdShows details for a resource group membership, by ID. Specify the resource group membership ID in the resourceGroupMembershipId URI parameter. - PUTUpdate a Resource Group Membership
/resourceGroup/memberships/:resourceGroupMembershipIdUpdates a resource group membership, by ID. Specify the resource group membership ID in the resourceGroupMembershipId URI parameter. Only the resourceGroupId…
Resource Groups
- GETList Resource Groups
/resourceGroupsList resource groups. Use query parameters to filter the response. - GETGet Resource Group Details
/resourceGroups/:resourceGroupIdShows details for a resource group, by ID. Specify the resource group ID in the resourceGroupId parameter in the URI.
Roles
- GETList Roles
/rolesList all roles. Must be called by an admin user. - GETGet Role Details
/roles/:roleIdShows details for a role, by ID. Specify the role ID in the roleId parameter in the URI.
Bulk Manage SCIM 2 Users and Groups
- POSTUser bulk API
/identity/scim/:orgId/v2/Bulk<br/> Authorization OAuth token rendered by Identity Broker. <br/> One of the following OAuth scopes is required: identity:people_rw <br/> Usage: 1. The input…
SCIM 2 Groups
- GETSearch groups
/identity/scim/:orgId/v2/GroupsRetrieve a list of groups in the organization. Long result sets are split into pages. <br/> Authorization An OAuth token rendered by Identity Broker. <br/>… - POSTCreate a group
/identity/scim/:orgId/v2/GroupsCreate a new group for a given organization. The group may optionally be created with group members. <br/> Authorization OAuth token returned by Identity… - GETGet a group
/identity/scim/:orgId/v2/Groups/:groupIdRetrieve details for a group, by ID. Optionally, members can be retrieved with this request. The maximum number of members returned is 500. <br/>… - PUTUpdate a group with PUT
/identity/scim/:orgId/v2/Groups/:groupIdReplace the contents of the Group. Specify the group ID in the groupId parameter in the URI. <br/> Authorization OAuth token returned by Identity Broker.… - DELETEDelete a group
/identity/scim/:orgId/v2/Groups/:groupIdRemove a group from the system. Specify the group ID in the groupId parameter in the URI. <br/> Authorization OAuth token rendered by Identity Broker. <br/>… - PATCHUpdate a group with PATCH
/identity/scim/:orgId/v2/Groups/:groupIdUpdate group attributes with PATCH. Specify the group ID in the groupId parameter in the URI. <br/> Authorization OAuth token returned by Identity Broker.… - GETGet Group Members
/identity/scim/:orgId/v2/Groups/:groupId/MembersReturns the members of a group. The default maximum number of members returned is 500. Control parameters are available to page through the members and to…
SCIM 2 Schemas
- GETGet Group Schema
/Schemas/SCIM2/GroupThis API allows the service client to get all the Group schemas information from CI. Authorization: OAuth token rendered by Identity Broker. One of the… - GETGet User Schema
/Schemas/SCIM2/UserThis API allows the service client to get all the User schemas information from CI. Authorization: OAuth token rendered by Identity Broker. One of the… - GETGet Schema using Group Schema ID
/Schemas/SCIM2/:schemaIdThis API allows the service client to get the Group/User Schema using Schema Id from CI. Example: urn:ietf:params:scim:schemas:core:2.0:Group is one of the…
SCIM 2 Users
- GETSearch users
/identity/scim/:orgId/v2/Users<br/> Authorization OAuth token rendered by Identity Broker. <br/> One of the following OAuth scopes is required: identity:people_rw identity:people_read… - POSTCreate a user
/identity/scim/:orgId/v2/UsersThe SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as… - GETGet a user
/identity/scim/:orgId/v2/Users/:userId<br/> Authorization OAuth token rendered by Identity Broker. <br/> One of the following OAuth scopes is required: identity:people_rw identity:people_read… - PUTUpdate a user with PUT
/identity/scim/:orgId/v2/Users/:userId<br/> Authorization OAuth token rendered by Identity Broker. <br/> One of the following OAuth scopes is required: identity:people_rw <br/> The following… - DELETEDelete a user
/identity/scim/:orgId/v2/Users/:userId<br/> Authorization OAuth token rendered by Identity Broker. <br/> One of the following OAuth scopes is required: identity:people_rw <br/> The following… - PATCHUpdate a user with PATCH
/identity/scim/:orgId/v2/Users/:userId<br/> Authorization OAuth token rendered by Identity Broker. <br/> One of the following OAuth scopes is required: identity:people_rw <br/> The following… - GETGet Me
/identity/scim/v2/Users/me<br/> Authorization OAuth token rendered by Identity Broker. <br/> One of the following OAuth scopes is required: identity:people_rw identity:people_read…
Security Audit Events
- GETList Security Audit Events
/admin/securityAudit/events?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&startTime=2018-01-01T13:12:11.789Z&endTime=2018-01-01T14:12:11.789ZList Security Audit Events. This API currently returns user sign-in and sign-out data. To call this API the audit:events_read scope must be selected for the…
Send Activation Email
- POSTInitiate Bulk Activation Email Resend Job
/identity/organizations/:orgId/jobs/sendActivationEmailsInitiate a bulk activation email resend job that sends an activation email to all eligible users in an organization. Only a single instance of the job can be… - GETGet Bulk Activation Email Resend Job Status
/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/statusGet the details of an activation email resend job by its job ID. Requires a full or user administrator auth token with a scope of spark-admin:people_write or… - GETGet Bulk Activation Email Resend Job Errors
/identity/organizations/:orgId/jobs/sendActivationEmails/:jobId/errorsGet errors of an activation email resend job by its job ID. Requires a full or user administrator auth token with a scope of spark-admin:people_write or…
Settings
- GETGet an Organization Setting
/settings/organizations/:orgId/settings/:settingKeyThis endpoint retrieves the specified setting for the given organization and is accessible with the scope 'identity:organizations_read'. - POSTCreate or Update an Organization Setting
/settings/organizations/:orgId/settingsThis endpoint creates or updates the specified setting for the given organization; however, the 'name' of the setting cannot be modified. It is accessible…
Partner Tags
- GETRetrieve all customer tags
/partner/tags?type=ORGANIZATIONRetrieves all tags which are being used by any customer organizations. Once a tag is unassigned from the last customer, it is automatically removed and is not… - POSTCreate or Replace existing customer tags with the provided ones
/partner/tags/organizations/:orgId/assignTagsAssign or replace tag(s) which for a customer organization. If the tag doesn't already exist, a new one is created and assigned to the customer automatically.… - GETGet customer organization's tags
/partner/tags/organizations/:orgIdRetrieve tags associated with a customer organization based on the orgId provided. This API can be used by a partner full admin, a read-only partner, or an… - GETFetch all customers for a given set of tags
/partner/tags/organizations?tags=Tag1,Tag2For a set of tags, retrieve all customer organizations that match any one of the tags. This API can be used by a partner full admin, a read-only partner, or… - POSTCreate or Replace existing subscription tags with the provided ones
/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTagsAssign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions. This API can be used by… - GETSubscription List on a given tag name or a set of tags
/partner/tags/subscriptions?tags=Tag1,Tag2For a partner organization fetch all it's subscriptions with their tag list for a given tag names. This API can be used by partner full admins, partner admins… - GETFetch a Subscription
/partner/tags/organizations/:orgId/subscriptions/:subscriptionIdFor a given partner org, customer org and external subscription id, fetch subscription details with its associated tags. This API can be used by partner full…
Workspace Locations
- GETList Workspace Locations
/workspaceLocationsDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - POSTCreate a Workspace Location
/workspaceLocationsDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - GETGet a Workspace Location Details
/workspaceLocations/:locationIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - PUTUpdate a Workspace Location
/workspaceLocations/:locationIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - DELETEDelete a Workspace Location
/workspaceLocations/:locationIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - GETList Workspace Location Floors
/workspaceLocations/:locationId/floorsDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - POSTCreate a Workspace Location Floor
/workspaceLocations/:locationId/floorsDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - GETGet a Workspace Location Floor Details
/workspaceLocations/:locationId/floors/:floorIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - PUTUpdate a Workspace Location Floor
/workspaceLocations/:locationId/floors/:floorIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API… - DELETEDelete a Workspace Location Floor
/workspaceLocations/:locationId/floors/:floorIdDeprecated. <div><Callout type="warning">The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API…
Workspace Metrics
- GETWorkspace Metrics
/workspaceMetrics?workspaceId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&metricName=temperatureGet metric data for the specified workspace and metric name, optionally aggregated over a specified time period. * The workspaceId and metricName parameters… - GETWorkspace Duration Metrics
/workspaceDurationMetrics?workspaceId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWEGet metrics for how much time a workspace has been in the state given by the measurement parameter. For example, if the measurement is timeBooked then the…
API details
- Authentication
- A bearer token in the Authorization header
OAuth 2.0 (authorization code flow)
OAuth 2.0 (authorization code flow) with 1 scope - Operations
- 149 operations on 116 pathsGET 83POST 34DELETE 17PATCH 8PUT 7
10 marked deprecated - Main resources
- Recordings 14Workspace Locations 10Data Sources 7Organization Contacts 7Partner Tags 7SCIM 2 Groups 7SCIM 2 Users 7Groups 6People 6API - Domain Management 5
- Response formats
application/jsonapplication/json;charset=utf-8text/plain- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Webex's published OpenAPI description (webex/webex-openapi-specs) (CC-BY-4.0)
How to test the Webex Admin in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Webex Admin collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Webex Calling Call Quality Stats” (GET /v1/analytics/callQualityStats), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Webex Admin?
The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings.… It is listed under Communication and has 149 endpoints.
Who publishes the Webex Admin?
It is listed from Webex's public API description (an OpenAPI document), not published by Webex on Swastik Codes. Anyone who controls webex.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Webex Admin?
It accepts 3 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow); OAuth 2.0 (authorization code flow) with 1 scope.
How many endpoints does the Webex Admin have?
149 operations on 116 paths (83 GET, 34 POST, 17 DELETE, 8 PATCH, 7 PUT). The largest groups are Recordings, Workspace Locations, Data Sources, Organization Contacts.
Is forking the Webex Admin free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.