Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/projects/board` — one server-paginated, tab/provider/autodev-filtered page of the projects board plus the total + the summary/provider facets.

GET
/api/projects/board
curl --request GET \
  --url https://example.com/api/projects/board \
  --cookie supacloud_session=<supacloud_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
tab
string

Active NavTab: all / active / autodev / archived (default all).

provider
string
autodev
string

Auto-Dev select: on / off (else unset).

status
string

Last-run-status facet chip: keep only projects whose latest task has this status.

q
string

#691 §E — free-text search over the project name + git repo URL.

sort
string

#691 §E — whitelisted sort key: name | created_at | repo | status | runs | last_run_at | provider | features.

dir
string

Sort direction asc | desc (default desc).

limit
integer format: int64
offset
integer format: int64
include_facets
boolean

Recompute the summary/provider facets (default true). The board sends false for a tab/page change (the facets depend only on the workspace).

Responses

Section titled “Responses”

200

Section titled “200”

One page of the projects board: rows + total + optional facets

Media typeapplication/json

GET /api/projects/board body — one page of project overviews + total + facets.

object
facets
required
One of:
null
items
required
Array<object>

Wire shape for one Projects board row. Mirrors ProjectOverviewRow but with the two counts narrowed to i64 JSON numbers and no DB-only concerns. The nullable fields are marked required so the wire shape always carries the key (the FE reads them as required-but-nullable).

object
active_runs
required
integer format: int64
archived
required

#358 — true when the project is archived (hidden from the active board).

boolean
backlog_mode_enabled
required
boolean
created_at
required
string format: date-time
git_default_branch
required
string | null
git_provider
required
string | null
git_repo_url
required
string | null
id
required
string format: uuid
image_error
required
string | null
image_status
required
string | null
issue_tracker
required
string | null
issue_tracker_key
required
string | null
last_run_at
required
string | null format: date-time
last_run_error
required
string | null
last_run_status
required
string | null
max_concurrent_runs
required
integer | null format: int32
name
required
string
task_count
required
integer format: int64
total
required
integer format: int64
Examplegenerated
{
  "facets": {
    "autodev_count": 1,
    "by_status": [
      {
        "count": 1,
        "value": "example"
      }
    ],
    "providers": [
      "example"
    ],
    "total": 1
  },
  "items": [
    {
      "active_runs": 1,
      "archived": true,
      "backlog_mode_enabled": true,
      "created_at": "2026-04-15T12:00:00Z",
      "git_default_branch": "example",
      "git_provider": "example",
      "git_repo_url": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "image_error": "example",
      "image_status": "example",
      "issue_tracker": "example",
      "issue_tracker_key": "example",
      "last_run_at": "2026-04-15T12:00:00Z",
      "last_run_error": "example",
      "last_run_status": "example",
      "max_concurrent_runs": 1,
      "name": "example",
      "task_count": 1
    }
  ],
  "total": 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"
}