Appearance
API Changelog
The Flowstate API follows Semantic Versioning. Breaking changes will only occur in major version bumps and will be announced well in advance.
For platform changes, see Flowstate Updates.
v1.1.0 — 2026-04-08
Custom attributes, nested writes, and vacancy fill.
For platform changes, see Flowstate Updates.
Added
- Custom attributes — Define custom fields on employees, contractors, vacancies, teams, and projects via
GET/POST/PATCH/DELETE /custom-attributes. Custom attribute values are returned on all resource endpoints and can be set during create and update operations. - Nested create and update — Create or update child records inline. For example, create an employee and their team assignment in a single
POST /employeesrequest by including anassignmentsarray in the body. - Vacancy fill endpoint —
POST /vacancies/:id/fillconverts a vacancy into an active employee or contractor record, closing the vacancy and transferring its assignments. ?include=support — Use?include=assignments,team,projecton any resource endpoint to embed related records in the response, reducing round trips.- Cost centre filter — All list endpoints now accept
costCentreIdas a filter parameter.
Changed
- Work Types renamed to Resource Types — The
/work-typesendpoint is now/resource-types. The previous path continues to work but is deprecated and will be removed in v2.0.0.
v1.0.0 — 2026-03-11
Initial public release of the Flowstate Developer API.
Added
- Employees — Full CRUD for employee records with salary, role, and geography data
- Contractors — Full CRUD for external contractors with rate and contract period tracking
- Vacancies — Full CRUD for open positions with salary ranges and hiring pipeline status
- Teams — Full CRUD for organizational teams with hierarchy support
- Projects — Full CRUD for projects with timelines and cost estimates
- Assignments — Unified assignment model for employee, contractor, vacancy, and team allocations to teams and projects
- Cost Centres — Full CRUD for cost centre management
- Value Streams — Full CRUD for value stream organization
- Work Types — Full CRUD for work type classification
- Drivers — Full CRUD for strategic project drivers
- Lifecycle Stages — Full CRUD for project lifecycle stage management
- Exchange Rates — Full CRUD for currency conversion rates
- Locations — Full CRUD for geographic location management
- Scenario support — Pass
scenarioIdto any endpoint to operate within a what-if scenario - Pagination — Consistent page-based pagination with
page,limit,search,sortBy, andsortDir - Authentication — API key-based authentication with scoped permissions
- Error handling — Structured error responses with error codes and unique error IDs