> ## 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 the page templates

> Every whole-page starting arrangement, with its current sections.

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

$listPageTemplates = Attract::pageTemplates()->listPageTemplates();
```

```json 200 wrap theme={"dark"}
{
  "templates": [
    {
      "_id": "clx8k2m0a0001abcd1234efgh:en:draft",
      "title": "About",
      "category": "Story",
      "description": "Introduce who you are, prove it with a few numbers, meet the team, share what you stand for, and invite people to get in touch.",
      "widgetTypes": [
        "page-header",
        "intro",
        "stats",
        "team",
        "media-text",
        "final-cta"
      ],
      "placeholders": 3,
      "previewUrl": "/apos-frontend/default/modules/page-template/template-about.svg"
    }
  ]
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ListPageTemplatesController
{
    public function __invoke(): ListPageTemplatesResponse
    {
        return Attract::pageTemplates()->listPageTemplates();
    }
}
```

**2. Add the route**

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

Route::get('/page-template/list', ListPageTemplatesController::class);
```

Register it before `Route::get('/page-template/{id}', …)`: Laravel takes the first route that matches, and that one matches this URL too.

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/page-template/list
```

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

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call pageTemplates.listPageTemplates
```

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

A signed-in user sees the templates they may copy.

Make a page from one with Pages → create, sending `_copyingId` (`copyingId` in the SDKs) set to its `_id` (which needs `content:pages:write`).

> [accordion] Parameters
>
> None: call it with no arguments.

> [accordion] Returns
>
> A `ListPageTemplatesResponse` (`Fetchski\AttractCmsLaravel\Data\ListPageTemplatesResponse`). The templates. Read its properties (`$listPageTemplates->templates`): 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`).
>
> **templates** `Collection\<int, PageTemplate\>`
>
> **Always sent.** A list of `PageTemplate`. Every template the caller may read.
>
> **PageTemplate (Fetchski\AttractCmsLaravel\Data\PageTemplate)**
>
> **id** `string`
>
> **Always sent.** The template page’s draft `_id`: read it with GET /page-template/\{\_id}, or create a page with core’s page create and `_copyingId` (`copyingId` in the SDKs) set to it.
>
> **title** `string`
>
> **Always sent.** Its name.
>
> **category** `string`
>
> **Always sent.** The gallery group, e.g. “Story”, “Legal”.
>
> **widgetTypes** `Collection\<int, string\>`
>
> **Always sent.** Its sections, in order (widget types).
>
> **placeholders** `int`
>
> **Always sent.** How many different `[Bracketed placeholders]` its text carries (fill them with POST /business-placeholders/fill).
>
> **previewUrl** `string`
>
> **Always sent.** A wireframe preview (SVG).
>
> **description** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. What the page is for.

> [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)).
>
> **AuthenticationFailed** `401`
>
> The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **Forbidden** `403`
>
> The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **NotFound** `404`
>
> Nothing matches the identifier, or the caller may not use this route at all (it is not advertised).
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **RateLimited** `429`
>
> The key used up its per-minute limit. Still, after the client’s own waits and retries.
>
> **Retried first:** Yes: the client waits `Retry-After` (1 s when absent; over 60 s it gives up at once) and retries, up to `retries` times (2 by default). **Read:** `retryAfter()` (seconds, or null), `siteMessage()`.
>
> **SiteError** `5xx`
>
> The site failed (or something in front of it did). Its logs say why.
>
> **Retried first:** A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. **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:pages:read-templates`, or `content:pages:all`, or `content:all`, or `admin:all`, or a signed-in user holding the `page-templates:use` permission. Other callers get 403.
* **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/ListPageTemplatesTest.php`, then run your tests:

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListPageTemplatesTest extends TestCase
{
    public function test_list_page_templates(): void
    {
        Attract::fake();

        $this->getJson('/page-template/list')->assertOk();

        Attract::assertCalled('pageTemplates.listPageTemplates');
    }
}
```

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

## Related

> [card] [Get a page template](https://docs.fetchski-attract.com/laravel/reference/page-templates/get-page-template.md)
>
> `Attract::pageTemplates()->getPageTemplate()`

> [card] [GET /page-template/list](https://docs.fetchski-attract.com/api-reference/page-templates/list-the-page-templates.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.