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

# List workspaces across all projects



## OpenAPI

````yaml api-reference/openapi.v1.json GET /workspaces
openapi: 3.1.0
info:
  title: Aether Public API
  version: 0.1.0
  description: >-
    The versioned, public Aether REST API. Authenticate with an `aether_`
    platform API key or a session token.
servers:
  - url: https://api.runaether.dev/v1
security:
  - bearerAuth: []
paths:
  /workspaces:
    get:
      tags:
        - workspaces
      summary: List workspaces across all projects
      operationId: listAllWorkspaces
      parameters:
        - explode: false
          in: query
          name: page
          schema:
            format: int64
            maximum: 10000
            minimum: 1
            type: integer
        - explode: false
          in: query
          name: limit
          schema:
            format: int64
            maximum: 100
            minimum: 1
            type: integer
        - explode: false
          in: query
          name: status
          schema:
            pattern: >-
              ^(deleted|idle|starting|stopping|suspending|ready|preparing|error|stopped|suspended)(,(deleted|idle|starting|stopping|suspending|ready|preparing|error|stopped|suspended))*$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  pagination:
                    $ref: '#/components/schemas/PaginationMeta'
                  workspaces:
                    items:
                      $ref: '#/components/schemas/Workspace'
                    type: array
                required:
                  - workspaces
                  - pagination
                type: object
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
components:
  schemas:
    PaginationMeta:
      additionalProperties: false
      properties:
        has_more:
          type: boolean
        page:
          format: int64
          minimum: 1
          type: integer
      required:
        - page
        - has_more
      type: object
    Workspace:
      additionalProperties: false
      properties:
        created_at:
          minLength: 1
          type: string
        display_state:
          enum:
            - deleted
            - idle
            - starting
            - stopping
            - suspending
            - ready
            - preparing
            - error
            - stopped
            - suspended
          type: string
        error_message:
          minLength: 1
          type: string
        git_ref:
          minLength: 1
          type: string
        hardware:
          $ref: '#/components/schemas/HardwareConfig'
        has_active_lease:
          type: boolean
        has_open_runtime_interval:
          type: boolean
        id:
          format: uuid
          type: string
        is_deleted:
          type: boolean
        keep_active:
          type: boolean
        last_accessed_at:
          minLength: 1
          type: string
        last_shutdown_at:
          minLength: 1
          type: string
        last_started_at:
          minLength: 1
          type: string
        machine_id:
          minLength: 1
          type: string
        observed_state:
          enum:
            - absent
            - running
            - suspended
            - stopped
            - destroyed
          type: string
        previews:
          items:
            $ref: '#/components/schemas/DeclaredPreview'
          type: array
        private_ip:
          minLength: 1
          type: string
        project_id:
          format: uuid
          type: string
        runtime_class_id:
          minLength: 1
          type: string
        startable:
          type: boolean
        task_id:
          format: uuid
          type: string
        updated_at:
          minLength: 1
          type: string
      required:
        - id
        - project_id
        - is_deleted
        - has_active_lease
        - observed_state
        - has_open_runtime_interval
        - display_state
        - startable
        - previews
        - runtime_class_id
        - hardware
        - keep_active
        - created_at
        - updated_at
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        code:
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    HardwareConfig:
      additionalProperties: false
      properties:
        cpu_kind:
          enum:
            - shared
            - performance
          type: string
        cpus:
          format: int64
          maximum: 16
          minimum: 1
          type: integer
        gpu_kind:
          enum:
            - a10
            - l40s
            - a100-40gb
            - a100-80gb
          type:
            - string
            - 'null'
        memory_mb:
          format: int64
          maximum: 32768
          minimum: 256
          type: integer
        volume_size_gb:
          format: int64
          maximum: 500
          minimum: 1
          type: integer
      required:
        - cpu_kind
        - cpus
        - memory_mb
        - volume_size_gb
        - gpu_kind
      type: object
    DeclaredPreview:
      additionalProperties: false
      properties:
        name:
          maxLength: 200
          minLength: 1
          pattern: \S
          type: string
        port:
          maximum: 65535
          minimum: 1
          type: integer
        url:
          format: uri
          type: string
      required:
        - name
        - port
        - url
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.