Home > Application Reference > Box > Read File Info

Retrieve information about a file to use in other cards. Note that this only works when the file was uploaded with a file extention. Information cannot be returned for files without extensions.

Unless otherwise indicated, field types are text.

Input

  • File
    • File ID: unique identifier of the file

Output

  • File
    • File Name: name of the file
    • File Extension: type of file, without . (for example, png or jpg)
    • File Description (text): description of the file
    • Version ID: version ID of the file (tracked for Box users with premium accounts only)
    • Version Tag: version tag of the file (tracked for Box users with premium accounts only)
    • Sequence ID: unique identifier for use with events endpoint
    • Size: size of the file in bytes (use caution when parsing this integer to prevent EE notation: IEEE754 format)
    • Path: path that designates the key, in the format of a JSON-Pointer (see Note)
    • Time Created: timestamp when the file was created
    • Time Modified: timestamp when the file was modified
    • Time Trashed: timestamp when the file was trashed
    • Time Purged: timestamp when the file was purged
    • Time Created: timestamp when the file was created in Box
    • Time Content Created: timestamp when the file content was created
    • Parent Folder Name: name of the file’s parent folder
    • Parent Folder ID: unique identifier of the file’s parent folder
    • Item Status: status of the item (active, trashed, or deleted)
    • Tags (list of text): list of the tags on this folder
  • Share Link
    • Share URL: URL to view the file
    • Download URL: URL to download the file
    • Vanity URL: customizable URL (for example, “go.site.com/winterpromo”)
    • Password Enabled: indicator of password
    • Time Unshared: timestamp when the link was unshared
    • Download Count: number of times the link was downloaded
    • Access Level: accessibility of the share link (for example, Edit or View)
    • Can Download: indicator of downloadable content
    • Can Preview: indicator of viewable content
    • Allowed Link Access Level: amount of access available for the link
  • Created By
    • Name: name of the user who created the file
    • User ID: unique identifier of the user
    • Email: email address of the user
  • Modified by
    • Name: name of the user who modified the file
    • User ID: unique identifier of the user
    • Email: email address of the user
  • Owned By
    • Name: name of the user who owns the file
    • User ID: unique identifier of the owner
    • Email: email address of the owner

Note: Because all keys are located at the root of the metadata instance, the key must be prefixed with a /. Special characters ~ and / in the key must be escaped according to the JSON-Pointer specification. The value at the path must exist for the operation to be successful.