Appearance
List published versions of a settings section
GET /v1/admin/site/settings/{section}/versions
- Operation ID:
listSiteSettingsVersions - Tags: Site settings
- Base URL:
http://localhost:8787
Version history, newest first. 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
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
section | path | string | yes | One of: "general", "branding", "seo", "auth_ui", "billing", "credits", "limits", "support", "legal", "maintenance" |
Responses
200
Version history.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: (object (SiteSettingsVersion))[]
| Field | Type | Required | Description |
|---|---|---|---|
[].id | string | yes | - |
[].section | string | yes | One of: "general", "branding", "seo", "auth_ui", "billing", "credits", "limits", "support", "legal", "maintenance" |
[].version | integer | yes | - |
[].value | object | yes | - |
[].author_id | string<uuid> | null | yes | - |
[].note | string | null | yes | - |
[].created_at | string | yes | ISO 8601 timestamp. |
Errors
400
Request validation failed.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ValidationErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | yes | One of: false |
error | object | yes | - |
error.name | string | yes | One of: "ZodError" |
error.issues | object[] | yes | - |
error.issues[].code | string | yes | - |
error.issues[].path | (string | number)[] | yes | - |
error.issues[].message | string | yes | - |
Request validation
json
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "custom",
"path": [
"field"
],
"message": "Invalid value"
}
]
}
}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/settings/general/versions' \
-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/settings/general/versions", {
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();