Languages

List language lists

The site’s one language list, as a page of one result: 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

cURL

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

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

{
  "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

Query Parameters

page

integer

default:1

Page number for pagination (1-based)

Required range: x >= 1

perPage

integer

Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one.

Required range: x >= 1

string

Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones).

render-areas

boolean

default:false

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

slug

string

Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL.

fields

string[]

Only these fields of each document, beside its _id: fields=title&fields=slug, or fields=title,slug. Use it to find a document’s _id without reading every field of every document. A page keeps its place in the tree (_children). A field the type lacks is refused (400) with the list of its fields; the public, and an API key without the type’s read scope, may name only its public fields.

Response

Success

A page of SiteLanguages documents.

results

object[]

required

This page’s documents; empty past the last page.

Show child attributes

pages

integer

required

Pages in the whole list (0 when it is empty).

currentPage

integer

required

This page, from 1.

cURL

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

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

{
  "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)

List language lists

Authorizations

Scopes

Query Parameters

Response