Projects & delivery – 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-02-23 12:40 (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.

Projects & delivery

Expose project metadata, members, and billing context.

Entity overview

Attribute

Create and manage custom attributes to extend Flowtly data models.

Endpoints

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

List attributes

Retrieve attributes with pagination and filters.

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

Create attribute

Define a new attribute with slug, name, and type.

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

Get attribute by ID

Read a specific attribute definition.

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

Update attribute

Patch attribute details such as name or description.

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

Delete attribute

Remove an attribute definition.

GET https://api.flowtly.eu/attribute-entity-values

List attribute-entity-values

Retrieve attribute values linked to entities.

POST https://api.flowtly.eu/attribute-entity-values

Create attribute-entity-value

Create a value for an attribute on a specific entity.

GET https://api.flowtly.eu/attribute-entity-values/{id}

Get attribute-entity-value

Fetch a single attribute value attached to an entity.

PATCH https://api.flowtly.eu/attribute-entity-values/{id}

Update attribute-entity-value

Patch the value or metadata stored for an entity.

DELETE https://api.flowtly.eu/attribute-entity-values/{id}

Delete attribute-entity-value

Remove an attribute value from an entity.

GET https://api.flowtly.eu/attribute-set-attributes

List attribute-set-attributes

Retrieve the attributes assigned to sets.

POST https://api.flowtly.eu/attribute-set-attributes

Create attribute-set-attribute

Add an attribute into a set.

GET https://api.flowtly.eu/attribute-set-attributes/{id}

Get attribute-set-attribute

Fetch a single attribute-to-set assignment.

PATCH https://api.flowtly.eu/attribute-set-attributes/{id}

Update attribute-set-attribute

Patch ordering or configuration of an attribute within a set.

DELETE https://api.flowtly.eu/attribute-set-attributes/{id}

Delete attribute-set-attribute

Remove an attribute from a set.

GET https://api.flowtly.eu/attribute-sets

List attribute-sets

Retrieve attribute sets.

POST https://api.flowtly.eu/attribute-sets

Create attribute-set

Define a new attribute set.

GET https://api.flowtly.eu/attribute-sets/{id}

Get attribute-set

Read a specific attribute set.

PATCH https://api.flowtly.eu/attribute-sets/{id}

Update attribute-set

Patch attribute set details.

DELETE https://api.flowtly.eu/attribute-sets/{id}

Delete attribute-set

Remove an attribute set.

GET https://api.flowtly.eu/attribute-values

List attribute-values

Retrieve standalone attribute values.

POST https://api.flowtly.eu/attribute-values

Create attribute-value

Create a reusable attribute value.

GET https://api.flowtly.eu/attribute-values/{id}

Get attribute-value

Fetch a specific attribute value.

PATCH https://api.flowtly.eu/attribute-values/{id}

Update attribute-value

Patch a reusable attribute value.

DELETE https://api.flowtly.eu/attribute-values/{id}

Delete attribute-value

Delete a reusable attribute value.

GET https://api.flowtly.eu/attribute-sets/relation-names

Retrieves the collection of AttributeSetRelationNameOutput resources.

Retrieves the collection of AttributeSetRelationNameOutput resources.

Schema fields

Attribute-attribute.read
Field Type Description
id string Identifier of the attribute.
name string Display name of the attribute.
type string Data type of the attribute.
shift integer —
required boolean —
multiple boolean —
defaultValue string | null —
formatPattern string | null —

Entity overview

Project

Use Flowtly projects as the canonical reference for delivery, allowing PMO tools to align on members and schedules.

Endpoints

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

List projects

Retrieve projects with filters over client, status, or contract type.

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

Create project

Provision a project with billing type, client references, and optional schedule.

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

Get project by ID

Inspect a specific project to read members, currency, and key fields.

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

Update project

Patch project metadata, dates, or billing type.

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

Preview projects

Preview project data before creation.

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

Search projects

Search projects by filters.

GET https://api.flowtly.eu/projects/{id}/profitability

Get project profitability

Inspect profitability metrics for a project.

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

Removes the Project resource.

Removes the Project resource.

Use cases

Create projects from your CRM when a deal closes to prep staffing workflows.
Update project lifecycles from external tools to keep Flowtly cost projections accurate.

Schema fields

Project-project.read
Field Type Description
id integer Internal Flowtly project identifier.
client string | null IRI for the client organization.
currency string | null Currency reference used for billing and budgets.
dateFrom string | null Planned project start date.
dateTo string | null Planned project end date.
name string Project name shown in the UI.
publicDescription string | null Customer-facing description of the project.
type string Billing model such as fixed-price or time-and-material.
clientHash string Hashed identifier Flowtly uses internally for dedupe.
notes string | null Internal notes available to Flowtly users.
color string Hex color assigned for UI badges.
priceNet string | null Net price configured for the project.
taxGroup string | null IRI of the tax group applied to the project.
attributeSet string | null —
projectMembers array List of member IRIs assigned to the project.
status string System-managed lifecycle status (active, archived, etc.).
flattenType string Internal normalized type used by Flowtly.
budgets array —

Examples

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

Create the Aurora rollout project

Adds a time-and-material project tied to a CRM client with planned start and end dates.

Request payload 
{
    "name": "Aurora Rollout",
    "type": "time-and-material",
    "currency": "/api/currencies/EUR",
    "client": "/api/clients/cl_901",
    "dateFrom": "2024-06-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "notes": "Expansion to Germany and France"
}
Response payload 
{
    "@id": "/api/projects/prj_aurora",
    "@type": "Project",
    "id": 9821,
    "name": "Aurora Rollout",
    "type": "time-and-material",
    "currency": "/api/currencies/EUR",
    "client": "/api/clients/cl_901",
    "dateFrom": "2024-06-01T00:00:00+00:00",
    "dateTo": "2024-12-31T00:00:00+00:00",
    "status": "active"
}
Whatsapp