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 2024-07-08 12:00 (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

Project

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

Endpoints

GET /api/projects

List projects

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

POST /api/projects

Create project

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

GET /api/projects/{id}

Get project by ID

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

PATCH /api/projects/{id}

Update project

Patch project metadata, dates, or billing type.

GET /api/projects/preview

Preview projects

Preview project data before creation.

GET /api/projects/search

Search projects

Search projects by filters.

GET /api/projects/{id}/profitability

Get project profitability

Inspect profitability metrics for a project.

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.
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.

Examples

POST /api/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"
}

Entity overview

Attribute

Create and manage custom attributes to extend Flowtly data models.

Endpoints

GET /api/attributes

List attributes

Retrieve attributes with pagination and filters.

POST /api/attributes

Create attribute

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

GET /api/attributes/{id}

Get attribute by ID

Read a specific attribute definition.

PATCH /api/attributes/{id}

Update attribute

Patch attribute details such as name or description.

DELETE /api/attributes/{id}

Delete attribute

Remove an attribute definition.

Schema fields

Attribute-attribute.read
Field Type Description
id integer Identifier of the attribute.
name string Display name of the attribute.
slug string Slug used to reference the attribute.
type string Data type of the attribute.
description string | null Optional description of the attribute purpose.
Whatsapp