Skip to content

HR & people – 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.

HR & people

Employee profiles, departments, positions, benefits, and org structure.

Entity overview

Employee

Create and manage employees for assignments, approvals, and access control.

Endpoints

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

List employees

Retrieves the collection of Employee resources.

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

Create employee

Creates a Employee resource.

GET https://api.flowtly.eu/employees/me

List me

Retrieves the collection of Employee resources.

GET https://api.flowtly.eu/employees/preview

List preview

Retrieves the collection of Employee resources.

GET https://api.flowtly.eu/employees/search

List search

Retrieves the collection of Employee resources.

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

Get employee by ID

Retrieve a single resource by its identifier.

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

Delete employee

Remove the resource.

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

Update employee

Update resource fields using JSON Merge Patch.

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

Get employee by ID

Retrieve a single resource by its identifier.

GET https://api.flowtly.eu/employees/{id}/feedback-suggestion

Get employee by ID

Retrieve a single resource by its identifier.

GET https://api.flowtly.eu/employees/{id}/project-rates

Get employee by ID

Retrieve a single resource by its identifier.

POST https://api.flowtly.eu/employees/{id}/user

Creates a Employee resource.

Creates a Employee resource.

DELETE https://api.flowtly.eu/employees/{id}/user

Delete employee

Remove the resource.

GET https://api.flowtly.eu/employees/{id}/working-hours-stats/{date}

Get employee by ID

Retrieve a single resource by its identifier.

Use cases

Provision new hires from your HRIS so they appear in Flowtly on day one.
Sync org chart changes to keep project staffing and approval chains current.

Schema fields

Employee-employee.read_employee.detail
Field Type Description
id integer id field.
userId integer userId field.
companyEmail string companyEmail field.
contactEmail string contactEmail field.
contactPhone string contactPhone field.
birthday string birthday field.
firstname string firstname field.
lastname string lastname field.
roles array roles field.
phoneTextAllowed boolean phoneTextAllowed field.
department string department field.
reportsTo string reportsTo field.
directReports array directReports field.
departments array departments field.
activeAgreement string activeAgreement field.

Entity overview

Department

Manage department hierarchy to drive access control, budget allocation, and headcount reporting.

Endpoints

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

List departments

Retrieves the collection of Department resources.

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

Create department

Creates a Department resource.

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

Get department by ID

Retrieve a single resource by its identifier.

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

Update department

Update resource fields using JSON Merge Patch.

Use cases

Mirror your HRIS department tree into Flowtly for unified org reporting.
Create departments to segment budget and utilization dashboards.

Schema fields

Department-department.read_employee.preview
Field Type Description
id integer id field.
name string name field.
code string | null code field.
manager object manager field.

Entity overview

Position

Define standardized positions to drive role-based assignment, agreement templates, and headcount planning.

Endpoints

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

List positions

Retrieves the collection of Position resources.

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

Create position

Creates a Position resource.

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

Get position by ID

Retrieve a single resource by its identifier.

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

Delete position

Remove the resource.

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

Update position

Update resource fields using JSON Merge Patch.

Use cases

Sync open positions from your ATS to track hiring pipeline inside Flowtly.
Map positions to cost rates for automated project profitability calculations.

Schema fields

Position-position.read_responsibility.read
Field Type Description
id string id field.
name string name field.
roles array roles field.
responsibilities object responsibilities field.

Entity overview

Benefit

Manage benefit catalog, pricing, and per-employee enrollment to keep HR compensation data in sync.

Endpoints

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

List benefits

Retrieves the collection of EmployeeBenefit resources.

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

Create benefit

Creates a EmployeeBenefit resource.

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

Get benefit by ID

Retrieve a single resource by its identifier.

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

Update benefit

Update resource fields using JSON Merge Patch.

POST https://api.flowtly.eu/benefit-prices

Create benefit

Creates a EmployeeBenefit resource.

GET https://api.flowtly.eu/benefit-prices/{id}

Get benefit by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/benefit-prices/{id}

Delete benefit

Remove the resource.

PATCH https://api.flowtly.eu/benefit-prices/{id}

Update benefit

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/employee-benefits

List benefits

Retrieves the collection of EmployeeBenefit resources.

POST https://api.flowtly.eu/employee-benefits

Create benefit

Creates a EmployeeBenefit resource.

GET https://api.flowtly.eu/employee-benefits/{id}

Get benefit by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/employee-benefits/{id}

Update benefit

Update resource fields using JSON Merge Patch.

Use cases

Import benefit plans from your broker and auto-enroll eligible employees.
Track benefit costs per employee for total compensation reporting.

Schema fields

BenefitPrice-benefit.read_benefit_price.read
Field Type Description
id integer id field.
validFrom string validFrom field.
validTo string | null validTo field.
price number price field.
taxPercent number taxPercent field.
defaultCompanyCoverageAmount number defaultCompanyCoverageAmount field.

Entity overview

Employee note

Store and retrieve HR notes for performance reviews, onboarding status, and internal memos.

Endpoints

GET https://api.flowtly.eu/employee-notes

List employee notes

Retrieves the collection of EmployeeNote resources.

POST https://api.flowtly.eu/employee-notes

Create employee note

Creates a EmployeeNote resource.

GET https://api.flowtly.eu/employee-notes/{id}

Get employee note by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/employee-notes/{id}

Delete employee note

Remove the resource.

PATCH https://api.flowtly.eu/employee-notes/{id}

