Folders¶
Personal folders for organizing your own documents (separate from Template folders, which organize templates instead).
Endpoint summary¶
| Method | Path | Summary |
|---|---|---|
| GET | /workflow/v1/user/folders |
List your folders |
| POST | /workflow/v1/user/folders |
Create a folder |
| PUT | /workflow/v1/user/folders/{folderId} |
Rename a folder |
| PUT | /workflow/v1/user/folders/{folderId}/{workflowID} |
Move one workflow into a folder |
| PUT | /workflow/v1/user/folders/{folderId}/workflows |
Move multiple workflows into a folder |
| DELETE | /workflow/v1/user/folders/{folderId} |
Delete a folder |
Creating and renaming¶
folderName — required, 1-50 characters, not whitespace-only. PUT /workflow/v1/user/folders/{folderId} with the same body renames it.
Response (UserFolderResponse):
documentsCount is what feeds the Dashboard's "Your Folders" widget and the folderID filter on Documents.
Moving documents into a folder¶
Path form moves a single workflow (workflowID may also be a comma-separated list). For a JSON body instead:
PUT /workflow/v1/user/folders/12/workflows
Content-Type: application/json
{ "workflowIds": "887,890,891" }
Deleting¶
Deleting a folder does not delete the documents inside it — they simply become unfiled.