Skip to content
em sa em sa

Get Cms Keys

GET
/api/superadmin/cms/{page_id}/keys
 
curl --request GET \
  --url https://example.com/api/superadmin/cms/example/keys \
  --header 'Authorization: Bearer <token>'

Return the key registry with defaults, field types, sections, and labels.

No DB query needed — reads directly from the in-memory registry.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
page_id
required
Page Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
CMSKeysResponse

Response model for GET /api/superadmin/cms/{page_id}/keys.

object
page_id
required
Page Id
string
keys
required
Keys
Array<object>
CMSKeyEntry

Single key definition for the registry endpoint.

object
key
required
Key
string
default_value
required
Default Value
string
field_type
required
Field Type
string
section
required
Section
string
label
required
Label
string
Example generated
{
  "page_id": "example",
  "keys": [
    {
      "key": "example",
      "default_value": "example",
      "field_type": "example",
      "section": "example",
      "label": "example"
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}