Languages

Get a language list

The site’s language list by its _id: the main language’s name, and every further language’s name, code and Public switch.

Access: an API key with languages:read (or a master above it: languages:all, admin:all) reads the published documents. A signed-in person may call it as far as their own permissions allow; anyone else gets 404.

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

{_id}

cURL

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

{
  "_id": "<string>",
  "type": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "mainLanguageName": "English",
  "languages": []
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "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

Path Parameters

_id

string

required

The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Query Parameters

render-areas

boolean

default:false

true: each area’s widgets come back rendered as HTML (_rendered), beside their data.

Response

Success

SiteLanguages content type

_id

string

required

read-only

The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.

type

string

required

read-only

The document type’s name: always this type’s.

createdAt

string<date-time>

required

read-only

When it was created (ISO 8601).

updatedAt

string<date-time>

required

read-only

When it last changed (ISO 8601).

mainLanguageName

string | null

default:English

The language the site is written in first, named as its speakers write it. Its pages keep their addresses as they are (/about).

languages

More languages · object[] | null

Each language gets its own addresses (/fr/about) and its own copy of every page, translated with Localize. A language you remove keeps its translations: add the same code again and they come back.

Show child attributes

cURL

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

{
  "_id": "<string>",
  "type": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "mainLanguageName": "English",
  "languages": []
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

{
  "name": "<string>",
  "message": "<string>",
  "data": {}
}

Get started

How the API works

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Signing in (people)

Get a language list

Authorizations

Scopes

Path Parameters

Query Parameters

Response