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

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$siteLanguagesList = Attract::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 controller answers a route on your app: it calls `listSiteLanguages()` and returns the answer.

**1. Add the controller**

```php app/Http/Controllers/ListSiteLanguagesController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\SiteLanguagesList;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class ListSiteLanguagesController
{
    public function __invoke(): SiteLanguagesList
    {
        return Attract::languages()->listSiteLanguages();
    }
}
```

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\ListSiteLanguagesController;
use Illuminate\Support\Facades\Route;

Route::get('/site-languages', ListSiteLanguagesController::class);
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/site-languages
```

With `php artisan serve` running, it prints its answer as JSON.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/ListSiteLanguages.php` (an invokable Action that calls `listSiteLanguages()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action languages.listSiteLanguages
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call languages.listSiteLanguages
```

It calls `listSiteLanguages()` on your default site and prints its answer as JSON. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

```bash Terminal theme={"dark"}
php artisan attract:call languages.listSiteLanguagesPick fields=id
```

Only the fields you name, for every document across every page: [Find an id](https://docs.fetchski-attract.com/find-an-id.md).

> [accordion] Optional parameters
>
> Named arguments, e.g. `listSiteLanguages(page: …)`; leave out the optional ones.
>
> **page** `?int`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `?int`
>
> **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`
>
> **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** `?bool`
>
> **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`
>
> **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` (`Fetchski\AttractCmsLaravel\Data\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** `Collection\<int, SiteLanguages\>`
>
> **Always sent.** A list of `SiteLanguages`. This page’s documents; empty past the last page.
>
> **SiteLanguages (Fetchski\AttractCmsLaravel\Data\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** `CarbonImmutable`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `CarbonImmutable`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **mainLanguageName** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The language the site is written in first, named as its speakers write it. Its pages keep their addresses as they are (/about).
>
> **languages** `Collection\<int, SiteLanguagesLanguagesItem\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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 (Fetchski\AttractCmsLaravel\Data\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:** `null` when the site leaves it out. The row’s id, unique in its array.
>
> **public** `?bool`
>
> **Sometimes sent:** `null` 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** `array\<string, mixed\>`
>
> **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. An object in it that a PHP array would read as a list (`{}`, `{"0": …}`) is a `stdClass`, so it is sent back as an object.
>
> **pages** `int`
>
> **Always sent.** Pages in the whole list (0 when it is empty).
>
> **currentPage** `int`
>
> **Always sent.** This page, from 1.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/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`
>
> `Attract::site('acme')` named a slug that isn’t under `sites` in `config/fetchski-attract.php`.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()`, `$e->slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s config entry is wrong: no `url`, a malformed `api_key`, a key filed under another slug, or no default site.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()` (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` in `config/fetchski-attract.php` 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.

```php Every page wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$siteLanguagesList = Attract::languages()->listSiteLanguagesAll(); // LazyCollection<int, SiteLanguages>: the next page is fetched as you iterate
```

```php Only some fields wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$rows = Attract::languages()->listSiteLanguagesPick(fields: ['id']); // LazyCollection of ['id' => …]: every language list, across every page
```

## Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as `tests/Feature/ListSiteLanguagesTest.php`, then run your tests:

```php tests/Feature/ListSiteLanguagesTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ListSiteLanguagesTest extends TestCase
{
    public function test_list_site_languages(): void
    {
        Attract::fake();

        $this->getJson('/site-languages')->assertOk();

        Attract::assertCalled('languages.listSiteLanguages');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `languages.listSiteLanguages` with a `sequence()` of pages, each `SiteLanguagesList::factory()->make([...])`, and walk `listSiteLanguagesAll()`.

```php tests/Feature/ListSiteLanguagesAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\SiteLanguagesList;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ListSiteLanguagesAnswerTest extends TestCase
{
    public function test_list_site_languages_answers_your_values(): void
    {
        Attract::fake([
            'languages.listSiteLanguages' => Attract::sequence(
                SiteLanguagesList::factory()->make(['currentPage' => 1, 'pages' => 2]),
                SiteLanguagesList::factory()->make(['currentPage' => 2, 'pages' => 2]),
            ),
        ]);

        $siteLanguagesList = Attract::languages()->listSiteLanguagesAll();

        $this->assertCount(2, $siteLanguagesList->all());
    }
}
```

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/laravel/reference/languages/get-global-translated-fields.md)
>
> `Attract::languages()->getGlobalTranslatedFields()`

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

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

> [card] [Update a language list](https://docs.fetchski-attract.com/laravel/reference/languages/update-site-languages.md)
>
> `Attract::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.