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

# List workspaces

> ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

Get the list of accessible workspaces for the authenticated user. Returns workspaces where the user is set as member (through any group: private, company, or custom). Please use instance or company level endpoints to access the workspaces as admin.

**Filtering:** All users see only workspaces where they are members. Admin users should use `/api/v3/instance/workspaces` or `/api/v3/company/workspaces` for administrative access.

Results ordered by creation date (newest first), paginated with 20 elements per page by default.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /api/v3/workspaces
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Files Processing
    description: Operations about files processing
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: User Groups
    description: Operations about user groups
  - name: Companies
    description: Operations about companies
  - name: SCIM
    description: Operations about SCIM
paths:
  /api/v3/workspaces:
    get:
      tags:
        - Workspaces
      summary: List workspaces
      description: >-
        ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to
        breaking changes. Use with caution in production environments.


        Get the list of accessible workspaces for the authenticated user.
        Returns workspaces where the user is set as member (through any group:
        private, company, or custom). Please use instance or company level
        endpoints to access the workspaces as admin.


        **Filtering:** All users see only workspaces where they are members.
        Admin users should use `/api/v3/instance/workspaces` or
        `/api/v3/company/workspaces` for administrative access.


        Results ordered by creation date (newest first), paginated with 20
        elements per page by default.
      operationId: api_v3_workspaces_list
      parameters:
        - in: query
          name: document_upload_method
          schema:
            type: string
            enum:
              - manual
              - synced
          description: >-
            Method for adding documents to this workspace: manual uploads or
            synced from datasources


            * `manual` - Manual

            * `synced` - Synced
        - in: query
          name: group_id
          schema:
            type: integer
        - in: query
          name: group_name
          schema:
            type: string
        - in: query
          name: name
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: page_size
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - in: query
          name: user_role
          schema:
            type: string
            enum:
              - editor
              - owner
              - viewer
          description: |-
            * `owner` - Owner
            * `editor` - Editor
            * `viewer` - Viewer
        - in: query
          name: workspace_type
          schema:
            type: string
            enum:
              - company
              - custom
              - personal
          description: |-
            * `company` - Company
            * `personal` - Personal
            * `custom` - Custom
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedStandardWorkspaceV3ListResponseList
          description: List of workspaces where the user is a member
        '400':
          description: >-
            Bad Request - Invalid query parameters (unsupported parameter,
            invalid enum values, etc.)
        '401':
          description: Unauthenticated - Missing or invalid API key/session cookie
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedStandardWorkspaceV3ListResponseList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/StandardWorkspaceV3ListResponse'
    StandardWorkspaceV3ListResponse:
      type: object
      description: V3 Response serializer for user-level workspaces endpoint.
      properties:
        id:
          type: integer
        name:
          type: string
        workspace_type:
          type: string
        document_upload_method:
          type: string
        description:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        user_role:
          type: string
          readOnly: true
      required:
        - created_at
        - description
        - document_upload_method
        - id
        - name
        - updated_at
        - user_role
        - workspace_type
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````