Get an image folder

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

const site = createSiteClient();
const imageFolder = await site.imageFolders().getImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedDocId": "clx8m2k4p0000a1b2c3d4e5f6",
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

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

const site = createSiteClient();
const imageFolder = await site.imageFolders().getImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedDocId": "clx8m2k4p0000a1b2c3d4e5f6",
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

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-image-folder.ts

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

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

Call it

A script makes the client once and calls the function:

scripts/get-image-folder.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { getImageFolder } from '../src/attract/get-image-folder.ts';

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

Terminal

node --env-file=.env scripts/get-image-folder.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.imageFolders().listImageFoldersPick(['title', 'slug'])).find((each) => each.slug === 'getting-started'); // { id, title, slug }, or undefined

Pass row.id as id. See Find an id.

Required parameters

One object, e.g. getImageFolder({ 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

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

An ImageFolder. ImageFolder content type. Read its properties (imageFolder.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, _parent → parent).

string

Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.

string

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

Visibility

Always sent. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.

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.

Date

Always sent. When it was created (ISO 8601). Format: an ISO 8601 date and time.

Date

Always sent. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

readonly Readonly<Record<string, unknown>>[] | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The related image-folder 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. Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.

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.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Its place in the tree: each folder’s URL name from the top, joined by / (albums/summer). Set by the site from _parent and title; a value sent is ignored.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The parent folder’s id, empty at the top. Set by the site from _parent; a value sent is ignored.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Its own part of folderPath, made from its title. Set by the site; a value sent is ignored.

number | null

Sometimes sent: undefined when the site leaves it out, and it can be null. How deep it sits: 0 at the top. Set by the site from _parent; a value sent is ignored.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. On a folder the site made for a Photo Album, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. On a folder the site made for a Photo Feed, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. On a folder the site made for a page’s or post’s feed photos, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

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:images:read (or a master above it: content:images:all, content:all, admin:all) reads the published documents. A signed-in person may call it as far as their own permissions allow; anyone else gets 404.
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 imageFolder = await site.imageFolders().findImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6' }); // ImageFolder | 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/imageFolders-getImageFolder.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { getImageFolder } from '../src/attract/get-image-folder.ts';

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

Answer with your own values: fake imageFolders.getImageFolder with factories.ImageFolder({...}), the fields you give over a valid example.

tests/imageFolders-getImageFolder-answer.test.ts

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

test('imageFolders.getImageFolder answers your values', async () => {
  const site = fakeSite({
    'imageFolders.getImageFolder': factories.ImageFolder({ title: 'Your value' })
  });
  const imageFolder = await site.imageFolders().getImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
  assert.equal(imageFolder.title, 'Your value');
});

Get the image folder tree

site.imageFolders().getImageFolderTree()

List a folder’s photos

site.imageFolders().listImageFolderPhotos()

List image folders

site.imageFolders().listImageFolders()

Create an image folder

site.imageFolders().createImageFolder()

Replace an image folder

site.imageFolders().replaceImageFolder()

Delete an image folder

site.imageFolders().deleteImageFolder()

GET /image-folder/{_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 imageFolder = await site.imageFolders().getImageFolder({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "title": "Example title",
  "_parent": [
    {}
  ],
  "referenceOnly": false,
  "slug": "example-slug",
  "visibility": "public",
  "archived": false,
  "folderPath": "Example folder path",
  "folderParentId": "clx8m2k4p0000a1b2c3d4e5f6",
  "slugSegment": "Example slug segment",
  "level": 0,
  "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
  "linkedDocId": "clx8m2k4p0000a1b2c3d4e5f6",
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

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

Get the image folder tree

List a folder’s photos

List image folders

Create an image folder

Replace an image folder

Delete an image folder

GET /image-folder/{_id}

In your app

Find the id

Behavior

More examples

Test it

Related

Get the image folder tree

List a folder’s photos

List image folders

Create an image folder

Replace an image folder

Delete an image folder

GET /image-folder/{_id}