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

# List Users

> List all users with optional filters and pagination



## OpenAPI

````yaml /api/openapi.yaml get /v1/users
openapi: 3.0.3
info:
  title: Documentation Service API
  description: API documentation for Documentation Service
  version: 1.0.0
servers:
  - url: https://api.us.lexful.app
    description: US pod
security:
  - bearerAuth: []
    accountId: []
paths:
  /v1/users:
    get:
      tags:
        - Users
      summary: List Users
      description: List all users with optional filters and pagination
      parameters:
        - schema:
            type: string
            format: email
          in: query
          name: email
          required: false
          description: Filter by email (partial match)
        - schema:
            type: string
            enum:
              - system_admin
              - system_support
              - admin
              - support
              - viewer
              - organization_viewer
          in: query
          name: role
          required: false
          description: Filter by role
        - schema:
            type: string
          in: query
          name: first_name
          required: false
          description: Filter by first name (partial match)
        - schema:
            type: string
          in: query
          name: last_name
          required: false
          description: Filter by last name (partial match)
        - schema:
            type: string
          in: query
          name: sort
          required: false
          description: Comma-separated fields to sort by (e.g., "email,created_at")
        - schema:
            type: string
          in: query
          name: order
          required: false
          description: Comma-separated sort directions - ASC or DESC (e.g., "ASC,DESC")
        - schema:
            type: number
            default: 100
            minimum: 1
            maximum: 1000
          in: query
          name: limit
          required: false
          description: Number of items to return
        - schema:
            type: number
            default: 0
            minimum: 0
          in: query
          name: offset
          required: false
          description: Number of items to skip
        - schema:
            type: boolean
            default: false
          in: query
          name: include_deleted
          required: false
          description: Include deleted in the results
        - schema:
            type: string
          in: query
          name: filter
          required: false
          description: >-
            URL-encoded JSON AND/OR filter tree for complex queries. A node is a
            group `{"and":[...]}` / `{"or":[...]}` or a leaf — a
            bracket-notation string `"field[operator]=value"`. Composes as an
            additional AND alongside the bracket-notation filters. Max nesting
            depth 3, max 50 conditions.
      responses:
        '200':
          $ref: '#/components/responses/ListUsersResponse'
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '403':
          $ref: '#/components/responses/ForbiddenResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
components:
  responses:
    ListUsersResponse:
      description: Default Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListUsersResponse_application_json'
    BadRequestResponse:
      description: Bad request - validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ForbiddenResponse:
      description: Forbidden - insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerErrorResponse:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ListUsersResponse_application_json:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/ListUsersResponse_application_json_items_items
        total:
          type: number
          description: Total number of items available
        limit:
          type: number
          description: Number of items returned
        offset:
          type: number
          description: Number of items skipped
      required:
        - items
        - total
        - limit
        - offset
    ErrorResponse:
      description: Bad request - validation error
      type: object
      properties:
        status:
          type: number
          description: HTTP status code
        message:
          type: string
          description: Error message
        error_id:
          type: string
          description: Unique error identifier
        error_code:
          type: string
          description: Error code
        developer_message:
          type: string
          description: Additional details for developers
    ListUsersResponse_application_json_items_items:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: User unique identifier
        account_id:
          type: string
          format: uuid
          description: Account ID this user belongs to
        email:
          type: string
          format: email
          description: User email address
        first_name:
          type: string
          nullable: true
          description: User first name
        last_name:
          type: string
          nullable: true
          description: User last name
        role:
          type: string
          enum:
            - system_admin
            - system_support
            - admin
            - support
            - viewer
            - organization_viewer
          description: User role
        external_ids:
          type: object
          additionalProperties:
            type: string
          description: External system ID mappings
        account_scopes:
          type: array
          items:
            oneOf:
              - type: string
                format: uuid
              - type: string
                enum:
                  - '*'
            description: UUID or wildcard "*"
          description: >-
            Array of account IDs the user has access to (or "*" for wildcard
            access)
        organization_scopes:
          type: array
          items:
            oneOf:
              - type: string
                format: uuid
              - type: string
                enum:
                  - '*'
            description: UUID or wildcard "*"
          description: >-
            Array of organization IDs the user has access to (or "*" for
            wildcard access)
        created_at:
          type: string
          format: date-time
          description: User creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
        created_by:
          type: string
          description: User ID who created this user
        updated_by:
          type: string
          description: User ID who last updated this user
        deleted_at:
          type: string
          nullable: true
          format: date-time
          description: Deletion timestamp
      required:
        - id
        - account_id
        - email
        - role
        - account_scopes
        - organization_scopes
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token
    accountId:
      type: apiKey
      in: header
      name: X-Account-ID
      description: Account ID

````