API reference
Every operation of the API, generated from the OpenAPI document (version 1.1.0, 29 operations). Each page gives the address, the OAuth scope, the rate cost, the parameters, the body, every response and an example request. The developer guide explains how it all fits together; the OpenAPI document and the Postman collection are on the downloads page.
Shares
Section titled “Shares”| Operation | Address | Scope |
|---|---|---|
List shares listShares | GET /shares | foldr.read |
Get a share getShare | GET /shares/{share_id} | foldr.read |
Files and folders
Section titled “Files and folders”| Operation | Address | Scope |
|---|---|---|
List a folder listChildren | GET /shares/{share_id}/children | foldr.read |
Copy a file or folder copyItem | POST /shares/{share_id}/copy | files.write |
Upload a file uploadFile | PUT /shares/{share_id}/files | files.write |
Create a folder createFolder | POST /shares/{share_id}/folders | files.write |
Get a file or folder getItem | GET /shares/{share_id}/item | foldr.read |
Rename a file or folder renameItem | POST /shares/{share_id}/rename | files.write |
File contents
Section titled “File contents”| Operation | Address | Scope |
|---|---|---|
Download a file getContent | GET /shares/{share_id}/content | foldr.read |
Get a download URL getDownloadUrl | GET /shares/{share_id}/download-url | foldr.read |
Search
Section titled “Search”| Operation | Address | Scope |
|---|---|---|
Search search | GET /search | foldr.read |
Custom fields
Section titled “Custom fields”| Operation | Address | Scope |
|---|---|---|
List custom fields listFields | GET /fields | foldr.read |
Get field values getFieldValues | GET /shares/{share_id}/field-values | foldr.read |
Set a field value setFieldValue | PUT /shares/{share_id}/field-values/{field_id} | fields.write |
Replacing, restoring, moving and deleting
Section titled “Replacing, restoring, moving and deleting”| Operation | Address | Scope |
|---|---|---|
Replace a file’s contents overwriteFile | PUT /shares/{share_id}/content | files.overwrite |
Delete a file or folder deleteItem | DELETE /shares/{share_id}/items | files.delete |
Move a file or folder moveItem | POST /shares/{share_id}/move | files.move |
List versions listVersions | GET /shares/{share_id}/versions | foldr.read |
Restore a version restoreVersion | POST /shares/{share_id}/versions/restore | files.overwrite |
Upload sessions
Section titled “Upload sessions”| Operation | Address | Scope |
|---|---|---|
Start an upload session createUploadSession | POST /uploads | files.write |
Cancel an upload session cancelUploadSession | POST /uploads/{id}/cancel | files.write |
Complete an upload session completeUploadSession | POST /uploads/{id}/complete | files.write |
Operations
Section titled “Operations”| Operation | Address | Scope |
|---|---|---|
List operations listOperations | GET /operations | files.write files.move files.delete files.overwrite |
Get an operation getOperation | GET /operations/{id} | files.write files.move files.delete files.overwrite |
Cancel an operation cancelOperation | POST /operations/{id}/cancel | files.write files.move files.delete files.overwrite |
Share requests
Section titled “Share requests”| Operation | Address | Scope |
|---|---|---|
List sharing requests listShareRequests | GET /share-requests | sharing |
Get a sharing request getShareRequest | GET /share-requests/{id} | sharing |
Ask to share createShareRequest | POST /shares/{share_id}/share-requests | sharing |
The signed-in person
Section titled “The signed-in person”| Operation | Address | Scope |
|---|---|---|
Get the signed-in person getMe | GET /me | profile |
Schemas
Section titled “Schemas”The objects these operations send and take are on the schemas page.