Recruitment & ATS – 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.

Recruitment & ATS

Candidates, interview scheduling, recruitment tasks, and resource requests.

Entity overview

Candidate

Track candidates through recruitment stages with notes, scores, and interview history.

Endpoints

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

List candidates

Retrieves the collection of CandidateNote resources.

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

Create candidate

Creates a CandidateNote resource.

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

List search

Retrieves the collection of Candidate resources.

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

Get candidate by ID

Retrieve a single resource by its identifier.

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

Update candidate

Update resource fields using JSON Merge Patch.

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

List candidates

Retrieves the collection of CandidateNote resources.

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

Create candidate

Creates a CandidateNote resource.

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

Get candidate by ID

Retrieve a single resource by its identifier.

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

Delete candidate

Remove the resource.

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

Update candidate

Update resource fields using JSON Merge Patch.

Use cases

Sync applicants from your job board into Flowtly's hiring pipeline.
Push screening scores from assessment platforms to candidate profiles.

Schema fields

Candidate-candidate.read
Field Type Description
id string id field.
firstname string firstname field.
lastname string lastname field.
email string email field.
phoneNumber string | null phoneNumber field.
source string | null source field.
location string | null location field.
birthDate string | null birthDate field.
position string | null position field.
linkedinProfile string | null linkedinProfile field.
notes string | null notes field.
expectations string | null expectations field.
createdAt string createdAt field.

Entity overview

Recruitment task

Define structured interview tasks, group them into assessment frameworks, and collect candidate responses.

Endpoints

GET https://api.flowtly.eu/recruitment-tasks

List recruitment tasks

Retrieves the collection of RecruitmentTaskGroup resources.

POST https://api.flowtly.eu/recruitment-tasks

Create recruitment task

Creates a RecruitmentTaskGroup resource.

GET https://api.flowtly.eu/recruitment-tasks/{id}

Get recruitment task by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/recruitment-tasks/{id}

Update recruitment task

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/recruitment-task-answers

List recruitment tasks

Retrieves the collection of RecruitmentTaskGroup resources.

POST https://api.flowtly.eu/recruitment-task-answers

Create recruitment task

Creates a RecruitmentTaskGroup resource.

GET https://api.flowtly.eu/recruitment-task-answers/{id}

Get recruitment task by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/recruitment-task-answers/{id}

Update recruitment task

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/recruitment-task-groups

List recruitment tasks

Retrieves the collection of RecruitmentTaskGroup resources.

POST https://api.flowtly.eu/recruitment-task-groups

Create recruitment task

Creates a RecruitmentTaskGroup resource.

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

Get recruitment task by ID

Retrieve a single resource by its identifier.

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

Update recruitment task

Update resource fields using JSON Merge Patch.

Use cases

Create standardized interview scorecards synced from your hiring playbook.
Collect and score technical assessment answers programmatically.

Schema fields

RecruitmentTask-recruitment_task.read
Field Type Description
id integer id field.
question string question field.
options array | null options field.
recruitmentTaskGroup string recruitmentTaskGroup field.

Entity overview

Resource request

Submit resource needs, match candidates, and track fulfillment for workforce planning.

Endpoints

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

List resource requests

Retrieves the collection of ResourceRequestCandidate resources.

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

Create resource request

Creates a ResourceRequestCandidate resource.

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

Get resource request by ID

Retrieve a single resource by its identifier.

PATCH https://api.flowtly.eu/resource-requests/{id}

Update resource request

Update resource fields using JSON Merge Patch.

GET https://api.flowtly.eu/resource-request-candidates

List resource requests

Retrieves the collection of ResourceRequestCandidate resources.

POST https://api.flowtly.eu/resource-request-candidates

Create resource request

Creates a ResourceRequestCandidate resource.

GET https://api.flowtly.eu/resource-request-candidates/{id}

Get resource request by ID

Retrieve a single resource by its identifier.

DELETE https://api.flowtly.eu/resource-request-candidates/{id}

Delete resource request

Remove the resource.

PATCH https://api.flowtly.eu/resource-request-candidates/{id}

Update resource request

Update resource fields using JSON Merge Patch.

Use cases

Automate staffing requests when new projects are created.
Match internal candidates to open resource requests based on skills.

Schema fields

ResourceRequest-resource_request.read
Field Type Description
id string id field.
client string | null client field.
status string status field.
location string | null location field.
position string | null position field.
description string | null description field.
start string | null start field.
salaryRangeMin integer | null Value multiplied by Price::MULTIPLIER
salaryRangeMax integer | null Value multiplied by Price::MULTIPLIER
billingType string | null billingType field.
owners array owners field.
createdAt string createdAt field.
Whatsapp