Get metadata for a file or folder

Last update: November 7, 2023

CREATED FOR:

  • Developer

Returns metadata for the specified file or folder.

URL

GET /metadata?id=[document or folder ID]

Query Parameters

NameDescription
id

The ID of file or folder, as referenced by the webhook provider. This is different than Adobe Workfront's document ID. To get the metadata of the root directory, use the value '/'.

Note: The maximum length for the ID is 255 characters.

Response

NameTypeDescription
titleStringThe name of the document or folder
kindStringSpecifies if this item is a file or folder ('file' or 'folder')
idStringThe id of the file or folder.
viewLinkStringThe URL path used by a user to view the document in a browser window. The URL can be hosted by either the document provider or the native external storage provider.
downloadLinkStringThe URL path used by a user to download the document in a browser window. The URL can be hosted by either the document provider or the native external storage provider.
mimeTypeStringThe MIME type for the file. (optional)
dateModifiedStringLast time this file was modified (formatted RFC 3339 timestamp)
sizeLongThe size of the file in bytes. (optional)
readOnlyBooleanIndicates if this file or folder is read-only to the authenticated user.(optional)

Example: https://www.acme.com/api/metadata?id=12345

{
title:"My Document",
kind:"file"
id":"12345",
viewLink:"https://www.acme.com/viewDocument?id=12345",
downloadLink:"https://www.acme.com/downloadDocument?id=12345",
mimeType:"image/png",
dateModified:"2014­06­05T17:39:45.251Z",
size: "32554694"
}
NOTE
Error handling should be consistent across all API calls. See the “Error Handling” section below for details.
Previous pageGet OAuth2 Tokens
Next pageGet item list of folder contents

Workfront