> ## 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 FAQ items > Retrieve a paginated list of FAQ items. ```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 faqItemList = await site.faqItems().listFaqItems() ``` ```json 200 wrap theme={"dark"} { "results": [ { "title": "Example title", "answer": { "metaType": "area", "_id": "clx8m2k4p0000a1b2c3d4e5f6", "items": [ { "type": "@apostrophecms/rich-text", "_id": "clx8m2k4p0000a1b2c3d4e5f6", "metaType": "widget", "content": "

Hello from the API.

", "sectionCss": {} } ] }, "_category": [ {} ], "featured": false, "sortOrder": 0, "slug": "example-slug", "visibility": "public", "scheduledPublish": "Example scheduled publish", "scheduledUnpublish": "Example scheduled unpublish", "faqFontOverrides": [], "source": "manual", "sourceId": "clx8m2k4p0000a1b2c3d4e5f6", "archived": false, "_id": "clx8m2k4p0000a1b2c3d4e5f6", "type": "Example type", "createdAt": "2026-10-24T09:30:00.000Z", "updatedAt": "2026-10-24T09:30:00.000Z", "aposShareKey": "k3v9x2m7q1z8w4p6" } ], "pages": 1, "currentPage": 1 } ``` ## In your app A controller answers a route on your app: it calls `listFaqItems()` and returns the answer. **1. Add the controller** ```ts app/controllers/list_faq_items_controller.ts theme={"dark"} import { inject } from '@adonisjs/core' import { SiteClient } from '@fetchski/attract-cms-sdk' @inject() export default class ListFaqItemsController { constructor(protected site: SiteClient) {} async handle() { return this.site.faqItems().listFaqItems() } } ``` **2. Add the route** ```ts start/routes.ts theme={"dark"} import router from '@adonisjs/core/services/router' const ListFaqItemsController = () => import('#controllers/list_faq_items_controller') router.get('/faq-item', [ListFaqItemsController]) ``` **3. Call it** ```bash Terminal theme={"dark"} curl http://localhost:3333/faq-item ``` With `node ace serve` running, it prints its answer as JSON. > [accordion] Optional parameters > > One object, e.g. `listFaqItems({ page })`; leave out the optional fields. > > **page** `number | null | undefined` > > **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based) > > **perPage** `number | null | undefined` > > **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one. At least 1. > > **search** `string | null | undefined` > > **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones). > > **aposMode** `AposMode | null | undefined` > > **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content::write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`. > > **aposLocale** `string | null | undefined` > > **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale). > > **renderAreas** `boolean | null | undefined` > > **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data. > > **slug** `string | null | undefined` > > **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL. > [accordion] Returns > > A `FaqItemList`. A page of FaqItem documents. Read its properties (`faqItemList.results`): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (`_id` → `id`, `_category` → `category`). > > **results** `readonly FaqItem[]` > > **Always sent.** A list of `FaqItem`. This page’s documents; empty past the last page. > > **FaqItem** > > FaqItem content type > > **title** `string` > > **Always sent.** The question exactly as a visitor would ask it — it renders as the accordion row and in the page’s FAQ structured data. > > **answer** `RichTextMax1Area` > > **Always sent.** A `RichTextMax1Area`. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. > > **RichTextMax1Area** > > The fuller explanation shown under this entry on the Cookie Policy page. Plain language, no legalese — what is collected, why, and what declining costs the visitor. Widgets, top to bottom: send `{ "items": [ … ] }`, one object per widget with its `type`. Writing it replaces the whole area. > > **metaType** `AfterContentAreaMetaType` > > **Sometimes sent:** `undefined` when the site leaves it out. Always `area`. One of `area`; a newer site may send others, so keep a fallback. > > **id** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. The area’s id, set by the site: leave it out when you write one. > > **items** `readonly RichTextWidget[]` > > **Sometimes sent:** `undefined` when the site leaves it out. A list of `RichTextWidget`. The widgets, top to bottom. Each is an object with its `type` and that widget’s own fields; `_id` and `metaType` may be left out (the site sets them). At most 1 items. > > **RichTextWidget** > > A `@apostrophecms/rich-text` widget: its `type` and its own fields. A field left out takes its default. > > **type** `RichTextWidgetType` > > **Always sent.** The widget’s type: always `@apostrophecms/rich-text`. One of `@apostrophecms/rich-text`; a newer site may send others, so keep a fallback. > > **id** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. The widget’s id, unique on the page. Leave it out for a new widget (the site sets one); keep it to change a widget that is there. > > **metaType** `MetaType` > > **Sometimes sent:** `undefined` when the site leaves it out. Always `widget`. One of `widget`; a newer site may send others, so keep a fallback. > > **content** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. The text as HTML, e.g. `

