Skip to content
Log in Request a demo

v1.2.3

A new /api/v1/documents endpoint group for working with the document storage - both organization documents and documents of a specific employee. See Documents.

  • GET /api/v1/documents/folders/{folder_type} - all folders of the type organization or employee with a document_count for each.
  • GET /api/v1/documents/employees/{employee_id}/folders - employee type folders of a specific employee.
  • POST /api/v1/documents/search - paginated document search. Exactly one of folder_id or folder_type must be set; employee_id and title are optional filters.
  • POST /api/v1/documents/upload - multipart/form-data upload that stores the file and creates the document in one request. The title comes from the file name without the extension.
  • GET /api/v1/documents/{document_id} - document metadata.
  • GET /api/v1/documents/{document_id}/download - the original file, with the name in Content-Disposition.
  • PUT /api/v1/documents/{document_id} - rename the document.
  • DELETE /api/v1/documents/{document_id} - delete the document.

Access is checked per folder: for type=organization via settings_document_folders=edit or the folder view/edit rules, for type=employee via employee_folder_permissions.


Documents expose employee_id - the employee the document belongs to, or null for an organization document.