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

# List internal users with filtering and pagination

> Retrieve a paginated list of internal users (human agents) within the workspace.

Supports optional filtering by exact email and by status (active/disabled/all).



## OpenAPI

````yaml /api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/users
openapi: 3.1.0
info:
  title: Bridge API
  summary: Bridge API specification for chat system management.
  description: >-
    Bridge API specification including webhook receiver endpoints, Contact CRUD
    operations, and comprehensive chat system.

                        This API includes:
                        1. Webhook Receiver API - for CRM clients to receive event notifications from Bridge
                        2. Contact CRUD API - for clients to manage contacts in Bridge
                        3. Conversations API - for managing conversations with flexible user identification and participant management
                        4. Messages API - for sending messages and files to a conversation
                        5. Files API - for managing files in a message
                        6. Custom attributes API - for consult custom attributes of an specific workspace
                    
                        **Multi-Tenant Architecture**: All operations are scoped to a specific workspace using workspaceId.
  termsOfService: https://www.sainapsis.com/legal/terms-of-service
  contact:
    name: Bridge Support
    url: https://app.bridge.new/
    email: support@sainapsis.com
  license:
    name: MIT License
    url: https://spdx.org/licenses/MIT.html
  version: 1.0.0
servers:
  - url: https://api-connect-us.bridge.new
    description: Production server
security: []
paths:
  /bridge/api/v1/workspaces/{workspaceId}/users:
    get:
      tags:
        - Internal Users API
      summary: List internal users with filtering and pagination
      description: >-
        Retrieve a paginated list of internal users (human agents) within the
        workspace.


        Supports optional filtering by exact email and by status
        (active/disabled/all).
      operationId: get_internal_users_bridge_api_v1_workspaces__workspaceId__users_get
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Unique identifier of the workspace (UUID v4).
            examples:
              - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234
            title: Workspaceid
          description: Unique identifier of the workspace (UUID v4).
        - name: email
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter internal users by exact email address.
            example: john.doe@example.com
            title: Email
          description: Filter internal users by exact email address.
        - name: status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/UserStatusFilter'
            description: 'Filter by status: ''active'' (default), ''disabled'', or ''all''.'
            default: active
          description: 'Filter by status: ''active'' (default), ''disabled'', or ''all''.'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of internal users per page
            default: 20
            title: Limit
          description: Number of internal users per page
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Cursor provided on a previous request to get the next page
            title: Cursor
          description: Cursor provided on a previous request to get the next page
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalUsersResponseList'
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                INVALID_CURSOR:
                  value:
                    title: Invalid Cursor
                    status: 400
                    code: BRIDGE_CORE_0104
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Forbidden
          content:
            application/json:
              examples:
                FORBIDDEN:
                  value:
                    title: Forbidden
                    status: 403
                    code: BRIDGE_CORE_0301
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                WORKSPACE_NOT_FOUND:
                  value:
                    title: Workspace Not Found
                    status: 404
                    code: BRIDGE_WORKSPACE_0001
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - x-api-key: []
components:
  schemas:
    UserStatusFilter:
      type: string
      enum:
        - active
        - disabled
        - all
      title: UserStatusFilter
    InternalUsersResponseList:
      properties:
        users:
          items:
            $ref: '#/components/schemas/InternalUserResponse'
          type: array
          title: Users
          description: Array of internal users.
        cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Cursor
          description: Cursor to be sent on the next page request.
      type: object
      required:
        - users
      title: InternalUsersResponseList
      description: Response body for listing internal users.
    Problem:
      properties:
        title:
          type: string
          title: Title
          description: Short, summary of the problem type.
        status:
          type: integer
          title: Status
          description: >-
            HTTP status code generated by the origin server for this occurrence
            of the problem.
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          description: Explanation specific to this occurrence of the problem.
        instance:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
        traceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Traceid
          description: Trace ID for debugging purposes.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Error code for identification, view the error codes page for more
            details.
        errors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Errors
          description: List of error details.
        extra:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extra
          description: Extra information about the problem.
      type: object
      required:
        - title
        - status
      title: Problem
      description: Object representing a Problem response body.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    InternalUserResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Unique identifier for the internal user (UUID v4).
          examples:
            - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234
        firstName:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
          description: Internal user's first name.
          examples:
            - John
            - null
        lastName:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
          description: Internal user's last name.
          examples:
            - Doe
            - null
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: Internal user's email address.
          examples:
            - john.doe@example.com
            - null
        cellphone:
          anyOf:
            - type: string
            - type: 'null'
          title: Cellphone
          description: Internal user's cellphone number.
          examples:
            - '+14084029292'
            - null
        languageCode:
          anyOf:
            - $ref: '#/components/schemas/LanguageCode'
            - type: 'null'
          title: Language Code
          description: Language code of the internal user.
          examples:
            - EN
            - null
        status:
          type: string
          enum:
            - active
            - disabled
          title: Status
          description: >-
            'active' when the internal user is live, 'disabled' when the user
            has been removed.
          examples:
            - active
            - disabled
        createdAt:
          type: string
          title: Created At
          description: Timestamp when the internal user was created.
          examples:
            - '2003-04-10T08:00:00.000Z'
        updatedAt:
          type: string
          title: Updated At
          description: Timestamp when the internal user was last updated.
          examples:
            - '2003-04-10T08:00:00.000Z'
      type: object
      required:
        - id
        - status
        - createdAt
        - updatedAt
      title: InternalUserResponse
      description: Response body for internal-user (human agent) read operations.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    LanguageCode:
      type: string
      enum:
        - ES
        - EN
      title: LanguageCode
  securitySchemes:
    x-api-key:
      type: apiKey
      description: Copy the API key as provided by the Bridge Console.
      in: header
      name: x-api-key

````