Downloads
| File | What it is |
|---|---|
openapi.json | The OpenAPI 3 document: the exact contract, and what the reference above is generated from. |
foldr-api-v1.postman_collection.json | The Postman collection: a request for every operation, with the sign-in set up once. |
foldr-site.postman_environment.json | The Postman environment: your site’s address, the app’s client ID and the values the requests fill in. |
Foldr-API-v1-developer-guide.pdf | The developer guide as a PDF, for reading offline. |
Your own site also serves the OpenAPI document at /api/v1/openapi.json. The Postman files are explained in Trying it in Postman.
Changelog
Section titled “Changelog”The document has its own version number, separate from the API’s major version.
- restoreVersion takes a new optional body field, as_copy. With it true the chosen version is written beside the file as a new file (for example “Report (3 Nov 2026 14.02).docx”, the first free name) and nothing is replaced: no If-Match is needed, the answer is 201 with the new file, and it is not counted against the allowance or held for approval.
- On an SMB share, restoreVersion over a file that no shadow copy holds (it changed since the newest one) is refused 409 not-recoverable-here, because the overwrite would lose what the file holds now. Restore as a copy instead.
- First release of API v1: read access to shares, files and folders, file contents, search and custom fields, and the signed-in person’s profile.
- Changes, each within what the person’s organisation allows your app: create folders, upload files (streamed through Foldr, or straight to the storage with an upload session), rename and copy files and folders, set custom field values, and ask to share (an approver decides). Creates take an Idempotency-Key; renames and field values need If-Match. A copy too big for one request is answered 202 with an operation to poll.
- Changes that remove or replace, each under a scope of its own that your app is allowed separately: replace a file’s contents, list a file’s versions and restore one, move files and folders within a share or to another share, and delete them. Each needs If-Match; a delete says where the item went. A move to another share copies, proves the copy, then removes the original; one too big for a request is an operation to poll.
- Approval mode: where the organisation requires approval for your app’s changes that remove or replace, a delete, move or version restore is answered 202 with an operation that waits for an approver, and is made as the person once approved (or ends declined, expired or withdrawn, with nothing changed). Replacing a file’s contents is not offered to such an app.