KOkontainer
DAM: Folders: Files

Returns a list of DAM Files within a folder

Retrieve DAM Files

Endpoint for retrieving a collection of Files within a folder. Note that root folder and trash folder can not be listed.

get/dam/folders/{folder_id}/files

Request

Path parameters

folder_idstring required

ID of Folder

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:

  • updated_at (eq, lt, lte, gt, gte)

Example:

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

{
    "filter": {
        "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.

{
  "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 (folder, albums, mirror_folders, smart_folders, tags, cdn, custom_fields, created_by, video_cdn, focal_point, faces, file_provenance)

includesstring

Requested includes (folder, albums, mirror_folders, smart_folders, tags, cdn, custom_fields, created_by, video_cdn, focal_point, faces, file_provenance)

meta[]string[]

An array of meta values. Can select multiple values

Response

success

Example response

{
  "data": [
    {
      "type": "file",
      "id": "1234",
      "attributes": {
        "name": "Callaway.png",
        "description": "Golf image",
        "size": 5566,
        "sort": 2,
        "created_at": "2023-10-15T06:29:29.000000Z",
        "updated_at": "2023-10-15T06:29:29.000000Z",
        "extension": "png",
        "width": 16,
        "height": 16,
        "orientation": 1,
        "version": 1,
        "consent_status": "no_consent",
        "consent_rights": [],
        "consent_party_ids": []
      }
    }
  ]
}

Changes

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