API reference
The Flowtly REST API — 927 endpoints across 192 resources, generated from the live OpenAPI schema.
Before you build
Authentication
Send a personal access token in the Authorization: Bearer <token> header. Create one in Flowtly on your profile's Security page. A token acts with your own permissions, lasts 365 days unless you choose otherwise (at most 730), and can be revoked there at any time.
Organisation header
Every request also carries an instance header with the ID of the organisation you are acting in. Without it, the API refuses the request.
Requests and responses
Responses are JSON-LD (application/ld+json) or plain JSON (application/json). Updates use PATCH with application/merge-patch+json. Collections are paged with page and itemsPerPage, at most 500 items per page.
Versioning
The API is not versioned in its paths or headers: resources sit at the root, for example https://api.flowtly.eu/projects. The OpenAPI 3.1 document is published at https://api.flowtly.eu/docs.json.
Rate limits
Requests are rate-limited. Write requests (POST, PUT, PATCH, DELETE) count per organisation over a five-minute window, with a higher limit once the organisation is verified or subscribed. Over a limit, the API answers 429 Too Many Requests with a Retry-After header giving the seconds to wait. The limits can change, so read Retry-After rather than hard-coding a number.
Deprecations
An endpoint or field that is being retired is marked deprecated in the OpenAPI document. The API sends no deprecation headers, so check the document when you update an integration.
Testing your integration
There is no separate sandbox. Test your integration in a trial workspace with sample data before you connect live data. Until the organisation is verified or subscribed, a trial runs on a lower write limit and sends no email.
What changed
API changes are announced in the release notes, together with the rest of the product.
Read the release notesProjects & delivery
97Projects, tasks, members, rates and allocations — automate delivery and sync project data.
Resourcing & capacity
11Allocations, the bench, the schedule window and actuals — plan who works on what, and read back what they did.
Invoicing & payments
49Invoices, rows, payments, reminders and e-invoicing (KSeF) — automate billing end to end.
Budgets & spend
159Budgets, transactions, costs, tax and bank accounts — track spend and reconcile automatically.
CRM — leads & deals
78Leads, deals, pipelines and stages — drive the sales funnel from your own systems.
Clients & counterparties
34Clients, contacts and counterparties — keep your CRM and Flowtly in sync.
HR & people
87Employees, departments, positions, benefits and responsibilities — automate HR data flows.
Performance & reviews
31Review cycles, templates, questions and sessions — run performance reviews programmatically.
Time & attendance
67Work time, leave, schedules and holidays — log and read attendance programmatically.
Recruitment & ATS
40Candidates, recruitment tasks, interviews and scheduling — connect your ATS.
Property & assets
50Properties, bookings, assets, meters and readings — manage real-estate data via the API.
Contracts & compliance
48Agreements, contracts, attachments and payment schedules — automate contract workflows.
Documents & signatures
20Documents, storage and e-signature requests — upload, organize and sign files.
Customization & tags
62Attributes, attribute sets, rules and tags — extend Flowtly objects with your own fields.
Organization & config
48Organization, locations, users, integrations and subscription — configure the workspace.
Users & access
16Users and permission groups — manage who can see and do what.
Webhooks & audit
14Webhooks and audit logs — react to events and track changes.
Accountancy exports
16Exports to Wapro, Optima, Enova, Symfonia, MT940 and SEPA — hand data to your accountant.
MCP server
Connect AI tools to Flowtly through the Model Context Protocol at mcp.flowtly.eu.