Skip to main content
GET
/
preview
/
v2
/
workspaces
List workspaces
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/workspaces \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "resource_path": "<string>",
      "owner": "<string>",
      "name": "<string>",
      "object": "workspace",
      "created_at": 1738972800
    }
  ],
  "has_more": true
}

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.

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Query Parameters

​
id
string[]

Filter by workspace ID, resource path, or name (repeatable).

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.

Pattern: (wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1})

Response

List of workspaces.

​
object
string
default:list
required
read-only
Allowed value: "list"
​
data
object[]
required
​
has_more
boolean
required