DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks Enterprises
GETList BroadWorks Enterprises
PUTUpdate Directory Sync for a BroadWorks Enterprise
POSTTrigger Directory Sync for an Enterprise
GETGet Directory Sync Status for an Enterprise
POSTTrigger Directory Sync for a User
BroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks Enterprises
GETList BroadWorks Enterprises
PUTUpdate Directory Sync for a BroadWorks Enterprise
POSTTrigger Directory Sync for an Enterprise
GETGet Directory Sync Status for an Enterprise
POSTTrigger Directory Sync for a User
BroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

List BroadWorks Enterprises

List the provisioned enterprises for a Service Provider. This API also lets a Service Provider search for their provisioned enterprises on Webex. A search on enterprises can be performed by either a full or partial enterprise identifier.

GET/v1/broadworks/enterprises
Query Parameters
spEnterpriseId
string

The Service Provider supplied unique identifier for the subscriber's enterprise.

startsWith
string

The starting string of the enterprise identifiers to match against.

max
number

Limit the number of enterprises returned in the search, up to 1000.

Default: 100
Response Properties
id
string

A unique Cisco identifier for the enterprise.

orgId
string

The Organization ID of the enterprise on Webex.

provisioningId
string

The Provisioning ID associated with the enterprise.

spEnterpriseId
string

The Service Provider supplied unique identifier for the subscriber's enterprise.

broadworksDirectorySync
object

BroadWorks Directory sync

enableDirSync
boolean

The toggle to enable/disable directory sync.

directorySyncStatus
object

Directory sync status

lastSyncStartTime
string

The start date and time of the last sync.

lastSyncEndTime
string

The end date and time of the last sync.

syncStatus
string

The sync status of the enterprise.

usersAdded
number

The number of users added to Common Identity (CI) in this sync.

usersUpdated
number

The number of users updated in Common Identity (CI) in this sync.

usersDeleted
number

The number of users deleted from Common Identity (CI) in this sync.

machinesAdded
number

The number of machines added to Common Identity (CI) in this sync.

machinesUpdated
number

The number of machines updated in Common Identity (CI) in this sync.

machinesDeleted
number

The number of machines deleted from Common Identity (CI) in this sync.

totalExternalUsersInCI
number

The number of total external users that have been added to CI across all syncs.

totalExternalMachinesInCI
number

The number of total external machines that have been added to Common Identity (CI) across all syncs.

lastSuccessfulSyncTime
string

The date and time of the last successful sync.

lastSyncTrackingId
string

Unique tracking identifier.

errors
array[object]

List of errors that occurred during that last attempt to sync this BroadWorks enterprise. This list captures errors that occurred during directory sync of the BroadWorks enterprise, after the API has been accepted and 200 OK response returned. Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code.

errorCode
number

An error code that identifies the reason for the error

Possible values: 6003
description
string

A textual representation of the error code.

Possible values: Broadworks External Directory User Sync failed while trying to connect to Broadworks cluster.
userContactsAdded
number

The number of user contacts added to Contact service in this sync.

userContactsUpdated
number

The number of user contacts updated in Contact service in this sync.

userContactsDeleted
number

The number of user contacts deleted from Contact service in this sync.

orgContactsAdded
number

The number of org contacts added to Contact service in this sync.

orgContactsUpdated
number

The number of org contacts updated in Contact service in this sync.

orgContactsDeleted
number

The number of org contacts deleted from Contact service in this sync.

totalUserContactsInContactService
number

The total number of user contacts in Contact service.

totalOrgContactsInContactService
number

The total number of org contacts in Contact service.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
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.
  • Try it
  • Example
GET
/v1/broadworks/enterprises{?spEnterpriseId,startsWith,max}
Log in to try the API.
Header
Query Parameters
  • The Service Provider supplied unique identifier for the subscriber's enterprise.
  • The starting string of the enterprise identifiers to match against.
  • Limit the number of enterprises returned in the search, up to 1000.
  • Request
  • Response
https://webexapis.com/v1/broadworks/enterprises?spEnterpriseId=Reseller1+acme&startsWith=Res&max=10
200 / OK
{
    "items": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
            "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
            "spEnterpriseId": "Reseller1+acme"
            "provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
            "broadworksDirectorySync": {
                "enableDirSync": true,
                "directorySyncStatus": {
                    "lastSyncStartTime": "2021-04-07T15:26:40.704911Z",
                    "lastSyncEndTime": "2021-04-07T15:26:42.695060Z",
                    "syncStatus": "COMPLETE",
                    "usersAdded": 0,
                    "usersUpdated": 0,
                    "usersDeleted": 0,
                    "machinesAdded": 0,
                    "machinesUpdated": 0,
                    "machinesDeleted": 0,
                    "totalExternalUsersInCI": 2,
                    "totalExternalMachinesInCI": 1,
                    "lastSyncTrackingId": "WEBEX-DEV-PORTAL_2de9b76f-6ad4-4f28-b8e8-c835885f9e7d_44"
                }
            }
        }
    ]
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.