Get an FAQ item

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const faqItem = await site.faqItems().getFaqItem({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "answer": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_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"
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const faqItem = await site.faqItems().getFaqItem({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "answer": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_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"
}

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/get-faq-item.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function getFaqItem(site: SiteClient, id: string) {
  return site.faqItems().getFaqItem({ id });
}

Call it

A script makes the client once and calls the function:

scripts/get-faq-item.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { getFaqItem } from '../src/attract/get-faq-item.ts';

const site = createSiteClient();
console.log(await getFaqItem(site, 'clx8m2k4p0000a1b2c3d4e5f6'));

Terminal

node --env-file=.env scripts/get-faq-item.ts

A route handler, a job or a queue worker calls it the same way.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.

TypeScript

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const row = (await site.faqItems().listFaqItemsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started'); // { id, title, slug }, or undefined

Pass row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).

Required parameters

One object, e.g. getFaqItem({ id }); leave out the optional fields.

string

required

Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Optional parameters

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:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403. One of draft, published.

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

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.

Returns

A FaqItem. FaqItem content type. Read its properties (faqItem.title): 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).

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.

RichTextMax1Area

Always sent. A RichTextMax1Area. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

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

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.

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.

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.

Show RichTextWidget

A @apostrophecms/rich-text widget: its type and its own fields. A field left out takes its default.

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.

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

Sometimes sent: undefined when the site leaves it out. Always widget. One of widget; a newer site may send others, so keep a fallback.

string

Sometimes sent: undefined when the site leaves it out. The text as HTML, e.g. <h2>Our story</h2><p>It began with <strong>one</strong> idea.</p>. The site keeps the tags and styles this area’s editor offers (paragraphs, headings, bold, italic, links, lists…) and removes the rest.

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.

Show CustomCSS

Readonly<Record<string, string>>

Sometimes sent: undefined when the site leaves it out. The CSS typed into each part slot, by slot name.

string

Sometimes sent: undefined when the site leaves it out. The compiled CSS (read only: rebuilt from slots).

string

Sometimes sent: undefined when the site leaves it out. The site’s check mark for css (read only).

Readonly<Record<string, unknown>>

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.

Readonly<Record<string, unknown>>

string

Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

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.

string

Always sent. The document type’s name: always this type’s.

readonly Readonly<Record<string, unknown>>[] | 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.

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.

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

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.

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.

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.

Show FaqItemFaqFontOverridesItem

string

Sometimes sent: undefined when the site leaves it out. The row’s id, unique in its array.

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

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.

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.

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.

Show FaqItemFaqFontOverridesItemUploadsItem

Readonly<Record<string, unknown>>

Always sent. File attachment reference.

string

Sometimes sent: undefined when the site leaves it out. The row’s id, unique in its array.

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

Readonly<Record<string, unknown>>

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.

Readonly<Record<string, unknown>>

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.

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.

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.

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.

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.

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.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).

400

The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.

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.

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.

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.

500

The site failed. Its logs say why.Retried first: No (only a 502, 503 or 504 is retried). 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

sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

setup

The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.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, or a draft _id) 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) on the client for longer.

More examples

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const faqItem = await site.faqItems().findFaqItem({ id: 'clx8m2k4p0000a1b2c3d4e5f6' }); // FaqItem | null: null when the site answers 404

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.

tests/faqItems-getFaqItem.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { getFaqItem } from '../src/attract/get-faq-item.ts';

test('faqItems.getFaqItem', async () => {
  const site = fakeSite();
  await getFaqItem(site, 'clx8m2k4p0000a1b2c3d4e5f6');
  site.assertCalled('faqItems.getFaqItem', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6');
});

Answer with your own values: fake faqItems.getFaqItem with factories.FaqItem({...}), the fields you give over a valid example.

tests/faqItems-getFaqItem-answer.test.ts

import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('faqItems.getFaqItem answers your values', async () => {
  const site = fakeSite({
    'faqItems.getFaqItem': factories.FaqItem({ title: 'Your value' })
  });
  const faqItem = await site.faqItems().getFaqItem({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
  assert.equal(faqItem.title, 'Your value');
});

List an FAQ item’s locales

site.faqItems().getFaqItemLocales()

List FAQ items

site.faqItems().listFaqItems()

Create an FAQ item

site.faqItems().createFaqItem()

Replace an FAQ item

site.faqItems().replaceFaqItem()

Delete an FAQ item

site.faqItems().deleteFaqItem()

Update an FAQ item

site.faqItems().updateFaqItem()

GET /faq-item/{_id}

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

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const faqItem = await site.faqItems().getFaqItem({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "answer": {
    "metaType": "area",
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "items": [
      {
        "type": "@apostrophecms/rich-text",
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "metaType": "widget",
        "content": "<p>Hello from the API.</p>",
        "sectionCss": {
          "slots": {
            "key": "Example value"
          },
          "css": "Example css",
          "mark": "Example mark"
        }
      }
    ]
  },
  "_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"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Find the id

Behavior

More examples

Test it

List an FAQ item’s locales

List FAQ items

Create an FAQ item

Replace an FAQ item

Delete an FAQ item

Update an FAQ item

GET /faq-item/{_id}

In your app

Find the id

Behavior

More examples

Test it

Related

List an FAQ item’s locales

List FAQ items

Create an FAQ item

Replace an FAQ item

Delete an FAQ item

Update an FAQ item

GET /faq-item/{_id}