Skip to main content
GET
Get a File's metadata

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

File id

Response

OK

additionalFields
object
channelId
string

ChannelID is the file channel the item belongs to.

Example:

"a8f2c1d4-1234-4abc-9def-0123456789ab"

clientPermissions
enum<string>

ClientPermissions controls client read/write access for folders.

Available options:
read_write,
read_only
Example:

"read_write"

createdAt
string
creatorId
string

CreatorId is the id of the user who created the file.

Example:

"f4a1b2c3-1234-4abc-9def-0123456789ab"

data
string
downloadUrl
string<uri>

DownloadURL is a presigned URL for downloading the file's contents.

fields
object

Fields holds the item's name, path, link target, size, and status.

id
string
identityId
string
lastModifiedBy
object

LastModifiedBy identifies the user who last modified the file.

object
string
previousAttributes
object
ref
string
updatedAt
string<date-time>

UpdatedDate is when the file was last updated.

uploadUrl
string<uri>

UploadURL is a presigned URL for uploading the file's binary data, set on creation of an unuploaded file.