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

# List Workspaces

> Lists all workspaces in your organization along with their primary dashboard information. Requires an Upsolve API key.



## OpenAPI

````yaml get /v1/api/dashboard/list-workspaces
openapi: 3.1.0
info:
  title: Upsolve API
  version: 1.4.1
servers:
  - url: https://api.upsolve.ai
security: []
tags: []
paths:
  /v1/api/dashboard/list-workspaces:
    get:
      summary: List all workspaces
      description: >-
        Lists all workspaces in your organization along with their primary
        dashboard information. Requires an Upsolve API key.
      operationId: GetV1ApiDashboardListWorkspaces
      parameters:
        - name: apiKey
          in: query
          required: false
          description: >-
            Upsolve API key, generated under Account → Developer settings in the
            Upsolve Hub. Keys are user-scoped: pass organizationId alongside the
            key to select which org to act on.
          schema:
            type: string
            minLength: 1
            description: >-
              Upsolve API key, generated under Account → Developer settings in
              the Upsolve Hub. Keys are user-scoped: pass organizationId
              alongside the key to select which org to act on.
            examples:
              - up_embed_************
          examples:
            example1:
              value: up_embed_************
        - name: organizationId
          in: query
          required: false
          description: GET /v1/api/dashboard/list-workspaces Parameter
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
        - name: teamId
          in: query
          required: false
          description: Optional team ID to filter workspaces
          schema:
            description: Optional team ID to filter workspaces
            type: number
        - name: projectId
          in: query
          required: false
          description: Optional project ID to filter workspaces
          schema:
            description: Optional project ID to filter workspaces
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
      responses:
        '200':
          description: GET /v1/api/dashboard/list-workspaces Positive response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    type: object
                    properties:
                      workspaces:
                        type: array
                        items: {}
                        description: Array of enriched workspace objects
                    required:
                      - workspaces
                    additionalProperties: false
                required:
                  - status
                  - data
                additionalProperties: false
        '400':
          description: GET /v1/api/dashboard/list-workspaces Negative response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: error
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      code:
                        type: string
                      details:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - message
                    additionalProperties: false
                required:
                  - status
                  - error
                additionalProperties: false
      security:
        - APIKEY_3: []
components:
  securitySchemes:
    APIKEY_3:
      type: apiKey
      in: query
      name: apiKey

````