KOkontainer
DAM: Folders

Returns a single DAM folder

Retrieve DAM Folder

Endpoint for retrieving a folder. The folder may not be trashed or soft deleted and the token user must have access to the folder.

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. A mirror folder returns null; its values belong to the folder it mirrors and are reachable through include=source_folder. A category no longer flagged for folder custom fields still returns the values already stored against it.

get/dam/folders/{folder_id}

Request

Path parameters

folder_idstring required

ID of Folder

Query parameters

relationshipsstring

Requested relationships (parent_folder, source_folder, folder_thumbnail_file, custom_fields)

includesstring

Requested includes (parent_folder, source_folder, custom_fields)

Response

success

type'folder' required
idstring required

Example response

{
  "type": "folder",
  "id": "1234",
  "attributes": {
    "name": "Folder name",
    "description": "Folder description",
    "created_at": "2099-12-31T23:59:59.000000Z",
    "updated_at": "2099-12-31T23:59:59.000000Z",
    "sort": 1,
    "files_count": 7,
    "files_size": 10000,
    "path": ".1233.1234",
    "show_large_folder_name": true,
    "thumbs_scale_to_fit": true
  },
  "links": {
    "self": "https://example.kontainer.com/jsonapi/v2/dam/folders/1234"
  },
  "meta": {
    "folder_type": "folder"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.