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

# List Workspaces



## OpenAPI

````yaml https://api.outerproduct.com/openapi.json get /v1/workspaces
openapi: 3.1.0
info:
  title: OuterProduct API
  description: >-
    Public-facing REST API for OuterProduct model distillation, prediction, and
    explanation.
  version: 0.1.8
servers: []
security: []
paths:
  /v1/workspaces:
    get:
      tags:
        - workspace
      summary: List Workspaces
      operationId: list_workspaces_v1_workspaces_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkspacesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    ListWorkspacesResponse:
      properties:
        workspaces:
          items:
            $ref: '#/components/schemas/Workspace-Output'
          type: array
          title: Workspaces
          description: The singleton workspace, or empty before it has been provisioned.
        nextPageToken:
          type: string
          title: Nextpagetoken
          description: Always empty while workspaces are singleton resources.
          default: ''
      type: object
      title: ListWorkspacesResponse
      description: Response containing the organization's workspace when provisioned.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Workspace-Output:
      properties:
        name:
          type: string
          pattern: ^workspaces/[a-z0-9](?:[a-z0-9._~-]*[a-z0-9])?$
          title: Name
          description: Resource name in the form `workspaces/{workspace}`.
        sqlDefaults:
          $ref: '#/components/schemas/SqlDefaults'
          description: SQL defaults applied before constructing a query session.
        revision:
          type: string
          title: Revision
          description: Monotonically increasing version of the complete workspace state.
          default: '0'
        createTime:
          anyOf:
            - type: string
            - type: 'null'
          title: Createtime
          description: Time at which the workspace was created.
        updateTime:
          anyOf:
            - type: string
            - type: 'null'
          title: Updatetime
          description: Time at which the workspace was most recently updated.
      type: object
      required:
        - sqlDefaults
        - name
      title: Workspace
      description: |-
        The singleton SQL data environment owned by an organization.

        Connectors and catalogs are direct child resources. Catalogs without a
        relational source own schemas, and schemas without one own tables. Any
        mutation to the defaults or an owned child advances `revision`.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SqlDefaults:
      properties:
        defaultCatalog:
          type: string
          pattern: ^[a-z][a-z0-9_]{0,62}$
          title: Defaultcatalog
          description: Catalog selected when SQL omits the catalog qualifier.
        defaultSchema:
          type: string
          pattern: ^[a-z][a-z0-9_]{0,62}$
          title: Defaultschema
          description: Schema selected when SQL omits the schema qualifier.
      type: object
      required:
        - defaultCatalog
        - defaultSchema
      title: SqlDefaults
      description: Default SQL names used when a query omits qualifiers.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key or OAuth2/OIDC access token
      description: >-
        An API key or OAuth2/OIDC access token sent as `Authorization: Bearer
        <token>`.

````