Share File or Folder

POST

/api/v2/files/shares/{itemType}/{id}

Last modified:2026-09-02 03:28:41

x-firm-only:true

Generates a sharing key for a file or folder, making it accessible via a public link.
If the item already has a sharing key, the existing key is retained and the expiration is updated.

itemType must be file or folder.

accessType applies to files only — folders have no access type of their own, so supplying
it on a folder is rejected rather than silently ignored.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params

application/json

Required

Example

{
    "keyExpiration": null,
    "accessType": null
}

Responses

🟢200

Success: Returns the item ID, sharing key, expiration, and — for files — the access type.

This response does not have a body.

🟠400

🟠401

🟠404

Modified at 2026-09-02 03:28:41

Upload File to Folder

Unshare File or Folder