SubscriberListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-subscriber-list-response-schema.json",
  "title": "SubscriberListResponse",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-broadworks-subscribers-api-openapi.yml#/components/schemas/SubscriberListResponse",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Subscriber"
      },
      "description": "An array of Subscriber objects."
    }
  },
  "$defs": {
    "Error": {
      "type": "object",
      "properties": {
        "errorCode": {
          "type": "number",
          "description": "An error code that identifies the reason for the error."
        },
        "description": {
          "type": "string",
          "description": "A description of the error."
        }
      }
    },
    "Subscriber": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique Cisco identifier for the subscriber."
        },
        "personId": {
          "type": "string",
          "description": "The Person Id of the subscriber on Webex. To be used when referencing this subscriber on other Webex APIs. Only presented when status is `provisioned`."
        },
        "userId": {
          "type": "string",
          "description": "The user ID of the subscriber on BroadWorks."
        },
        "spEnterpriseId": {
          "type": "string",
          "description": "The Service Provider supplied unique identifier for the subscriber's enterprise."
        },
        "firstName": {
          "type": "string",
          "description": "The first name of the subscriber."
        },
        "lastName": {
          "type": "string",
          "description": "The last name of the subscriber."
        },
        "email": {
          "type": "string",
          "description": "The email address of the subscriber."
        },
        "primaryPhoneNumber": {
          "type": "string",
          "description": "The primary phone number configured against the subscriber on BroadWorks."
        },
        "mobilePhoneNumber": {
          "type": "string",
          "description": "The mobile phone number configured against the subscriber on BroadWorks."
        },
        "extension": {
          "type": "string",
          "description": "The extension number configured against the subscriber on BroadWorks."
        },
        "package": {
          "type": "string",
          "enum": [
            "softphone",
            "basic",
            "standard",
            "premium"
          ],
          "description": "The Webex for BroadWorks Package assigned to the subscriber.\n * `softphone` - Softphone package.\n * `basic` - Basic package.\n * `standard` - Standard package.\n * `premium` - Premium package.\n"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending_email_input",
            "pending_email_validation",
            "pending_user_migration",
            "provisioning",
            "provisioned",
            "updating",
            "error"
          ],
          "description": "The provisioning status of the user.\n * `pending_email_input` - Subscriber Provisioning is paused, pending input of email address.\n * `pending_email_validation` - Subscriber Provisioning is paused. The subscriber has entered an email address but has yet to complete validation.\n * `pending_user_migration` - Subscriber Provisioning is paused. An automated email is sent to the subscriber, waiting for the subscriber's consent.\n * `provisioning` - Subscriber provisioning is in progress.\n * `provisioned` - The subscriber is fully provisioned on Webex.\n * `updating` - An update is in progress for a provisioned subscriber.\n * `error` - An error occurred provisioning the subscriber on Webex.\n"
        },
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Error"
          },
          "description": "List of errors that occurred during that last attempt to provision/update this subscriber.\n\n *Note:*\n\n+ This list captures errors that occurred during *asynchronous or background* provisioning of the subscriber, *after* the API has been accepted and 200 OK response returned.\n\n+ Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code."
        },
        "created": {
          "type": "string",
          "description": "The date and time the subscriber was provisioned."
        },
        "lastStatusChange": {
          "type": "string",
          "description": "The date and time the provisioning status of the subscriber last changed."
        },
        "provisioningId": {
          "type": "string",
          "description": "This Provisioning ID associated with this subscriber."
        },
        "selfActivated": {
          "type": "boolean",
          "description": "Indicates if the subscriber was self activated, rather than provisioned via these APIs."
        }
      }
    }
  }
}