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
GET	`/workflow/v1/user/folders/paged`	List your folders, paginated and searchable
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¶

POST /workflow/v1/user/folders
Content-Type: application/json

{ "folderName": "Contracts" }

folderName — required, 1-50 characters, not whitespace-only. PUT /workflow/v1/user/folders/{folderId} with the same body renames it.

Response (UserFolderResponse):

{ "id": 1, "folderName": "Contracts", "documentsCount": 14 }

documentsCount is what feeds the Dashboard's "Your Folders" widget and the folderID filter on Documents.

Listing a lot of folders¶

GET /workflow/v1/user/folders returns every folder in one array. For an account with many of them, the paged variant takes standard Spring pagination parameters plus a search term:

GET /workflow/v1/user/folders/paged?searchValue=contract&page=0&size=20&sort=folderName,asc

searchValue is optional and matches on the folder name. The response is a page object — the folders are in content, alongside totalElements, totalPages and number:

{
  "content": [ { "id": 1, "folderName": "Contracts", "documentsCount": 14 } ],
  "totalElements": 37,
  "totalPages": 2,
  "number": 0,
  "size": 20
}

Moving documents into a folder¶

PUT /workflow/v1/user/folders/12/887

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¶

DELETE /workflow/v1/user/folders/12

Deleting a folder does not delete the documents inside it — they simply become unfiled.