KOkontainer
DAM: Folders

Returns a list of DAM Folders

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.
get/dam/folders

Request

Query parameters

filterobject

Filtering

Filters can be applied to limit the results that are returned. Filters are applied using the "filter" query parameter. Available filters are:

  • parent_folder_id (eq)
  • source_folder_id (eq)
  • updated_at (eq, lt, lte, gt, gte)
  • description (eq)
  • name (eq)
  • smart_filter_element_id (eq) - only smart folders (not filtered mirror folders) whose filter has a criterion on this custom field. Use it to find the smart folders affected before changing or deleting a field.

Example:

To apply a folder filter where the "parent_folder_id" equals "22" and the folder "updated_at" date is between April 1 - 30th 2010 , you could write the filter query as below:

{
  "filter": {
    "parent_folder_id": {
      "eq": "22"
    },
    "source_folder_id": {
      "eq": "45"
    },
    "updated_at": {
      "gte": "2010-04-01 00:00:00",
      "lt": "2010-04-30 00:00:00"
    }
  }
}

Date filters accept Y-m-d, Y-m-d H:i:s and ISO-8601. An ISO-8601 value carrying a UTC designator or a UTC offset is converted to the application timezone before the filter is applied.

{
  "parent_folder_id": {
    "eq": "22"
  },
  "updated_at": {
    "gte": "2010-04-01 00:00:00",
    "lt": "2010-04-30 00:00:00"
  }
}
pagenumber

Requested page number (defaults to 1)

pageSizenumber

Requested page size (defaults to 100)

relationshipsstring

Requested relationships (parent_folder, source_folder, folder_thumbnail_file, custom_fields)

includesstring

Requested includes (parent_folder, source_folder, custom_fields)

Response

success

Example response

{
  "data": [
    {
      "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"
      }
    }
  ],
  "links": {
    "first": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1",
    "last": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "Previous",
        "active": false
      },
      {
        "url": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next",
        "active": false
      }
    ],
    "path": "https://example.kontainer.com/jsonapi/v2/dam/folders",
    "per_page": 500,
    "to": 1,
    "total": 1,
    "sort": "name"
  }
}

Changes

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