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

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const listPageTemplates = await site.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**

```ts app/controllers/list_page_templates_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ListPageTemplatesController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.pageTemplates().listPageTemplates()
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const ListPageTemplatesController = () => import('#controllers/list_page_templates_controller')

router.get('/page-template/list', [ListPageTemplatesController])
```

**3. Call it**

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

With `node ace serve` running, it prints its answer as JSON.

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`. 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** `readonly PageTemplate[]`
>
> **Always sent.** A list of `PageTemplate`. Every template the caller may read.
>
> **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** `readonly string[]`
>
> **Always sent.** Its sections, in order (widget types).
>
> **placeholders** `number`
>
> **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:** `undefined` when the site leaves it out. What the page is for.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **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`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (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` (milliseconds) in `config/attract.ts` for longer.

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/page_templates_list_page_templates.spec.ts`, then run your tests:

```ts tests/unit/page_templates_list_page_templates.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListPageTemplatesController from '#controllers/list_page_templates_controller'

test('pageTemplates.listPageTemplates', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ListPageTemplatesController)
  await controller.handle()

  site.assertCalled('pageTemplates.listPageTemplates')
})
```

```bash Terminal theme={"dark"}
node ace test
```

## Related

> [card] [Get a page template](https://docs.fetchski-attract.com/adonisjs/reference/page-templates/get-page-template.md)
>
> `site.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.