API reference / folders
folders
GET /v1/folders
List Folders
Responses
- 200
array of FolderOut - 4xx 5xx
application/problem+json; see the error reference.
POST /v1/folders
Create Folder
Request body (application/json, required)
| Member | Type | Notes |
|---|---|---|
name required | string (min length 1, max length 120) | |
parent_id | string (uuid) | null |
Responses
- 201 FolderOut
- 4xx 5xx
application/problem+json; see the error reference.
PATCH /v1/folders/{folder_id}
Patch Folder
Path
folder_idstring (uuid)
Request body (application/json, required)
| Member | Type | Notes |
|---|---|---|
move_to_root | boolean | Default false. |
name | string (min length 1, max length 120) | null | |
parent_id | string (uuid) | null |
Responses
- 200 FolderOut
- 4xx 5xx
application/problem+json; see the error reference.
DELETE /v1/folders/{folder_id}
Delete Folder
Path
folder_idstring (uuid)
Responses
- 204 no body
- 4xx 5xx
application/problem+json; see the error reference.