> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ringg.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Workspace Users

> Retrieves a list of all users in your current workspace.

List users who belong to the current workspace. This is useful for internal admin tooling, audit views, and choosing users for campaign completion notifications.

## Query guidance

* Use `limit` and `offset` for pagination.
* Keep the API key server-side; do not call this endpoint from browser code.
* Cache lightly if you show this in dashboards because workspace membership changes infrequently.

## Common follow-up

Campaign APIs can notify selected users when a campaign completes. Use this endpoint to identify the user IDs available in the workspace.


## OpenAPI

````yaml get /workspace/users
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    This is the documentation for the Ringg AI APIs. The Ringg AI API follows
    RESTful principles, making it intuitive and easy to integrate with your
    applications. All API requests should be made to the base URL. The API
    accepts and returns data in JSON format. Ensure your requests include the
    appropriate Content-Type header for POST and PATCH requests.
  version: 2.0.0
servers:
  - url: https://prod-api.ringg.ai/ca/api/v0
security: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing assistants (agents).
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: Endpoints for accessing call analytics and performance metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /workspace/users:
    get:
      tags:
        - workspace
      summary: List Workspace Users
      description: Retrieves a list of all users in your current workspace.
      operationId: listWorkspaceUsers
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Ringg AI API key.
          required: true
          schema:
            type: string
            example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
        - name: limit
          in: query
          description: 'Number of items to return (default: 20, max: 100).'
          schema:
            type: integer
            default: 10
            example: 50
        - name: offset
          in: query
          description: 'Number of items to skip (default: 0).'
          schema:
            type: integer
            default: 0
            example: 20
      responses:
        '200':
          description: 'Successful Response: A list of users in the workspace.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace_users:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
                        username:
                          type: string
                          example: sahil
                        email:
                          type: string
                          example: user@example.com
                        role:
                          type: string
                          example: member
                        invite_status:
                          type: string
                          example: success
        '401':
          description: Unauthorized - Invalid or missing API key.
        '500':
          description: Internal Server Error - Something went wrong on our end.

````