Skip to main content
GET
List workspaces

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})
limit
integer<u-int32>
default:50

Maximum number of results to return (1-200, default 50).

Required range: 1 <= x <= 200
starting_after
string

Cursor for forward pagination (from a previous response's cursor field).

Pattern: ^wkspc_[A-Za-z0-9_-]+$
Example:

"wkspc_gqXR7s0Kj5mHvE2wNpLc4Q"

ending_before
string

Cursor for backward pagination.

Pattern: ^wkspc_[A-Za-z0-9_-]+$
Example:

"wkspc_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

List of workspaces.

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

Pass as starting_after or ending_before to paginate.

Pattern: ^wkspc_[A-Za-z0-9_-]+$
Example:

"wkspc_gqXR7s0Kj5mHvE2wNpLc4Q"