Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/workspaces/{id}/worker-groups` — list the workspace's groups ∪ the instance-global set (workspace admin).

GET
/api/workspaces/{id}/worker-groups
curl --request GET \
  --url https://example.com/api/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/worker-groups \
  --cookie supacloud_session=<supacloud_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Workspace ID

Responses

Section titled “Responses”

200

Section titled “200”

Worker groups (workspace-owned + instance-global)

Media typeapplication/json
Array<object>

A worker_groups row. workspace_id = NULL is an instance-global group (system-admin), usable by any workspace’s bindings. FromRow auto-maps from SELECT *. The labels are the AND-set a runner must advertise to serve this group; a required group contributes its labels into a task’s flat required_labels.

object
created_at
required
string format: date-time
created_by
string | null format: uuid
description
string | null
id
required
string format: uuid
labels
required

The AND-set of dispatch labels a runner must advertise to serve this group.

Array<string>
name
required
string
slug
required
string
updated_at
required
string format: date-time
workspace_id

Owning workspace; None = instance-global.

string | null format: uuid
Examplegenerated
[
  {
    "created_at": "2026-04-15T12:00:00Z",
    "created_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "description": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "labels": [
      "example"
    ],
    "name": "example",
    "slug": "example",
    "updated_at": "2026-04-15T12:00:00Z",
    "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
]

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}