Організація & налаштування – будуйте на Flowtly

Використовуйте цей добірний знімок OpenAPI-схеми Flowtly, щоб планувати інтеграції, автоматизувати процеси та синхронізувати дані, на які спираються ваші команди.

Статус документації

Остання синхронізація: 2026-04-03 18:31 (версія застосунку 2.0.0)

Публікується лише частина сутностей. Запускайте обидві команди синхронізації, щоб оновити цю документацію після виходу нових можливостей Flowtly.

Організація & налаштування

Налаштування організації, місцезнаходження, банківські рахунки, валюти та інтеграції.

Огляд сутності

Організація

Читання та оновлення профілю організації, зареєстрованих адрес та системних налаштувань.

Ендпоїнти

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

Список організацій

Отримати кілька значень конфігурації

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

Створити організацію

Створює ресурс OrganizationAddress.

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

Створити чистий

Створює ресурс Організації.

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

Створити іконку

Створює ресурс Організації.

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

Створити логотип

Створює ресурс Організації.

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

Список нижнього колонтитулу пошти

Отримує ресурс Організація.

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

Оновлює ресурс Організації.

Оновлює ресурс Організації.

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

Отримати організацію за ID

Отримати один ресурс за його ідентифікатором.

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

Список організацій

Отримати кілька значень конфігурації

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

Створити організацію

Створює ресурс OrganizationAddress.

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

Отримати організацію за ID

Отримати один ресурс за його ідентифікатором.

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

Видалити організацію

Видалити ресурс.

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

Оновити організацію

Оновити поля ресурсу за допомогою JSON Merge Patch.

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

Список організацій

Отримати кілька значень конфігурації

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

Отримати організацію за ID

Отримати один ресурс за його ідентифікатором.

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

Оновити організацію

Оновити поля ресурсу за допомогою JSON Merge Patch.

Сценарії використання

Забезпечте нові робочі простори за допомогою автоматизації адаптації.
Синхронізуйте зміни адреси компанії, щоб забезпечити точність рахунків та записів відповідності.

Поля схеми

OrganizationAddress-organization_address.read
Поле Тип Опис
id string поле ідентифікатора.
organization string | null поле організації.
type string поле типу.
name string поле назви.
street string поле вулиці.
city string поле міста.
postCode string поле postCode.
country string поле країни.
email string | null поле електронної пошти.
tin string | null поле tin.
tinCountry string | null поле tinCountry.

Огляд сутності

Місцезнаходження

Керуйте фізичними локаціями, що використовуються для призначення працівників, планування та відстеження активів.

Ендпоїнти

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

Список локацій

Отримує колекцію ресурсів Location.

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

Створити місцезнаходження

Створює ресурс Місцезнаходження.

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

Отримати місцезнаходження за ID

Отримати окремий ресурс за його ідентифікатором.

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

Оновити місцезнаходження

Оновити поля ресурсу за допомогою JSON Merge Patch.

Сценарії використання

Зареєструйте місцезнаходження офісів із вашої системи об'єктів.
Призначте працівників до локацій для звітування про гібридну роботу.

Поля схеми

Location-location.read
Поле Тип Опис
id integer Поле id.
name string Поле name.
officeOpenHour integer | null Поле officeOpenHour.
officeCloseHour integer | null Поле officeCloseHour.

Огляд сутності

Країна

Запит підтримуваних країн, що використовуються для адрес, податкових правил та регіональної конфігурації.

Ендпоїнти

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

Список країн

Отримує колекцію ресурсів Країни.

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

Отримати країну за ідентифікатором

Отримує один ресурс за його ідентифікатором.

Сценарії використання

Пошук кодів країн для перевірки адрес.
Перевірка підтримуваних країн перед налаштуванням регіональних параметрів.

Поля схеми

Country-country.read
Поле Тип Опис
id string Поле id.

Огляд сутності

Мова

Запитуйте та налаштовуйте доступні мови для налаштування багатомовного робочого простору.

Ендпоїнти

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

Список мов

Отримує колекцію ресурсів Language.

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

Створити мову

Створює ресурс Language.

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

