Organization & config – 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.

Organization & config

Organization settings, locations, bank accounts, currencies, and integrations.

Entity overview

Organization

Read and update organization profile, registered addresses, and system-wide configuration.

Endpoints

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

List organizations

Get multiple configuration values

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

Create organization

Creates a OrganizationAddress resource.

POST https://api.flowtly.eu/organizations/clear

Create clear

Creates a Organization resource.

POST https://api.flowtly.eu/organizations/icon

Create icon

Creates a Organization resource.

POST https://api.flowtly.eu/organizations/logo

Create logo

Creates a Organization resource.

GET https://api.flowtly.eu/organizations/mail-footer

List mail footer

Retrieves a Organization resource.

PATCH https://api.flowtly.eu/organizations/mail-footer

Updates the Organization resource.

Updates the Organization resource.

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

Get organization by ID

Retrieve a single resource by its identifier.

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

List organizations

Get multiple configuration values

POST https://api.flowtly.eu/organization-addresses

Create organization

Creates a OrganizationAddress resource.

GET https://api.flowtly.eu/organization-addresses/{id}

Get organization by ID

Retrieve a single resource by its identifier.

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

Delete organization

Remove the resource.

PATCH https://api.flowtly.eu/organization-addresses/{id}

Update organization

Update resource fields using JSON Merge Patch.

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

List organizations

Get multiple configuration values

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

Get organization by ID

Retrieve a single resource by its identifier.

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

Update organization

Update resource fields using JSON Merge Patch.

Use cases

Provision new workspaces from your onboarding automation.
Sync company address changes to keep invoices and compliance records accurate.

Schema fields

OrganizationAddress-organization_address.read
Field Type Description
id string id field.
organization string | null organization field.
type string type field.
name string name field.
street string street field.
city string city field.
postCode string postCode field.
country string country field.
email string | null email field.
tin string | null tin field.
tinCountry string | null tinCountry field.

Entity overview

Location

Manage physical locations used for employee assignment, scheduling, and asset tracking.

Endpoints

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

List locations

Retrieves the collection of Location resources.

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

Create location

Creates a Location resource.

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

Get location by ID

Retrieve a single resource by its identifier.

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

Update location

Update resource fields using JSON Merge Patch.

Use cases

Register office locations from your facilities system.
Assign employees to locations for hybrid-work reporting.

Schema fields

Location-location.read
Field Type Description
id integer id field.
name string name field.
officeOpenHour integer | null officeOpenHour field.
officeCloseHour integer | null officeCloseHour field.

Entity overview

Country

Query supported countries used for addresses, tax rules, and regional configuration.

Endpoints

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

List countrys

Retrieves the collection of Country resources.

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

Get country by ID

Retrieve a single resource by its identifier.

Use cases

Look up country codes for address validation.
Check supported countries before provisioning regional settings.

Schema fields

Country-country.read
Field Type Description
id string id field.

Entity overview

Language

Query and configure available languages for multi-language workspace setup.

Endpoints

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

List languages

Retrieves the collection of Language resources.

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

Create language

Creates a Language resource.

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

Get language by ID

Retrieve a single resource by its identifier.

Use cases

Detect available languages before generating localized documents.
Add new language support for multi-region teams.

Schema fields

Language-language.read
Field Type Description
id string id field.

Entity overview

Integration

Manage connections to Google Workspace, Microsoft Teams, Kontomatik, and other external services.

Endpoints

POST https://api.flowtly.eu/integrations/google-workspace/enroll

Create enroll

Creates a MicrosoftTeamsEnrollInput resource.

GET https://api.flowtly.eu/integrations/google-workspace

List google workspace

Retrieves a GoogleWorkspaceIntegrationStatusOutput resource.

POST https://api.flowtly.eu/integrations/kontomatik/pull

Create pull

Creates a Integration resource.

POST https://api.flowtly.eu/integrations/kontomatik/revoke

Create revoke

Creates a Integration resource.

POST https://api.flowtly.eu/integrations/kontomatik/setup

Create setup

Creates a Integration resource.

GET https://api.flowtly.eu/integrations/google-workspace/requirements

List requirements

Retrieves a IntegrationRequirementsOutput resource.

GET https://api.flowtly.eu/integrations/microsoft-teams/requirements

List requirements

Retrieves a IntegrationRequirementsOutput resource.

GET https://api.flowtly.eu/integrations/kontomatik

List kontomatik

Retrieves a KontomatikIntegrationStatusOutput resource.

POST https://api.flowtly.eu/integrations/microsoft-teams/enroll

Create enroll

Creates a MicrosoftTeamsEnrollInput resource.

GET https://api.flowtly.eu/integrations/microsoft-teams

List microsoft teams

Retrieves a MicrosoftTeamsIntegrationStatusOutput resource.

Use cases

Check integration health status from your monitoring system.
Enroll new integrations programmatically during workspace setup.

Schema fields

IntegrationRequirementsOutput-integration_requirements.read
Field Type Description
tenantIdLabel string tenantIdLabel field.
tenantIdPlaceholder string | null tenantIdPlaceholder field.
clientIdRequired boolean clientIdRequired field.
scopes array scopes field.

Entity overview

Meeting

Create and track meetings linked to employees, projects, or clients.

Endpoints

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

List meetings

Retrieves the collection of Meeting resources.

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

Create meeting

Creates a Meeting resource.

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

Get meeting by ID

Retrieve a single resource by its identifier.

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

Update meeting

Update resource fields using JSON Merge Patch.

Use cases

Sync calendar events from Google/Outlook as Flowtly meeting records.
Track meeting frequency per client for relationship health scoring.

Schema fields

Meeting-meeting.read
Field Type Description
id string id field.
status string status field.
employee string | null employee field.
dateFrom string dateFrom field.
dateTo string dateTo field.
notes string | null notes field.
time string | null time field.

Entity overview

Subscription

Query subscription status, plan details, and feature availability for your workspace.

Endpoints

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

List subscriptions

Retrieves the collection of Subscription resources.

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

Create subscription

Creates a Subscription resource.

POST https://api.flowtly.eu/subscriptions/apply-coupon

Create apply coupon

Creates a Subscription resource.

POST https://api.flowtly.eu/subscriptions/clear-coupon

Create clear coupon

Creates a Subscription resource.

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

Get subscription by ID

Retrieve a single resource by its identifier.

POST https://api.flowtly.eu/subscriptions/{id}/cancel

Creates a Subscription resource.

Creates a Subscription resource.

GET https://api.flowtly.eu/subscriptions/{id}/invoices

Get subscription by ID

Retrieve a single resource by its identifier.

GET https://api.flowtly.eu/subscriptions/catalog

List catalog

Retrieves the collection of SubscriptionCatalogProductOutput resources.

Use cases

Check subscription tier before enabling premium features in your integration.
Monitor subscription status for license management automation.

Schema fields

Subscription-subscription.read_organization_address.read
Field Type Description
id string id field.
organization string organization field.
organizationAddress object organizationAddress field.
type string type field.
paymentMethod string | null paymentMethod field.
products array products field.
seats integer seats field.
modules array modules field.
status string status field.
metadata array metadata field.
Whatsapp