8x8

8x8 Users API

The Users API from 8x8 — 6 operation(s) for users.

Operations 9

GET /users List users #
POST /users Create user #
GET /users/{userId} Get user by ID #
PUT /users/{userId} Update user #
DELETE /users/{userId} Delete user #
GET /users/count Query user count #
GET /users/{userReference}/supervisors Query supervisor values #
GET /users/{userReference}/trainers Trainer values. #
GET /users/{userReference}/details User details. #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/8x8-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

8x8-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: 8x8 Users API
  version: '1.0'
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: 8x8-administration-user-api-v1.yaml, 8x8-analytics-quality-management-and-speech-analytics-api.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.8x8.com/admin-provisioning
  description: Production
- url: https://api.8x8.com/qm/{region}/{apiversion}
  description: The QM/SA API Gateway Endpoint
  variables:
    region:
      enum:
      - us-west
      - us-east
      - uk
      - ap
      - ca
      default: us-west
    apiversion:
      default: v1
tags:
- name: Users
paths:
  /users:
    servers:
    - url: https://api.8x8.com/admin-provisioning
      description: Production
    get:
      operationId: listUsers
      summary: List users
      description: 'List users with optional filtering, sorting, and infinite scroll pagination.

        Uses scrollId-based pagination for efficient navigation through large datasets.

        '
      tags:
      - Users
      parameters:
      - name: X-Request-Id
        in: header
        description: Optional request identifier for tracking
        required: false
        schema:
          type: string
          format: uuid
      - name: pageSize
        in: query
        description: 'Number of items per page (default: 100)'
        required: false
        schema:
          type: integer
          example: 100
      - name: scrollId
        in: query
        description: Scroll identifier for retrieving the next page of results
        required: false
        schema:
          type: string
      - name: filter
        in: query
        description: RSQL filter expression (e.g., 'basicInfo.userName==jane.doe@corp.com', 'basicInfo.status==ACTIVE')
        required: false
        schema:
          type: string
          example: basicInfo.status==ACTIVE
      - name: sort
        in: query
        description: Sort expression. Use '+' prefix or no prefix for ascending order, '-' prefix for descending order (e.g., 'basicInfo.userName', '+basicInfo.userName', or '-basicInfo.userName')
        required: false
        schema:
          type: string
          example: basicInfo.userName
      responses:
        '200':
          description: Successful response with paginated users
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/UserPage'
        '400':
          description: Bad Request - Invalid query parameters or filter syntax
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidSort:
                  summary: Invalid sort parameter
                  value:
                    status: 400
                    title: Validation error
                    errors:
                    - code: VALIDATION_ERROR
                      field: sort
                      message: Invalid sort parameter
                invalidFilter:
                  summary: Invalid filter syntax
                  value:
                    status: 400
                    title: Validation error
                    errors:
                    - code: VALIDATION_ERROR
                      field: filter
                      message: Invalid filter syntax
                conflictingParameters:
                  summary: Conflicting query parameters
                  value:
                    status: 400
                    title: Conflicting query parameters
                    errors:
                    - code: CONFLICTING_QUERY_PARAMETER
                      message: Cannot use scrollId with other first-page query parameters
        '503':
          description: Service Unavailable - Service unavailable due to connectivity or network issues
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 503
                title: Service unavailable
                errors:
                - code: SERVICE_UNAVAILABLE
                  message: Service unavailable
        '500':
          description: Internal Server Error - Unexpected error occurred
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 500
                title: Internal Server Error
                errors:
                - code: UNKNOWN
                  message: An unexpected error occurred
      security:
      - ApiKeyAuth: []
    post:
      operationId: createUser
      summary: Create user
      description: 'Create a new user.

        This operation is asynchronous and returns an Operation object to track progress.

        '
      tags:
      - Users
      parameters:
      - name: X-Request-Id
        in: header
        description: Optional request identifier for tracking
        required: false
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/vnd.users.v1+json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '202':
          description: User creation operation initiated successfully
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/Operation'
        '400':
          description: Bad Request - Validation errors
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validationError:
                  summary: Field validation errors
                  value:
                    status: 400
                    title: Validation error
                    errors:
                    - code: VALIDATION_ERROR
                      field: basicInfo.userName
                      message: must not be blank
                    - code: VALIDATION_ERROR
                      field: basicInfo.primaryEmail
                      message: must be a well-formed email address
                    - code: VALIDATION_ERROR
                      field: basicInfo.firstName
                      message: size must be between 2 and 128
                duplicateUserName:
                  summary: Duplicate userName
                  value:
                    status: 400
                    title: Validation error
                    errors:
                    - code: VALIDATION_ERROR
                      message: userName already in use
                invalidSite:
                  summary: Invalid site
                  value:
                    status: 400
                    title: Validation error
                    errors:
                    - code: VALIDATION_ERROR
                      field: basicInfo.site.id
                      message: Either site id or name must be provided
        '403':
          description: Forbidden - Customer ID mismatch
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 403
                title: Forbidden
                detail: 'CustomerId mismatch: 0012J00042NkZQIQA3 vs 0012J00042NkZQIQA4'
                errors:
                - code: FORBIDDEN
                  message: 'CustomerId mismatch: 0012J00042NkZQIQA3 vs 0012J00042NkZQIQA4'
        '408':
          description: Request Timeout - Downstream service timeout
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 408
                title: Request Timeout
                errors:
                - code: REQUEST_TIMEOUT
                  message: Request to downstream service timed out
        '503':
          description: Service Unavailable - Service unavailable due to connectivity or network issues
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 503
                title: Service unavailable
                errors:
                - code: SERVICE_UNAVAILABLE
                  message: Service unavailable
        '429':
          description: Too Many Requests - Rate limit exceeded
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 429
                title: Too Many Requests
                errors:
                - code: TOO_MANY_REQUESTS
                  message: Rate limit exceeded, please try again later
        '500':
          description: Internal Server Error - Unexpected error occurred
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 500
                title: Internal Server Error
                errors:
                - code: UNKNOWN
                  message: An unexpected error occurred
      security:
      - ApiKeyAuth: []
  /users/{userId}:
    servers:
    - url: https://api.8x8.com/admin-provisioning
      description: Production
    get:
      operationId: getUser
      summary: Get user by ID
      description: Retrieve a specific user by their ID
      tags:
      - Users
      parameters:
      - name: X-Request-Id
        in: header
        description: Optional request identifier for tracking
        required: false
        schema:
          type: string
          format: uuid
      - name: userId
        in: path
        description: User identifier
        required: true
        schema:
          type: string
          example: hvOB1l3zDCaDAwp9tNLzZA
      responses:
        '200':
          description: User retrieved successfully
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 404
                title: Not Found
                errors:
                - code: NOT_FOUND
                  message: Resource not found
        '503':
          description: Service Unavailable - Service unavailable due to connectivity or network issues
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 503
                title: Service unavailable
                errors:
                - code: SERVICE_UNAVAILABLE
                  message: Service unavailable
        '500':
          description: Internal Server Error - Unexpected error occurred
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 500
                title: Internal Server Error
                errors:
                - code: UNKNOWN
                  message: An unexpected error occurred
      security:
      - ApiKeyAuth: []
    put:
      operationId: updateUser
      summary: Update user
      description: 'Update an existing user by their ID.

        This operation is asynchronous and returns an Operation object to track progress.

        '
      tags:
      - Users
      parameters:
      - name: X-Request-Id
        in: header
        description: Optional request identifier for tracking
        required: false
        schema:
          type: string
          format: uuid
      - name: userId
        in: path
        description: User identifier
        required: true
        schema:
          type: string
          example: hvOB1l3zDCaDAwp9tNLzZA
      requestBody:
        required: true
        content:
          application/vnd.users.v1+json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '202':
          description: User update operation initiated successfully
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/Operation'
        '400':
          description: Bad Request - Validation errors
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validationError:
                  summary: Field validation errors
                  value:
                    status: 400
                    title: Validation error
                    errors:
                    - code: VALIDATION_ERROR
                      field: basicInfo.userName
                      message: must not be blank
                mismatchedUserId:
                  summary: Mismatched userId in payload
                  value:
                    status: 400
                    title: Mismatched userId in url vs payload
                    detail: 'Mismatched userId in url vs payload: hvOB1l3zDCaDAwp9tNLzZA vs anotherUserId'
                    errors:
                    - code: VALIDATION_ERROR
                      field: basicInfo.userId
                      message: 'Mismatched userId in url vs payload: hvOB1l3zDCaDAwp9tNLzZA vs anotherUserId'
                duplicateUserName:
                  summary: Duplicate userName
                  value:
                    status: 400
                    title: Validation error
                    errors:
                    - code: VALIDATION_ERROR
                      message: userName already in use
        '403':
          description: Forbidden - Customer ID mismatch
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 403
                title: Forbidden
                detail: 'CustomerId mismatch: 0012J00042NkZQIQA3 vs 0012J00042NkZQIQA4'
                errors:
                - code: FORBIDDEN
                  message: 'CustomerId mismatch: 0012J00042NkZQIQA3 vs 0012J00042NkZQIQA4'
        '404':
          description: User not found
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 404
                title: Not Found
                errors:
                - code: NOT_FOUND
                  field: basicInfo.userId
                  message: User not found
        '408':
          description: Request Timeout - Downstream service timeout
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 408
                title: Request Timeout
                errors:
                - code: REQUEST_TIMEOUT
                  message: Request to downstream service timed out
        '503':
          description: Service Unavailable - Service unavailable due to connectivity or network issues
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 503
                title: Service unavailable
                errors:
                - code: SERVICE_UNAVAILABLE
                  message: Service unavailable
        '429':
          description: Too Many Requests - Rate limit exceeded
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 429
                title: Too Many Requests
                errors:
                - code: TOO_MANY_REQUESTS
                  message: Rate limit exceeded, please try again later
        '500':
          description: Internal Server Error - Unexpected error occurred
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 500
                title: Internal Server Error
                errors:
                - code: UNKNOWN
                  message: An unexpected error occurred
      security:
      - ApiKeyAuth: []
    delete:
      operationId: deleteUser
      summary: Delete user
      description: 'Delete a specific user by their ID.

        This operation is asynchronous and returns an Operation object to track progress.

        '
      tags:
      - Users
      parameters:
      - name: X-Request-Id
        in: header
        description: Optional request identifier for tracking
        required: false
        schema:
          type: string
          format: uuid
      - name: userId
        in: path
        description: User identifier
        required: true
        schema:
          type: string
          example: hvOB1l3zDCaDAwp9tNLzZA
      responses:
        '202':
          description: User deletion operation initiated successfully
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/Operation'
        '503':
          description: Service Unavailable - Service unavailable due to connectivity or network issues
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 503
                title: Service unavailable
                errors:
                - code: SERVICE_UNAVAILABLE
                  message: Service unavailable
        '500':
          description: Internal Server Error - Unexpected error occurred
          headers:
            X-Response-Id:
              description: Unique response identifier generated by the service
              schema:
                type: string
                format: uuid
          content:
            application/vnd.users.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: 500
                title: Internal Server Error
                errors:
                - code: UNKNOWN
                  message: An unexpected error occurred
      security:
      - ApiKeyAuth: []
  /users/count:
    servers:
    - url: https://api.8x8.com/qm/{region}/{apiversion}
      description: The QM/SA API Gateway Endpoint
      variables:
        region:
          enum:
          - us-west
          - us-east
          - uk
          - ap
          - ca
          default: us-west
        apiversion:
          default: v1
    get:
      tags:
      - Users
      summary: Query user count
      description: Retrieve the total number of users registered in the system. You can also count only the active users.
      operationId: users count
      parameters:
      - name: Content-Type
        in: header
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: application/json
      - name: activeUsers
        in: query
        description: Whether the user is active or not.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          example: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                example: '10'
              example: 10
        default:
          description: Unexpected error
      deprecated: false
      security:
      - bearerAuth: []
  /users/{userReference}/supervisors:
    servers:
    - url: https://api.8x8.com/qm/{region}/{apiversion}
      description: The QM/SA API Gateway Endpoint
      variables:
        region:
          enum:
          - us-west
          - us-east
          - uk
          - ap
          - ca
          default: us-west
        apiversion:
          default: v1
    get:
      tags:
      - Users
      summary: Query supervisor values
      description: Retrieves the user's supervisor collection
      operationId: supervisors
      parameters:
      - name: userReference
        in: path
        description: The user's unique identifier for their supervisors collection
        required: true
        style: simple
        explode: false
        schema:
          type: number
          format: double
          example: 283
      - name: Content-Type
        in: header
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: application/json
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/basicUser'
              example:
              - userReference: 285
                name: Johana Doe
        default:
          description: Unexpected error
      deprecated: false
      security:
      - bearerAuth: []
  /users/{userReference}/trainers:
    servers:
    - url: https://api.8x8.com/qm/{region}/{apiversion}
      description: The QM/SA API Gateway Endpoint
      variables:
        region:
          enum:
          - us-west
          - us-east
          - uk
          - ap
          - ca
          default: us-west
        apiversion:
          default: v1
    get:
      tags:
      - Users
      summary: Trainer values.
      description: Retrieves the user's trainer collection
      operationId: trainers
      parameters:
      - name: userReference
        in: path
        description: The user's unique identifier for the trainer collection
        required: true
        style: simple
        explode: false
        schema:
          type: number
          format: double
          example: 283
      - name: Content-Type
        in: header
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: application/json
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/basicUser'
              example:
              - userReference: 285
                name: Johana Doe
        default:
          description: Unexpected error
      deprecated: false
      security:
      - bearerAuth: []
  /users/{userReference}/details:
    servers:
    - url: https://api.8x8.com/qm/{region}/{apiversion}
      description: The QM/SA API Gateway Endpoint
      variables:
        region:
          enum:
          - us-west
          - us-east
          - uk
          - ap
          - ca
          default: us-west
        apiversion:
          default: v1
    get:
      tags:
      - Users
      summary: User details.
      description: Retrieve user details
      operationId: user details
      parameters:
      - name: userReference
        in: path
        description: The unique identifier for the requested user details
        required: true
        style: simple
        explode: false
        schema:
          type: number
          format: double
          example: 283
      - name: Content-Type
        in: header
        required: true
        style: simple
        explode: false
        schema:
          type: string
          example: application/json
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/userResponse'
              example:
                userReference: 283
                agentId: agent123
                name: John Doe
                mainGroup: Agent
                phone: 1234554321
                email: user@company.com
                hireDate: 2019
                locked: false
                active: true
                links:
                - rel: interactions
                  href: https://api.8x8.com/qm/us-west/v1/interactions?userReference=283
                  type: GET
                - rel: supervisors
                  href: https://api.8x8.com/qm/us-west/v1/users/854/supervisors
                  type: GET
                - rel: trainers
                  href: https://api.8x8.com/qm/us-west/v1/users/854/trainers
                  type: GET
        default:
          description: Unexpected error
      deprecated: false
      security:
      - bearerAuth: []
