Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/settings/env-vars/board` — one server-paginated, filtered + sorted page of the settings env-vars board plus the total + the facet chips.

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string

Free-text search over the variable key.

scope
string

scope filter chip (personal | workspace | organization).

sort
string

Whitelisted sort column: key | created_at | scope. Default created_at.

dir
string

asc | desc (default desc).

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

Recompute the facet chips (default true). The board sends false on a page/sort change since the chip counts are workspace-wide.

Responses

Section titled “Responses”

200

Section titled “200”

One page of env vars.

Media typeapplication/json

GET /api/settings/env-vars/board body — one page of env vars + total + facet chips.

object
facets
One of:
null
items
required
Array<object>
object
created_at
required
string format: date-time
id
required
string format: uuid
is_secret
required
boolean
key
required
string
locked
required
boolean
organization_id
string | null format: uuid
project_id
string | null format: uuid
value
required
string
workspace_id
string | null format: uuid
total
required
integer format: int64
Examplegenerated
{
  "facets": {
    "by_scope": [
      {
        "count": 1,
        "value": "example"
      }
    ],
    "total": 1
  },
  "items": [
    {
      "created_at": "2026-04-15T12:00:00Z",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "is_secret": true,
      "key": "example",
      "locked": true,
      "organization_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "value": "example",
      "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "total": 1
}

400

Section titled “400”

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

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