Appearance
List feature flags
GET /v1/admin/site/flags
- Operation ID:
listSiteFlags - Tags: Feature flags
- Base URL:
http://localhost:8787
All flags ordered by key. Not paginated.
Workflow: Integration guide.
Authentication: staff Bearer JWT with permission site.read.
Authentication
- Auth: staff Bearer JWT (
Authorization: Bearer <access_token>) with the permissions below. - Required permissions:
site.read
Responses
200
Feature flags.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: (object (SiteFeatureFlag))[]
| Field | Type | Required | Description |
|---|---|---|---|
[].key | string | yes | - |
[].description | string | null | yes | - |
[].enabled | boolean | yes | - |
[].rollout_percent | integer | yes | Min: 0. Max: 100 |
[].audience | object | yes | - |
[].audience.user_ids | string<uuid>[] | no | - |
[].audience.roles | string[] | no | - |
[].is_kill_switch | boolean | yes | - |
[].updated_at | string | yes | ISO 8601 timestamp. |
Errors
401
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}403
Authenticated but lacking the required permission. details.perm lists the accepted permission keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "forbidden",
"details": {
"perm": "site.read"
}
}500
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples
curl
bash
curl -X GET 'http://localhost:8787/v1/admin/site/flags' \
-H "Authorization: Bearer $ACCESS_TOKEN"TypeScript
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/admin/site/flags", {
method: "GET",
headers: {
"Authorization": `Bearer ${accessToken}`,
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();