List the page templates

use Fetchski\AttractCmsLaravel\Facades\Attract;

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

{
  "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"
    }
  ]
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

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

{
  "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.

Add the controller

app/Http/Controllers/ListPageTemplatesController.php

<?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();
    }
}

Add the route

routes/web.php

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.

Call it

Terminal

curl http://localhost:8000/page-template/list

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

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):

Terminal

php artisan make:attract-action pageTemplates.listPageTemplates

Call it from the terminal

Terminal

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

Parameters

None: call it with no arguments.

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

Collection<int, PageTemplate>

Always sent. A list of PageTemplate. Every template the caller may read.

Show PageTemplate (Fetchski\AttractCmsLaravel\Data\PageTemplate)

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.

string

Always sent. Its name.

string

Always sent. The gallery group, e.g. “Story”, “Legal”.

Always sent. Its sections, in order (widget types).

int

Always sent. How many different [Bracketed placeholders] its text carries (fill them with POST /business-placeholders/fill).

string

Always sent. A wireframe preview (SVG).

?string

Sometimes sent: null when the site leaves it out. What the page is for.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

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().

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().

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().

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().

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().

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().

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

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().

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.

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:

tests/Feature/ListPageTemplatesTest.php

<?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');
    }
}

Terminal

php artisan test

Get a page template

Attract::pageTemplates()->getPageTemplate()

GET /page-template/list

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

use Fetchski\AttractCmsLaravel\Facades\Attract;

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

{
  "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"
    }
  ]
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Behavior

Test it

Get a page template

GET /page-template/list

In your app

Call it from the terminal

Behavior

Test it

Related

Get a page template

GET /page-template/list