Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/workspaces/{id}/backlog/status` (ADR 0045 Stage 1). RBAC: `Read`. The cross-project status summary (per-state counts, queued/in-progress totals, the resolved workspace concurrency ceiling, and the onboarding flag).

GET
/api/workspaces/{id}/backlog/status
curl --request GET \
  --url https://example.com/api/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/backlog/status \
  --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 whose backlog status to summarize

Responses

Section titled “Responses”

200

Section titled “200”

Cross-project backlog status summary

Media typeapplication/json

ADR 0045 Stage 1 — the cross-project backlog status summary for a workspace: the per-state counts (stable map), the queued + in-progress totals (the dispatch- pressure figures), the resolved workspace concurrency ceiling (workspaces.max_backlog_concurrent; None = uncapped), and the onboarding flag (a workspace still onboarding dispatches nothing). The FE renders this above the board to explain “why is/ isn’t anything dispatching”.

object
counts
required
object
key
additional properties
integer format: int64
in_progress
required
integer format: int64
onboarding_mode
required
boolean
total_queued
required
integer format: int64
workspace_ceiling
integer | null format: int32
Examplegenerated
{
  "counts": {
    "additionalProperty": 1
  },
  "in_progress": 1,
  "onboarding_mode": true,
  "total_queued": 1,
  "workspace_ceiling": 1
}

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"
}