Update employee note

Update resource fields using JSON Merge Patch.

Use cases

Push manager feedback from your 1:1 tool into Flowtly employee records.
Attach compliance or background-check notes to employee profiles.

Schema fields

EmployeeNote-employee_note.read
Field Type Description
id string id field.
employee string employee field.
author string author field.
note string note field.
createdAt string createdAt field.

Entity overview

Employee health & safety

Track mandatory OHS (BHP) training certifications, expiry dates, and compliance status.

Endpoints

GET https://api.flowtly.eu/employee-bhps

List employee health & safetys

Retrieves the collection of EmployeeBhp resources.

POST https://api.flowtly.eu/employee-bhps

Create employee health & safety

Creates a EmployeeBhp resource.

GET https://api.flowtly.eu/employee-bhps/{id}

Get employee health & safety by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/employee-bhps/{id}

Update employee health & safety

Update resource fields using JSON Merge Patch.

Use cases

Sync safety training completions from your LMS to Flowtly.
Alert managers when an employee's OHS certification is about to expire.

Schema fields

EmployeeBhp-employee_bhp.read
Field Type Description
id integer id field.
employee string | null employee field.
dateFrom string dateFrom field.
dateTo string | null dateTo field.
note string | null note field.

Entity overview

Responsibility

Define responsibilities, group them, and assign to employees or positions for structured accountability.

Endpoints

GET https://api.flowtly.eu/position-responsibilities

List responsibilitys

Retrieves the collection of ResponsibilityGroup resources.

POST https://api.flowtly.eu/position-responsibilities

Create responsibility

Creates a ResponsibilityGroup resource.

GET https://api.flowtly.eu/position-responsibilities/{id}

Get responsibility by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/position-responsibilities/{id}

Delete responsibility

Remove the resource.

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

List responsibilitys

Retrieves the collection of ResponsibilityGroup resources.

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

Create responsibility

Creates a ResponsibilityGroup resource.

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

Get responsibility by ID

Retrieve a single resource by its identifier.

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

Update responsibility

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/responsibility-employees

List responsibilitys

Retrieves the collection of ResponsibilityGroup resources.

POST https://api.flowtly.eu/responsibility-employees

Create responsibility

Creates a ResponsibilityGroup resource.

GET https://api.flowtly.eu/responsibility-employees/{id}

Get responsibility by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/responsibility-employees/{id}

Delete responsibility

Remove the resource.

PATCH https://api.flowtly.eu/responsibility-employees/{id}

Update responsibility

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/responsibility-groups

List responsibilitys

Retrieves the collection of ResponsibilityGroup resources.

POST https://api.flowtly.eu/responsibility-groups

Create responsibility

Creates a ResponsibilityGroup resource.

GET https://api.flowtly.eu/responsibility-groups/{id}

Get responsibility by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/responsibility-groups/{id}

Update responsibility

Update resource fields using JSON Merge Patch.

Use cases

Map compliance duties to roles so audit tooling can verify coverage.
Build a RACI matrix by syncing responsibilities with your project management tool.

Schema fields

Responsibility-responsibility.read_responsibility_employee.read
Field Type Description
id integer id field.
parent object parent field.
responsibilityGroup string responsibilityGroup field.
name string name field.
description string description field.
children array children field.
responsibilityEmployees array responsibilityEmployees field.

Entity overview

Feedback

Collect, manage, and query peer and manager feedback for performance cycles.

Endpoints

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

List feedbacks

Retrieves the collection of FeedbackRequest resources.

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

Create feedback

Creates a FeedbackRequest resource.

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

Get feedback by ID

Retrieve a single resource by its identifier.

GET https://api.flowtly.eu/feedback-requests

List feedbacks

Retrieves the collection of FeedbackRequest resources.

POST https://api.flowtly.eu/feedback-requests

Create feedback

Creates a FeedbackRequest resource.

GET https://api.flowtly.eu/feedback-requests/{id}

Get feedback by ID

Retrieve a single resource by its identifier.

Use cases

Trigger feedback requests from your performance management platform.
Pull aggregated feedback scores into talent dashboards.

Schema fields

Feedback-feedback.read
Field Type Description
id string id field.
employee string | null employee field.
authorEmployee string | null authorEmployee field.
description string description field.
details string | null details field.
visibility string visibility field.
rate string rate field.
createdAt string createdAt field.

Entity overview

Organization user

Manage who has access to the Flowtly workspace, send invitations, and remove users.

Endpoints

GET https://api.flowtly.eu/organization-users

List organization users

Retrieves the collection of OrganizationUserInvitation resources.

DELETE https://api.flowtly.eu/organization-users/{id}

Delete organization user

Remove the resource.

GET https://api.flowtly.eu/organization-user-invitations

List organization users

Retrieves the collection of OrganizationUserInvitation resources.

POST https://api.flowtly.eu/organization-user-invitations/{id}/accept

Creates a OrganizationUserInvitation resource.

Creates a OrganizationUserInvitation resource.

POST https://api.flowtly.eu/organization-user-invitations/{id}/reject

Creates a OrganizationUserInvitation resource.

Creates a OrganizationUserInvitation resource.

Use cases

Auto-invite new hires when they are provisioned in your identity provider.
Revoke access when employees are offboarded from your HRIS.

Schema fields

OrganizationUser-organization_user.read_user.read
Field Type Description
id string id field.
user object user field.
type string type field.
Whatsapp