Отримати мову за ID

Отримати один ресурс за його ідентифікатором.

Сценарії використання

Виявляти доступні мови перед генерацією локалізованих документів.
Додавати підтримку нових мов для команд у різних регіонах.

Поля схеми

Language-language.read
Поле Тип Опис
id string Поле id.

Огляд сутності

Інтеграція

Керуйте підключеннями до Google Workspace, Microsoft Teams, Kontomatik та інших зовнішніх сервісів.

Ендпоїнти

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

Створити реєстрацію

Створює ресурс MicrosoftTeamsEnrollInput.

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

Переглянути Google Workspace

Отримує ресурс GoogleWorkspaceIntegrationStatusOutput.

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

Створити запит на отримання

Створює ресурс Integration.

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

Створити відкликання

Створює ресурс Integration.

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

Створити налаштування

Створює ресурс Integration.

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

Переглянути вимоги

Отримує ресурс IntegrationRequirementsOutput.

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

Переглянути вимоги

Отримує ресурс IntegrationRequirementsOutput.

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

Переглянути Kontomatik

Отримує ресурс KontomatikIntegrationStatusOutput.

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

Створити реєстрацію

Створює ресурс MicrosoftTeamsEnrollInput.

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

Переглянути Microsoft Teams

Отримує ресурс MicrosoftTeamsIntegrationStatusOutput.

Сценарії використання

Перевірити стан інтеграції з вашої системи моніторингу.
Програмно реєструвати нові інтеграції під час налаштування робочого простору.

Поля схеми

IntegrationRequirementsOutput-integration_requirements.read
Поле Тип Опис
tenantIdLabel string Поле tenantIdLabel.
tenantIdPlaceholder string | null Поле tenantIdPlaceholder.
clientIdRequired boolean Поле clientIdRequired.
scopes array Поле scopes.

Огляд сутності

Зустріч

Створюйте та відстежуйте зустрічі, пов'язані з працівниками, проєктами або клієнтами.

Ендпоїнти

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

Список зустрічей

Отримує колекцію ресурсів Зустрічей.

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

Створити зустріч

Створює ресурс Зустріч.

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

Отримати зустріч за ID

Отримати окремий ресурс за його ідентифікатором.

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

Оновити зустріч

Оновити поля ресурсу за допомогою JSON Merge Patch.

Сценарії використання

Синхронізуйте події календаря з Google/Outlook як записи зустрічей Flowtly.
Відстежуйте частоту зустрічей на клієнта для оцінки стану взаємовідносин.

Поля схеми

Meeting-meeting.read
Поле Тип Опис
id string Поле id.
status string Поле status.
employee string | null Поле employee.
dateFrom string Поле dateFrom.
dateTo string Поле dateTo.
notes string | null Поле notes.
time string | null Поле time.

Огляд сутності

Підписка

Запит статусу підписки, деталей плану та доступності функцій для вашого робочого простору.

Ендпоїнти

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

Список підписок

Отримує колекцію ресурсів підписки.

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

Створити підписку

Створює ресурс підписки.

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

Створити застосування купона

Створює ресурс підписки.

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

Створити очищення купона

Створює ресурс підписки.

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

Отримати підписку за ID

Отримати один ресурс за його ідентифікатором.

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

Створює ресурс підписки.

Створює ресурс підписки.

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

Отримати підписку за ID

Отримати один ресурс за його ідентифікатором.

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

Список каталогу

Отримує колекцію ресурсів SubscriptionCatalogProductOutput.

Сценарії використання

Перевірте рівень підписки, перш ніж увімкнути преміум-функції у вашій інтеграції.
Відстежуйте статус підписки для автоматизації керування ліцензіями.

Поля схеми

Subscription-subscription.read_organization_address.read
Поле Тип Опис
id string Поле id.
organization string Поле organization.
organizationAddress object Поле organizationAddress.
type string Поле type.
paymentMethod string | null Поле paymentMethod.
products array Поле products.
seats integer Поле seats.
modules array Поле modules.
status string Поле status.
metadata array Поле metadata.
Whatsapp