Skip to content

List settings history for a category.

GET
/api/admin/settings/{category}/history
Code sample: Shell / cURL
curl --request GET \
--url https://auth.example.com/api/admin/settings/example/history \
--header 'Authorization: Bearer <token>'

List version history for a tenant-scoped settings category. Pagination uses limit and offset query parameters, clamped by the handler.

category
required
string
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Settings history list.

Media type application/json
object
category
required
string
versions
required
Array<object>
object
version
integer
created_at
integer format: int64
created_by
string
change_summary
string
key
additional properties
total
required
integer
limit
required
integer
>= 1
offset
required
integer
key
additional properties
Example generated
{
"category": "example",
"versions": [
{
"version": 1,
"created_at": 1,
"created_by": "example",
"change_summary": "example"
}
],
"total": 1,
"limit": 1,
"offset": 1
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}