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

# Get a page template

> One template: its list entry and its page in full (title, type and every section with its fields), to read its copy or make a page from it.

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

$pageTemplateDetail = Attract::pageTemplates()->getPageTemplate(id: 'clx8m2k4p0000a1b2c3d4e5f6');
```

```json 200 wrap theme={"dark"}
{
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "title": "Example title",
  "category": "Example category",
  "description": "Example description",
  "widgetTypes": [
    "Example widget type"
  ],
  "placeholders": 1,
  "previewUrl": "https://acme.example/example",
  "page": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "aposDocId": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "type": "Example type",
    "slug": "example-slug",
    "sections": {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "metaType": "Example meta type",
      "items": [
        {
          "_id": "clx8m2k4p0000a1b2c3d4e5f6",
          "type": "Example type",
          "metaType": "Example meta type"
        }
      ]
    }
  }
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class GetPageTemplateController
{
    public function __invoke(string $id): PageTemplateDetail
    {
        return Attract::pageTemplates()->getPageTemplate(id: $id);
    }
}
```

**2. Add the route**

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

Route::get('/page-template/{id}', GetPageTemplateController::class);
```

**3. Call it**

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

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

## Call it from the terminal

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

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

Send the template’s draft `_id` as the list returns it. Anything that is not a template answers 404.

> [accordion] Required parameters
>
> Named arguments, e.g. `getPageTemplate(id: …)`; leave out the optional ones.
>
> **id** `string` *required*
>
> **Required.** The template’s draft `_id` (`…:draft`), as the list returns it, or its `aposDocId`.

> [accordion] Returns
>
> A `PageTemplateDetail` (`Fetchski\AttractCmsLaravel\Data\PageTemplateDetail`). The template. Read its properties (`$pageTemplateDetail->id`): 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`).
>
> **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).
>
> **page** `PageTemplatePage`
>
> **Always sent.** A `PageTemplatePage`. The template’s page, in full as its draft stands: every field its page type stores, with the `sections` area holding every widget.
>
> **PageTemplatePage (Fetchski\AttractCmsLaravel\Data\PageTemplatePage)**
>
> **id** `string`
>
> **Always sent.** The draft `_id` (`…:draft`).
>
> **aposDocId** `string`
>
> **Always sent.** The id shared by every locale and mode.
>
> **title** `string`
>
> **Always sent.** The page title a copy starts with.
>
> **type** `string`
>
> **Always sent.** Its page type, e.g. `default-page`.
>
> **slug** `string`
>
> **Always sent.** Its slug under `/templates`.
>
> **sections** `PageTemplatePageSections`
>
> **Always sent.** A `PageTemplatePageSections`. The page’s sections area.
>
> **PageTemplatePageSections (Fetchski\AttractCmsLaravel\Data\PageTemplatePageSections)**
>
> **items** `Collection\<int, PageTemplateSection\>`
>
> **Always sent.** A list of `PageTemplateSection`. Its sections, in order.
>
> **PageTemplateSection (Fetchski\AttractCmsLaravel\Data\PageTemplateSection)**
>
> One section of the template: a widget, with its type and the fields that type stores.
>
> **id** `string`
>
> **Always sent.** The widget’s id.
>
> **type** `string`
>
> **Always sent.** Its widget type, e.g. `hero`.
>
> **metaType** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Always `widget`.
>
> **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.
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **metaType** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Always `area`.
>
> **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.
>
> **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.
>
> **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.

## More examples

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

$pageTemplateDetail = Attract::pageTemplates()->findPageTemplate(id: 'clx8m2k4p0000a1b2c3d4e5f6'); // ?PageTemplateDetail: null when the site answers 404
```

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetPageTemplateTest extends TestCase
{
    public function test_get_page_template(): void
    {
        Attract::fake();

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

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

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

**Answer with your own values:** fake `pageTemplates.getPageTemplate` with `PageTemplateDetail::factory()->make([...])`, the fields you give over a valid example (nested ones too).

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetPageTemplateAnswerTest extends TestCase
{
    public function test_get_page_template_answers_your_values(): void
    {
        Attract::fake([
            'pageTemplates.getPageTemplate' => PageTemplateDetail::factory()->make(['page' => ['id' => 'Your value']]),
        ]);

        $pageTemplateDetail = Attract::pageTemplates()->getPageTemplate(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $pageTemplateDetail->page->id);
    }
}
```

## Related

> [card] [List the page templates](https://docs.fetchski-attract.com/laravel/reference/page-templates/list-page-templates.md)
>
> `Attract::pageTemplates()->listPageTemplates()`

> [card] [GET /page-template/\{\_id}](https://docs.fetchski-attract.com/api-reference/page-templates/get-a-page-template.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.