components:
  schemas:
    UserGroup:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Unique ID of the user group
          example: '12345'
        name:
          type:
          - string
          - 'null'
          description: Name of the user group
          example: Supervisors
    ProfilePolicy:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the profile policy assigned ot the user
          example: 8x8 Master User Template
    Address:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Unique ID of the address
          example: b1c4944a-17a0-4b00-8d48-36001df07e22
        displayForm:
          type:
          - string
          - 'null'
          description: Formatted, human-readable representation of the emergency address
          example: 7 W 34TH ST, 613, New York NY, 10001
        organization:
          type:
          - string
          - 'null'
          description: Organization name associated with the emergency address
          example: 8x8
        building:
          type:
          - string
          - 'null'
          description: Building name or identifier for the emergency address
          example: Bardon Hall
        streetNumber:
          type:
          - string
          - 'null'
          description: Street number of the emergency address
          example: '7'
        streetNumberSuffix:
          type:
          - string
          - 'null'
          description: Suffix associated with the street number, if applicable
          example: bis
        preDirectional:
          type:
          - string
          - 'null'
          description: Directional prefix (N, S, E, W) used before the street name
          example: W
        streetName:
          type:
          - string
          - 'null'
          description: Street name of the emergency address
          example: Whitechapel High Street
        streetNameSuffix:
          type:
          - string
          - 'null'
          description: Street t

# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/8x8/refs/heads/main/openapi/8x8-users-api-openapi.yml