---
title: "Returns a list of DAM Folders"
method: GET
path: "/dam/folders"
tags: ["DAM: Folders"]
---

# Returns a list of DAM Folders

`GET /dam/folders`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/dam/folders`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/dam/folders/get.ts> (a function with typed inputs; its response is checked against the schema)

## Retrieve DAM Folders
Endpoint for retrieving a collection of Folders. Note that root folder and trash folder will be excluded.

A folder holds custom fields in one category, so `custom_fields` is a to-one relationship - its
`data` is a single resource identifier, or `null`. Two more things to know:

- A mirror folder returns `null`. It carries the values of the folder it mirrors, which are
  reachable through `include=source_folder`.
- A category that is no longer flagged for folder custom fields still returns the values already
  stored against it. Un-flagging the category stops new writes and hides the fields in the app, but
  does not remove them from this endpoint.

## Query parameters

- `filter` object
- `page` number
- `pageSize` number
- `relationships` string
- `includes` string

## Response `200`

success

- Folders
  - `data` Folder[]
    - `type` 'folder', required
    - `id` string, required
    - `attributes` FolderAttributes, required
      - `name` string
      - `description` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `sort` integer
      - `child_count` integer
      - `files_count` integer
      - `files_size` integer
      - `path` string
      - `show_large_folder_name` boolean
      - `hide_folder_name` boolean
      - `thumbs_scale_to_fit` boolean
      - `apply_folder_image_hue` boolean
      - `is_archived` boolean
      - `is_synced_mirror` boolean, nullable: Only present on mirror folders
      - `mirror_design` boolean: Only present on mirror folders
    - `relationships` FolderRelationships
      - `folder_thumbnail_file` object, nullable
        - `data` ResourceIdentifierObject
          - `type` string
          - `id` string
    - `links` FolderLinks
      - `self` string, uri
    - `meta` FolderMeta
      - `folder_type` 'folder' | 'album' | 'smart_folder' | 'mirror_folder' | 'archive_folder'
      - `is_locked` boolean
  - `links` Links
    - `first` string
    - `last` string
    - `prev` string, nullable
    - `next` string, nullable
  - `meta` Meta
    - `current_page` integer
    - `from` integer
    - `last_page` integer
    - `links` Link[]
      - `url` string, nullable
      - `label` string
      - `active` boolean
    - `path` string
    - `per_page` integer
    - `to` integer
    - `total` integer
    - `filter` union: The `filter` query parameter echoed back as sent; an empty array when none was sent
      - object
      - unknown[]
        - unknown
    - `sort` string

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/kontainer/apis/kontainer-api-documentation.md) - [All operations](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/revisions/b80a5167e09a?raw)