> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const siteLanguagesList = await site.languages().listSiteLanguages();
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "mainLanguageName": "English",
      "languages": [],
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "type": "Example type",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

**1. Add the function**

```ts src/attract/list-site-languages.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function listSiteLanguages(site: SiteClient) {
  return site.languages().listSiteLanguages();
}
```

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/list-site-languages.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { listSiteLanguages } from '../src/attract/list-site-languages.ts';

const site = createSiteClient();
console.log(await listSiteLanguages(site));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/list-site-languages.ts
```

A route handler, a job or a queue worker calls it the same way.

> [accordion] Optional parameters
>
> One object, e.g. `listSiteLanguages({ page })`; leave out the optional fields.
>
> **page** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `number | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. 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. At least 1.
>
> **search** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. 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).
>
> **renderAreas** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.
>
> **slug** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. 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.

> [accordion] Returns
>
> A `SiteLanguagesList`. A page of SiteLanguages documents. Read its properties (`siteLanguagesList.results`): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (`_id` → `id`).
>
> **results** `readonly SiteLanguages[]`
>
> **Always sent.** A list of `SiteLanguages`. This page’s documents; empty past the last page.
>
> **SiteLanguages**
>
> SiteLanguages content type
>
> **id** `string`
>
> **Always sent.** 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`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **createdAt** `Date`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **mainLanguageName** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The language the site is written in first, named as its speakers write it. Its pages keep their addresses as they are (/about).
>
> **languages** `readonly SiteLanguagesLanguagesItem[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A list of `SiteLanguagesLanguagesItem`. 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.
>
> **SiteLanguagesLanguagesItem**
>
> **name** `string`
>
> **Always sent.** As its speakers write it, for example “Français”. Shown in the language switcher.
>
> **code** `string`
>
> **Always sent.** A lowercase language code, for example “fr”; add a region (“pt-br”, “es-419”), a script (“zh-hant”) or both (“zh-hant-tw”). It starts every address in this language (/fr/…) and can’t be “en”.
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **public** `boolean`
>
> **Sometimes sent:** `undefined` when the site leaves it out. No: only people signed in to the CMS see this language, so it can be translated first. Yes: visitors see it and the language switcher lists it.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.
>
> **pages** `number`
>
> **Always sent.** Pages in the whole list (0 when it is empty).
>
> **currentPage** `number`
>
> **Always sent.** This page, from 1.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see [Errors and testing](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage` names it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No (only a 502, 503 or 504 is retried). **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Yes, after 0.5 s then 1 s. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The client’s settings are wrong: no `FETCHSKI_ATTRACT_URL` (or `baseUrl`), or a malformed API key.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **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`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) on the client for longer.
* **Paging:** one page per call. To walk them all, use `listSiteLanguagesAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listSiteLanguagesAll()` takes `listSiteLanguages()`’s arguments except `page`. `listSiteLanguagesPick()` takes the same arguments except `page`, after the fields to answer: each row is the document’s `id` and those fields.

```ts Every page wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
for await (const siteLanguages of site.languages().listSiteLanguagesAll()) {
  console.log(siteLanguages); // the next page is fetched as you iterate
}
```

```ts Only some fields wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const rows = await site.languages().listSiteLanguagesPick(['id']); // [{ id }, …]: every language list, across every page
```

## Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with `node --test`.

```ts tests/languages-listSiteLanguages.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { listSiteLanguages } from '../src/attract/list-site-languages.ts';

test('languages.listSiteLanguages', async () => {
  const site = fakeSite();
  await listSiteLanguages(site);
  site.assertCalled('languages.listSiteLanguages');
});
```

**Answer with your own values:** fake `languages.listSiteLanguages` with a `sequence()` of pages, each `factories.SiteLanguagesList({...})`, and walk `listSiteLanguagesAll()`.

```ts tests/languages-listSiteLanguages-answer.test.ts theme={"dark"}
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite, sequence } from '@fetchski/attract-cms-sdk/testing';

test('languages.listSiteLanguages answers your values', async () => {
  const site = fakeSite({
    'languages.listSiteLanguages': sequence(
      factories.SiteLanguagesList({ currentPage: 1, pages: 2 }),
      factories.SiteLanguagesList({ currentPage: 2, pages: 2 })
    )
  });
  const walked: unknown[] = [];
  for await (const siteLanguages of site.languages().listSiteLanguagesAll()) {
    walked.push(siteLanguages);
  }
  assert.equal(walked.length, 2);
});
```

To fake `listSiteLanguagesAll()`, answer `languages.listSiteLanguages` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List the Global fields each language translates](https://docs.fetchski-attract.com/typescript/reference/languages/get-global-translated-fields.md)
>
> `site.languages().getGlobalTranslatedFields()`

> [card] [Get a language list](https://docs.fetchski-attract.com/typescript/reference/languages/get-site-languages.md)
>
> `site.languages().getSiteLanguages()`

> [card] [Replace a language list](https://docs.fetchski-attract.com/typescript/reference/languages/replace-site-languages.md)
>
> `site.languages().replaceSiteLanguages()`

> [card] [Update a language list](https://docs.fetchski-attract.com/typescript/reference/languages/update-site-languages.md)
>
> `site.languages().updateSiteLanguages()`

> [card] [GET /site-languages](https://docs.fetchski-attract.com/api-reference/languages/list-language-lists.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.