Documents & storage – build on Flowtly

Use this curated snapshot of the Flowtly OpenAPI schema to plan integrations, automate workflows, and sync the data your teams rely on.

Documentation status

Last synced on 2026-04-03 18:31 (app version 2.0.0)

Only a subset of entities is made public. Run both sync commands to refresh this documentation when the Flowtly app ships new capabilities.

Documents & storage

File management, document types, and storage resources.

Entity overview

Document

Upload, categorize, and retrieve documents linked to employees, clients, or projects.

Endpoints

GET https://api.flowtly.eu/documents

List documents

Retrieves the collection of DocumentType resources.

POST https://api.flowtly.eu/documents

Create document

Creates a DocumentType resource.

GET https://api.flowtly.eu/documents/action-needed

List action needed

Retrieves the collection of Document resources.

GET https://api.flowtly.eu/documents/{id}

Get document by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/documents/{id}

Delete document

Remove the resource.

PATCH https://api.flowtly.eu/documents/{id}

Update document

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/document-types

List documents

Retrieves the collection of DocumentType resources.

POST https://api.flowtly.eu/document-types

Create document

Creates a DocumentType resource.

GET https://api.flowtly.eu/document-types/{id}

Get document by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/document-types/{id}

Update document

Update resource fields using JSON Merge Patch.

Use cases

Attach signed contracts from your e-signature tool to Flowtly agreements.
Categorize uploaded documents with custom types for compliance reporting.

Schema fields

Document-document.read_storage.read
Field Type Description
id integer id field.
documentType string documentType field.
relationId integer relationId field.
expiringAt string | null expiringAt field.
storage object storage field.
notes string | null notes field.

Entity overview

Storage

Upload and download binary files (images, PDFs, spreadsheets) attached to Flowtly records.

Endpoints

GET https://api.flowtly.eu/storage/mt940

List mt940

Retrieves the collection of Storage resources.

POST https://api.flowtly.eu/storage/upload

Create upload

Creates a Storage resource.

GET https://api.flowtly.eu/storage/{id}

Get storage by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/storage/{id}

Delete storage

Remove the resource.

GET https://api.flowtly.eu/storage/{id}/preview

Get storage by ID

Retrieve a single resource by its identifier.

Use cases

Upload invoice PDFs from your scanning pipeline.
Retrieve employee avatar images for directory integrations.

Schema fields

Storage-document.read_storage.read
Field Type Description
id string id field.
relationName string relationName field.
relationId string relationId field.
size integer size field.
mimeType string mimeType field.
Whatsapp