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

# Get the image folder tree

> Every image folder, nested, with how many files each holds directly: what the Media manager’s folder rail shows.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const folderTree = await site.imageFolders().getImageFolderTree();
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "folderPath": "Example folder path",
      "level": 1,
      "parentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "referenceOnly": true,
      "reference": true,
      "count": 1,
      "children": []
    }
  ]
}
```

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

**1. Add the function**

```ts src/attract/get-image-folder-tree.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function getImageFolderTree(site: SiteClient) {
  return site.imageFolders().getImageFolderTree();
}
```

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/get-image-folder-tree.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { getImageFolderTree } from '../src/attract/get-image-folder-tree.ts';

const site = createSiteClient();
console.log(await getImageFolderTree(site));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/get-image-folder-tree.ts
```

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

For someone who may edit the image library (and the management key); everyone else gets 404.

> [accordion] Parameters
>
> None: call it with no arguments.

> [accordion] Returns
>
> A `FolderTree`. The folder tree: the root folders by title, each with its subfolders. Read its properties (`folderTree.results`): 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`).
>
> **results** `readonly FolderTreeNode[]`
>
> **Always sent.** A list of `FolderTreeNode`.
>
> **FolderTreeNode**
>
> A folder, with its subfolders. Every field is always sent.
>
> **id** `string`
>
> **Always sent.** The folder’s `aposDocId`.
>
> **title** `string`
>
> **Always sent.**
>
> **folderPath** `string`
>
> **Always sent.** Its path, e.g. `events/summer`.
>
> **level** `number`
>
> **Always sent.** Its depth: 0 at the root.
>
> **parentId** `string | null`
>
> **Always sent, can be `null`.** Its parent folder’s `_id`; null at the root.
>
> **linkedAlbumId** `string | null`
>
> **Always sent, can be `null`.** The photo album it belongs to, if it is an album’s folder.
>
> **linkedFeedId** `string | null`
>
> **Always sent, can be `null`.** The photo feed it belongs to, if it is a feed’s folder.
>
> **referenceOnly** `boolean`
>
> **Always sent.** Flagged as a reference folder itself (its files are never offered for use).
>
> **reference** `boolean`
>
> **Always sent.** Inside a reference tree (itself included).
>
> **count** `number`
>
> **Always sent.** Files directly in it (not in its subfolders).
>
> **children** `readonly FolderTreeNode[]`
>
> **Always sent.** A list of `FolderTreeNode`. Its fields are listed under the first `FolderTreeNode` above.

> [accordion] 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](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **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 your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `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:write` (or a master above it: `content:images:all`, `content:all`, `admin:all`). 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.

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

```ts tests/imageFolders-getImageFolderTree.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { getImageFolderTree } from '../src/attract/get-image-folder-tree.ts';

test('imageFolders.getImageFolderTree', async () => {
  const site = fakeSite();
  await getImageFolderTree(site);
  site.assertCalled('imageFolders.getImageFolderTree');
});
```

## Related

> [card] [List a folder’s photos](https://docs.fetchski-attract.com/typescript/reference/image-folders/list-image-folder-photos.md)
>
> `site.imageFolders().listImageFolderPhotos()`

> [card] [List image folders](https://docs.fetchski-attract.com/typescript/reference/image-folders/list-image-folders.md)
>
> `site.imageFolders().listImageFolders()`

> [card] [Create an image folder](https://docs.fetchski-attract.com/typescript/reference/image-folders/create-image-folder.md)
>
> `site.imageFolders().createImageFolder()`

> [card] [Get an image folder](https://docs.fetchski-attract.com/typescript/reference/image-folders/get-image-folder.md)
>
> `site.imageFolders().getImageFolder()`

> [card] [Replace an image folder](https://docs.fetchski-attract.com/typescript/reference/image-folders/replace-image-folder.md)
>
> `site.imageFolders().replaceImageFolder()`

> [card] [Delete an image folder](https://docs.fetchski-attract.com/typescript/reference/image-folders/delete-image-folder.md)
>
> `site.imageFolders().deleteImageFolder()`

> [card] [GET /image-folder/tree](https://docs.fetchski-attract.com/api-reference/image-folders/get-the-image-folder-tree.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.