> ## 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 in your company

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

Get the list of all workspaces within the authenticated user's company.



## OpenAPI

````yaml /api-reference/openapi-v3-company.yaml get /api/v3/company/workspaces
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3-company)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Workspaces
    description: Operations about workspaces
paths:
  /api/v3/company/workspaces:
    get:
      tags:
        - Workspaces
      summary: List workspaces in your company
      description: >-
        ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to
        breaking changes. Use with caution in production environments.


        Get the list of all workspaces within the authenticated user's company.
      operationId: api_v3_company_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: 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/PaginatedCompanyWorkspaceV3ListResponseList
          description: List of workspaces in the user's company
        '400':
          description: Invalid input
        '401':
          description: Authentication failed - missing or invalid API key
        '403':
          description: Permission denied - insufficient rights to access company workspaces
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedCompanyWorkspaceV3ListResponseList:
      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/CompanyWorkspaceV3ListResponse'
    CompanyWorkspaceV3ListResponse:
      type: object
      description: V3 Response serializer for company-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.

````