> ## Documentation Index > Fetch the complete documentation index at: https://docs.sfcompute.com/llms.txt > Use this file to discover all available pages before exploring further. # List workspaces > > ⚠️ This endpoint is in [public preview](/preview/roadmap). List all workspaces for the authenticated account. ## OpenAPI ````yaml /preview/openapi.json get /preview/v2/workspaces openapi: 3.1.0 info: title: sfc-api description: >- Public preview API - subject to change. See https://docs.sfcompute.com/preview/roadmap for details. version: 0.1.0 servers: - url: https://api.sfcompute.com security: - bearer_auth: [] tags: - name: Pools description: A bucket of owned compute balance over time. - name: Orders description: >- Place orders targeting a capacity to increase your reserved compute balance during some time period. - name: Instance Templates description: Reusable instance configuration. - name: Images description: Custom machine images for instances. - name: Roles description: TOML-based permission role definitions. - name: Grants description: Bind principals (users or tokens) to roles on a workspace. - name: Tokens description: Workspace-scoped API tokens. - name: Instances description: Spin up instances in a capacity to use your available compute. - name: Instance SKU Catalog description: Browse available instance SKU property definitions. - name: Procurements description: Market automations that maintain capacity by placing buy/sell orders. - name: Deployments description: Deployment automations that maintain a fleet of instances on a capacity. - name: Users description: Read-only access to users within the caller's organization. - name: Workspaces description: Resource containers scoped to an account. - name: Permissions description: Inspect what the caller is allowed to do. - name: Billing description: Billing profile, contacts, and auto top-up settings. - name: Orderbook description: >- Read-only orderbook visibility: bid/ask spread, depth of book, and historical fills, keyed on hardware requirements + delivery window. - name: Orders description: >- Estimate an order before placing it: filled price, fee, and operational notices. paths: /preview/v2/workspaces: get: tags: - Workspaces summary: List workspaces description: |- > ⚠️ This endpoint is in [public preview](/preview/roadmap). List all workspaces for the authenticated account. operationId: list_workspaces_handler parameters: - name: id in: query description: Filter by workspace ID, resource path, or name (repeatable). required: false schema: type: array items: $ref: '#/components/schemas/ResourcePathOrId_WorkspaceId' style: form explode: true responses: '200': description: List of workspaces. content: application/json: schema: $ref: '#/components/schemas/ListWorkspacesResponse' '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: Forbidden. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '422': description: Validation error. content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityError' '500': description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/InternalServerError' components: schemas: ResourcePathOrId_WorkspaceId: type: string description: >- A resource path like 'sfc:workspace:acme:my-workspace' _or_ an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent. examples: - wksp_k3R-nX9vLm7Qp2Yw5Jd8F pattern: >- (wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1}) ListWorkspacesResponse: type: object required: - object - data - has_more properties: object: type: string const: list default: list readOnly: true data: type: array items: $ref: '#/components/schemas/WorkspaceResponse' has_more: type: boolean UnauthorizedError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: authentication_error default: authentication_error readOnly: true message: type: string x-speakeasy-error-message: true ForbiddenError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: forbidden default: forbidden readOnly: true message: type: string x-speakeasy-error-message: true UnprocessableEntityError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: unprocessable_entity default: unprocessable_entity readOnly: true message: type: string x-speakeasy-error-message: true details: type: array items: $ref: '#/components/schemas/ErrorDetail' InternalServerError: type: object required: - error properties: error: type: object required: - type - message properties: type: type: string const: api_error default: api_error readOnly: true message: type: string x-speakeasy-error-message: true WorkspaceResponse: allOf: - $ref: '#/components/schemas/WorkspaceScope' - type: object required: - object - created_at properties: object: type: string const: workspace default: workspace readOnly: true created_at: $ref: '#/components/schemas/UnixEpoch' ErrorDetail: type: object required: - code - message properties: field: type: - string - 'null' description: The field that caused the error (for validation errors) code: type: string description: Specific error code for this detail message: type: string description: Human-readable error message WorkspaceScope: type: object required: - id - resource_path - owner - name properties: id: $ref: '#/components/schemas/WorkspaceId' resource_path: $ref: '#/components/schemas/workspaceResourcePath_WorkspaceId' owner: $ref: '#/components/schemas/Name' name: $ref: '#/components/schemas/Name' UnixEpoch: type: integer format: int64 description: Unix timestamp. example: 1738972800 WorkspaceId: type: string examples: - wksp_k3R-nX9vLm7Qp2Yw5Jd8F pattern: wksp_[0-9a-zA-Z_-]{1,21} workspaceResourcePath_WorkspaceId: type: string description: >- A resource path for a workspace resource. Format: sfc:workspace::. examples: - sfc:workspace:: pattern: sfc:workspace:([a-zA-Z0-9._-]+:){1}[a-zA-Z0-9._-]+ Name: type: string examples: - my-resource-name maxLength: 255 minLength: 1 pattern: '[a-zA-Z0-9][a-zA-Z0-9._-]{0,254}' securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: >- Create an API token using `sf tokens create` or at https://sfcompute.com/account/api-keys. ````