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 EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale CustomersWholesale Subscribers
GETList Wholesale Subscribers
POSTProvision a Wholesale Subscriber
GETGet a Wholesale Subscriber
PUTUpdate a Wholesale Subscriber
DELETERemove a Wholesale Subscriber
POSTPrecheck a Wholesale Subscriber Provisioning
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 EnterprisesBroadWorks 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 Subscribers
GETList Wholesale Subscribers
POSTProvision a Wholesale Subscriber
GETGet a Wholesale Subscriber
PUTUpdate a Wholesale Subscriber
DELETERemove a Wholesale Subscriber
POSTPrecheck a Wholesale Subscriber Provisioning
Workspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

List Wholesale Subscribers

This API allows a Service Provider to search for their associated subscribers. There are a number of filter options, which can be combined in a single request.

GET/v1/wholesale/subscribers
Query Parameters
max
integer

Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the Pagination section of Webex REST API Basics.

Default: 50
offset
integer

Offset value to implement pagination.

customerId
string

Wholesale customer ID.

personId
string

The person ID of the subscriber used in the /v1/people API.

externalCustomerId
string

Customer external ID.

email
string

The email address of the subscriber.

status
string

The provisioning status of the subscriber.

after
string

Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.

lastStatusChange
string

Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.

sortBy
string

Supported sortBy attributes are created and lastStatusChange. Default is created.

sortOrder
string

Sort by ASC (ascending) or DESC (descending).

Response Properties
items
array[Subscriber]

An array of Subscriber objects.

id
string

A unique Cisco identifier for the subscriber.

personId
string

The person id of the subscriber used in the /people API. Only presented when status is provisioned.

email
string

The email address of the subscriber.

customerId
string

A unique identifier for the customer.

externalCustomerId
string

External ID of the Wholesale customer.

package
enum

The Webex Wholesale Package assigned to the subscriber.

webex_calling
string

Calling Basic Package.

webex_meetings
string

Meetings Package.

webex_suite
string

Suite Package.

webex_voice
string

Voice Package.

status
enum

The provisioning status of the user.

provisioned
string

The subscriber is fully provisioned on Cisco Webex.

error
string

An error occurred provisioning the subscriber on Cisco Webex.

provisioning
string

The subscriber is provisioning.

pending_email_validation
string

The subscriber email validation is pending.

pending_email_input
string

The subscriber email input is pending.

updating
string

The subscriber is updating.

pending_user_migration
string

The subscriber user migration is pending.

pending_email_verified
string

The subscriber email verification is pending.

errors
array[Error]

List of errors that occurred during that last attempt to provision/update this subscriber.

Note:

  • This list captures errors that occurred during provisioning of the subscriber.

  • 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.

description
string

A textual representation of the error code.

created
string

The date and time the subscriber was provisioned.

lastStatusChange
string

The date and time the provisioning status of the subscriber last changed.

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/wholesale/subscribers{?max,offset,customerId,personId,externalCustomerId,email,status,after,lastStatusChange,sortBy,sortOrder}
Log in to try the API.
Header
Query Parameters
  • Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/api/basics).
  • Offset value to implement [pagination](/docs/basics#pagination).
  • Wholesale customer ID.
  • The person ID of the subscriber used in the [/v1/people API](/docs/api/v1/people).
  • Customer external ID.
  • The email address of the subscriber.
  • The provisioning status of the subscriber.
  • Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
  • Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.
  • Supported `sortBy` attributes are `created` and `lastStatusChange`. Default is `created`.
  • Sort by `ASC` (ascending) or `DESC` (descending).
  • Request
  • Response
https://webexapis.com/v1/wholesale/subscribers?max=10&offset=4&customerId=Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY&personId=Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY&externalCustomerId=c1677a16-557a-4fb4-b48f-24adde57ec99&email=john.anderson@acme.com&status=pending_email_input&after=1579046400245&lastStatusChange=1579046400245&sortBy=userCreationTimestamp&sortOrder=ASC
200 / OK
{
    "items": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2",
            "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
            "email": "johnandersen@acme.com",
            "package": "webex_calling",
            "customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng==",
            "externalCustomerId" : "c1677a16-557a-4fb4-b48f-24adde57ec99",
            "status": "provisioned",
            "lastStatusChange": "2021-08-06T02:05:41.791232Z",
            "created": "2021-08-06T02:03:00.062Z"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
            "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
            "email": "johnandersen@acme.com",
            "customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng==",
            "externalCustomerId" : "c1677a16-557a-4fb4-b48f-24adde57ec99",
            "package": "webex_meetings",
            "status": "provisioned",
            "lastStatusChange": "2021-08-06T02:05:41.791232Z",
            "created": "2021-08-06T02:03:00.062Z"
        }
    ]
}

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.