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

# List Platform Users



## OpenAPI

````yaml /api-reference/openapi.json get /api/platform/users
openapi: 3.1.0
info:
  title: Blindsight API
  version: 0.1.0
  description: >-
    The full Blindsight REST surface, generated from the running application.
    Replace the server host with your own deployment.


    For the Runtime Security integration surface (scan, proxy, tool calls) see
    the Runtime Security spec, which is hand written and carries worked
    examples.
servers:
  - url: https://api.your-blindsight.com
    description: Your Blindsight deployment
security: []
paths:
  /api/platform/users:
    get:
      tags:
        - platform
      summary: List Platform Users
      operationId: list_platform_users_api_platform_users_get
      parameters:
        - name: workspace_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by workspace id
            title: Workspace Id
          description: Filter by workspace id
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Search by email/name
            title: Q
          description: Search by email/name
        - name: include_platform_owners
          in: query
          required: false
          schema:
            type: boolean
            default: true
            title: Include Platform Owners
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserRead'
                title: Response List Platform Users Api Platform Users Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UserRead:
      properties:
        id:
          type: integer
          title: Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        email:
          type: string
          title: Email
        is_active:
          type: boolean
          title: Is Active
        roles:
          items:
            type: string
          type: array
          title: Roles
          default: []
        mfa_enabled:
          type: boolean
          title: Mfa Enabled
          default: false
        is_platform_owner:
          type: boolean
          title: Is Platform Owner
          default: false
        workspace_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Workspace Id
        workspace:
          anyOf:
            - $ref: '#/components/schemas/WorkspaceSummary'
            - type: 'null'
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - email
        - is_active
      title: UserRead
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkspaceSummary:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        slug:
          type: string
          title: Slug
        type:
          type: string
          title: Type
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
      type: object
      required:
        - id
        - name
        - slug
        - type
      title: WorkspaceSummary
      description: Compact workspace info embedded in auth payloads and user lists.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````