Changed on

Read a file placed in the navigation: its metadata, where it sits, a snippet that inserts it into document content, and a short-lived download URL.

get/api/v1/files/{fileNodeId}

Request

  • Base URL: https://falconer.com (the document declares no server; this is the origin it was published from)
  • URL: https://falconer.com/api/v1/files/{fileNodeId}
  • Auth: none declared

Path parameters

fileNodeIdstring required

File id: the fileNodeId of a type file nav item or a placed upload.

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Response

File metadata and a short-lived download URL

idstring required

File id, the fileNodeId of its nav item.

filenamestring required
mimeTypestring required
sizeinteger required
updatedAtstring required
urlstring required

The file page in Falconer.

downloadUrlstring required

Short-lived URL for the bytes. Download it promptly; never persist it.

snippetstring required

Markdown snippet that inserts the file into document content.

navItemIdinteger required
parentFolderIdinteger nullable required

The folder the file sits in; null at a section root.

section'company' | 'private' required

Where the document landed. Without a parent it lands in your private section.

Changes