Skip to content
TomeCMSTomeCMSTomeCMS

Get public site settings

GET
/api/v1/content/site
curl --request GET \
  --url https://example.com/api/v1/content/site

Responses

Section titled “ Responses ”

200

Section titled “200”

Public site settings.

Media typeapplication/json
object
data
required
object
author
required
Any of:
object
avatar
required
Any of:
object
altText
required
Any of:
string
<= 300 characters
height
required
integer
> 0 <= 9007199254740991
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
mimeType
required
string
Allowed values: image/avif image/gif image/jpeg image/png image/webp
sizeBytes
required
integer
> 0 <= 9007199254740991
url
required
string
>= 1 characters <= 2048 characters
width
required
integer
> 0 <= 9007199254740991
bio
required
object
en
required
string
<= 1000 characters
th
required
string
<= 1000 characters
links
required
Array<object>
<= 5 items
object
label
required
string
>= 1 characters <= 80 characters
url
required
string format: uri
name
required
string
>= 1 characters <= 120 characters
brand
required
object
icon
required
Any of:
object
png180
required
string format: uri
png32
required
string format: uri
svg
required
Any of:
string format: uri
logo
required
Any of:
object
height
required
integer
> 0 <= 9007199254740991
mimeType
required
string
Allowed values: image/jpeg image/png image/svg+xml image/webp
url
required
string format: uri
width
required
integer
> 0 <= 9007199254740991
logoDark
required
Any of:
object
height
required
integer
> 0 <= 9007199254740991
mimeType
required
string
Allowed values: image/jpeg image/png image/svg+xml image/webp
url
required
string format: uri
width
required
integer
> 0 <= 9007199254740991
showSiteName
required
boolean
defaultLocale
required
string
Allowed values: th en
description
required
string
<= 160 characters
name
required
string
>= 1 characters <= 120 characters
supportedLocales
required
array
>= 2 items <= 2 items
tagline
required
string
<= 120 characters
timezone
required
string
Allowed values: Asia/Bangkok UTC
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
Example
{
  "data": {
    "author": {
      "avatar": {
        "mimeType": "image/avif"
      }
    },
    "brand": {
      "logo": {
        "mimeType": "image/jpeg"
      },
      "logoDark": {
        "mimeType": "image/jpeg"
      }
    },
    "defaultLocale": "th",
    "timezone": "Asia/Bangkok"
  }
}

304

Section titled “304”

The cached representation is still current.

400

Section titled “400”

The request parameters are invalid.

Media typeapplication/problem+json
object
detail
required
string
>= 1 characters
instance
required
string
>= 1 characters <= 2048 characters
maintenance
object
backAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
heading
required
string
>= 1 characters
locale
required
string
Allowed values: th en
message
required
string
>= 1 characters
requestId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
integer
>= 400 <= 599
title
required
string
>= 1 characters
type
required
string
>= 1 characters <= 2048 characters
Example
{
  "maintenance": {
    "locale": "th"
  }
}

500

Section titled “500”

The request could not be completed.

Media typeapplication/problem+json
object
detail
required
string
>= 1 characters
instance
required
string
>= 1 characters <= 2048 characters
maintenance
object
backAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
heading
required
string
>= 1 characters
locale
required
string
Allowed values: th en
message
required
string
>= 1 characters
requestId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
integer
>= 400 <= 599
title
required
string
>= 1 characters
type
required
string
>= 1 characters <= 2048 characters
Example
{
  "maintenance": {
    "locale": "th"
  }
}

503

Section titled “503”

The content service is not ready, or the site is closed for maintenance; then maintenance carries what the owner wrote for visitors.

Media typeapplication/problem+json
object
detail
required
string
>= 1 characters
instance
required
string
>= 1 characters <= 2048 characters
maintenance
object
backAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
heading
required
string
>= 1 characters
locale
required
string
Allowed values: th en
message
required
string
>= 1 characters
requestId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
integer
>= 400 <= 599
title
required
string
>= 1 characters
type
required
string
>= 1 characters <= 2048 characters
Example
{
  "maintenance": {
    "locale": "th"
  }
}