> ## 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 a form’s locales

> The locales this document exists in.

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

$documentLocales = Attract::forms()->getFormLocales(id: 'clx8m2k4p0000a1b2c3d4e5f6');
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {}
  ]
}
```

## In your app

A controller answers a route on your app: it calls `getFormLocales()` and returns the answer.

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class GetFormLocalesController
{
    public function __invoke(string $id): DocumentLocales
    {
        return Attract::forms()->getFormLocales(id: $id);
    }
}
```

**2. Add the route**

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

Route::get('/form/{id}/locales', GetFormLocalesController::class);
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/form/clx8m2k4p0000a1b2c3d4e5f6/locales
```

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/GetFormLocales.php` (an invokable Action that calls `getFormLocales()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action forms.getFormLocales
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call forms.getFormLocales id=clx8m2k4p0000a1b2c3d4e5f6
```

It calls `getFormLocales()` 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.

## Find the id

`id` is the document’s `_id`, from a list. Ask the list for only the fields you need: each row is a document’s `id` and those fields.

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

$row = Attract::forms()->listFormsPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

```bash Terminal theme={"dark"}
php artisan attract:call forms.listFormsPick fields=title,slug
```

Pass `$row['id']` as `id`. Drafts: list with `aposMode: 'draft'` to get the draft’s id ([Find an id](https://docs.fetchski-attract.com/find-an-id.md)).

> [accordion] Required parameters
>
> Named arguments, e.g. `getFormLocales(id: …)`; leave out the optional ones.
>
> **id** `string` *required*
>
> **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`).

> [accordion] Returns
>
> A `DocumentLocales` (`Fetchski\AttractCmsLaravel\Data\DocumentLocales`). The locales the document exists in. Read its properties (`$documentLocales->results`): each says whether the site always sends it.
>
> **results** `Collection\<int, array\<string, mixed\>\>`
>
> **Always sent.** One entry per locale the document exists in.

> [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 `content:forms:read` (or a master above it: `content:forms:all`, `content:all`, `admin:all`) reads the published documents; drafts (a draft `_id`) need `content:forms:write` (or a master above it). 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.

## 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/GetFormLocalesTest.php`, then run your tests:

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetFormLocalesTest extends TestCase
{
    public function test_get_form_locales(): void
    {
        Attract::fake();

        $this->getJson('/form/clx8m2k4p0000a1b2c3d4e5f6/locales')->assertOk();

        Attract::assertCalled('forms.getFormLocales', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}
```

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

## Related

> [card] [List forms](https://docs.fetchski-attract.com/laravel/reference/forms/list-forms.md)
>
> `Attract::forms()->listForms()`

> [card] [Create a form](https://docs.fetchski-attract.com/laravel/reference/forms/create-form.md)
>
> `Attract::forms()->createForm()`

> [card] [Get a form](https://docs.fetchski-attract.com/laravel/reference/forms/get-form.md)
>
> `Attract::forms()->getForm()`

> [card] [Replace a form](https://docs.fetchski-attract.com/laravel/reference/forms/replace-form.md)
>
> `Attract::forms()->replaceForm()`

> [card] [Delete a form](https://docs.fetchski-attract.com/laravel/reference/forms/delete-form.md)
>
> `Attract::forms()->deleteForm()`

> [card] [Update a form](https://docs.fetchski-attract.com/laravel/reference/forms/update-form.md)
>
> `Attract::forms()->updateForm()`

> [card] [GET /@apostrophecms/form/\{\_id}/locales](https://docs.fetchski-attract.com/api-reference/forms/list-a-form’s-locales.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.