Files

Get file metadata

get/v1/files/{file_key}/meta

Path parameters

file_keystring required

File to get metadata for. This can be a file key or branch key. Use GET /v1/files/:key with the branch_data query param to get the branch key.

Response from the GET /v1/files/{file_key}/meta endpoint.

namestring required

The name of the file.

folder_namestring

The name of the project containing the file.

last_touched_atstring date-time required

The UTC ISO 8601 time at which the file content was last modified.

thumbnail_urlstring

A URL to a thumbnail image of the file.

editorType'figma' | 'figjam' | 'slides' required

The type of editor associated with this file.

role'owner' | 'editor' | 'viewer'

The role of the user making the API request in relation to the file.

link_access'view' | 'edit' | 'org_view' | 'org_edit' | 'inherit'

Access policy for users who have the link to the file.

urlstring

The URL of the file.

versionstring

The version number of the file. This number is incremented when a file is modified and can be used to check if the file has changed between requests.