KOkontainer
DAM: Files

Returns a single DAM file

Retrieve DAM File

Endpoint for retrieving a file. The file has to be completed and may not be trashed, and the token user must have access to the file's original folder or a least one collection containing the file.

get/dam/files/{file_id}

Request

Path parameters

file_idstring required

ID of File

Query parameters

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)

Response

success

type'file' required
idstring required

Example response

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