Our story

It began with one idea.

`. The site keeps the tags and styles this area’s editor offers (paragraphs, headings, bold, italic, links, lists…) and removes the rest. > > **sectionCss** `CustomCSS | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A `CustomCSS`. CSS for this one section, typed into the slot of the part it styles. It wins over Site design → Custom CSS. Nested rules like &:hover, @media (width >= 48rem) and \[data-theme="light"] & work inside a slot. > > **CustomCSS** > > **slots** `Readonly\\>` > > **Sometimes sent:** `undefined` when the site leaves it out. The CSS typed into each part slot, by slot name. > > **css** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. The compiled CSS (read only: rebuilt from `slots`). > > **mark** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. The site’s check mark for `css` (read only). > > **fields** `Readonly\\>` > > **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. > > **fields** `Readonly\\>` > > **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. > > **slug** `string` > > **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). > > **id** `string` > > **Always sent.** The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take. > > **type** `string` > > **Always sent.** The document type’s name: always this type’s. > > **category** `readonly Readonly\\>[] | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. FAQ sections can group questions under category subheadings and filter to specific categories. Manage the list under FAQ Categories. The related `faq-category` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items. > > **featured** `boolean | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hand-curation flag: FAQ sections can show only featured questions — e.g. a short top-questions block on the home page. > > **sortOrder** `number | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Questions are listed lowest number first — the explicit FAQ order. > > **visibility** `Visibility | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback. > > **scheduledPublish** `string | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`. > > **scheduledUnpublish** `string | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`. > > **faqFontOverrides** `readonly FaqItemFaqFontOverridesItem[] | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A list of `FaqItemFaqFontOverridesItem`. Optional. Set part of this question’s card in a different typeface. Leave empty to follow the section (and the site fonts). At most 4 items. > > **FaqItemFaqFontOverridesItem** > > **id** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array. > > **target** `Target | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback. > > **source** `Source | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback. > > **slot** `Slot | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback. > > **curated** `Curated | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback. > > **cdnProvider** `CdnProvider | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback. > > **cdnFamily** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored. > > **cdnWeights** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear. > > **uploads** `readonly FaqItemFaqFontOverridesItemUploadsItem[]` > > **Sometimes sent:** `undefined` when the site leaves it out. A list of `FaqItemFaqFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items. > > **FaqItemFaqFontOverridesItemUploadsItem** > > **file** `Readonly\\>` > > **Always sent.** File attachment reference. > > **id** `string` > > **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array. > > **weight** `Weight | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback. > > **style** `Style | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback. > > **fields** `Readonly\\>` > > **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. > > **fallback** `Fallback | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback. > > **fields** `Readonly\\>` > > **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. > > **source** `FaqCategorySource | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set automatically. Demo placeholders are removed the moment a real question is published. One of `manual`, `demo`; a newer site may send others, so keep a fallback. > > **sourceId** `string | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Internal de-duplication key set by the demo seed. > > **archived** `boolean | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document. > > **createdAt** `Date | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it was created (ISO 8601). Format: an ISO 8601 date and time. > > **updatedAt** `Date | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it last changed (ISO 8601). Format: an ISO 8601 date and time. > > **aposShareKey** `string | null` > > **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents. > > **pages** `number` > > **Always sent.** Pages in the whole list (0 when it is empty). > > **currentPage** `number` > > **Always sent.** This page, from 1. > [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. > > **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` > > `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:faq-items:read` (or a master above it: `content:faq-items:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`) need `content:faq-items:write` (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields. * **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. * **Paging:** one page per call. To walk them all, use `listFaqItemsAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`. ## More examples `listFaqItemsAll()` takes `listFaqItems()`’s arguments except `page`. `listFaqItemsPick()` takes the same arguments except `page`, after the fields to answer: each row is the document’s `id` and those fields. ```ts Every page wrap theme={"dark"} import app from '@adonisjs/core/services/app' import { SiteClient } from '@fetchski/attract-cms-sdk' const site = await app.container.make(SiteClient) for await (const faqItem of site.faqItems().listFaqItemsAll()) { console.log(faqItem) // the next page is fetched as you iterate } ``` ```ts Only some fields 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 rows = await site.faqItems().listFaqItemsPick(['title', 'slug']) // [{ id, title, slug }, …]: every FAQ item, across every page ``` ## 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/faq_items_list_faq_items.spec.ts`, then run your tests: ```ts tests/unit/faq_items_list_faq_items.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 ListFaqItemsController from '#controllers/list_faq_items_controller' test('faqItems.listFaqItems', async () => { const site = fakeAttract() const controller = await app.container.make(ListFaqItemsController) await controller.handle() site.assertCalled('faqItems.listFaqItems') }) ``` ```bash Terminal theme={"dark"} node ace test ``` **Answer with your own values:** fake `faqItems.listFaqItems` with a `sequence()` of pages, each `factories.FaqItemList({...})`, and walk `listFaqItemsAll()`. ```ts tests/unit/faq_items_list_faq_items_answers.spec.ts theme={"dark"} import { test } from '@japa/runner' import { factories, fakeAttract, sequence } from '@fetchski/attract-cms-adonis/testing' test('faqItems.listFaqItems answers your values', async ({ assert }) => { const site = fakeAttract({ 'faqItems.listFaqItems': sequence( factories.FaqItemList({ currentPage: 1, pages: 2 }), factories.FaqItemList({ currentPage: 2, pages: 2 }) ), }) const walked: unknown[] = [] for await (const faqItem of site.faqItems().listFaqItemsAll()) { walked.push(faqItem) } assert.lengthOf(walked, 2) }) ``` To fake `listFaqItemsAll()`, answer `faqItems.listFaqItems` (the walk calls it page by page): a `sequence()` of answers for several pages. ## Related > [card] [List an FAQ item’s locales](https://docs.fetchski-attract.com/adonisjs/reference/faq-items/get-faq-item-locales.md) > > `site.faqItems().getFaqItemLocales()` > [card] [Create an FAQ item](https://docs.fetchski-attract.com/adonisjs/reference/faq-items/create-faq-item.md) > > `site.faqItems().createFaqItem()` > [card] [Get an FAQ item](https://docs.fetchski-attract.com/adonisjs/reference/faq-items/get-faq-item.md) > > `site.faqItems().getFaqItem()` > [card] [Replace an FAQ item](https://docs.fetchski-attract.com/adonisjs/reference/faq-items/replace-faq-item.md) > > `site.faqItems().replaceFaqItem()` > [card] [Delete an FAQ item](https://docs.fetchski-attract.com/adonisjs/reference/faq-items/delete-faq-item.md) > > `site.faqItems().deleteFaqItem()` > [card] [Update an FAQ item](https://docs.fetchski-attract.com/adonisjs/reference/faq-items/update-faq-item.md) > > `site.faqItems().updateFaqItem()` > [card] [GET /faq-item](https://docs.fetchski-attract.com/api-reference/faq-items/list-faq-items.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.