Languages

List the Global fields each language translates

The Site settings and Site design fields that hold words a visitor reads (the tagline, the header and footer links and labels, the cookie banner), by name. Each language’s Global keeps its own value of these; every other Global field is shared, and a save in any language writes it to them all.

To translate a language’s header, footer and cookie banner, read its Global with aposLocale set to the language, translate these fields, and patch them back: send only these fields, so no shared setting changes. A link in them (url, headerCtaUrl, cookiePolicyUrl) is the language’s own too: point it at the page in that language.

Access: an API key with languages:read, or languages:all, or admin:all, or a signed-in user holding the languages:manage permission. Other callers get 403.

Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After.

GET

site-languages

global-fields

cURL

curl --request GET \
  --url https://{host}/api/v1/site-languages/global-fields \
  --header 'Authorization: <api-key>'

{
  "translated": [
    "tagline",
    "headerNav",
    "headerMoreLabel",
    "footerLinkGroups",
    "cookieTitle"
  ]
}

{
  "name": "invalid",
  "message": "The API key is not valid.",
  "data": {}
}

{
  "name": "forbidden",
  "message": "This API key lacks the required scope: forms:read.",
  "data": {}
}

{
  "name": "tooManyRequests",
  "message": "This API key’s rate limit is used up for this minute.",
  "data": {}
}

Authorizations

Authorization

string

header

required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

languages:read

Response

The translated fields.

translated

string[]

required

The field names, as Global’s REST routes read and write them.

cURL

curl --request GET \
  --url https://{host}/api/v1/site-languages/global-fields \
  --header 'Authorization: <api-key>'

{
  "translated": [
    "tagline",
    "headerNav",
    "headerMoreLabel",
    "footerLinkGroups",
    "cookieTitle"
  ]
}

{
  "name": "invalid",
  "message": "The API key is not valid.",
  "data": {}
}

{
  "name": "forbidden",
  "message": "This API key lacks the required scope: forms:read.",
  "data": {}
}

{
  "name": "tooManyRequests",
  "message": "This API key’s rate limit is used up for this minute.",
  "data": {}
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

List the Global fields each language translates

Authorizations

Scopes

Response