Organização e configuração – construir no Flowtly

Utilize este instantâneo selecionado do esquema OpenAPI do Flowtly para planear integrações, automatizar fluxos de trabalho e sincronizar os dados em que as suas equipas confiam.

Estado da documentação

Última sincronização em 2026-04-03 18:31 (versão da aplicação 2.0.0)

Apenas um subconjunto de entidades é tornado público. Execute ambos os comandos de sincronização para atualizar esta documentação quando a aplicação Flowtly disponibilizar novas capacidades.

Organização e configuração

Definições da organização, localizações, contas bancárias, moedas e integrações.

Visão geral da entidade

Organização

Ler e atualizar o perfil da organização, endereços registados e configuração de todo o sistema.

Endpoints

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

Listar organizações

Obter múltiplos valores de configuração

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

Criar organização

Cria um recurso OrganizationAddress.

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

Criar limpeza

Cria um recurso Organization.

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

Criar ícone

Cria um recurso Organization.

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

Criar logótipo

Cria um recurso Organization.

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

Listar rodapé de email

Obtém um recurso Organization.

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

Atualiza o recurso Organization.

Atualiza o recurso Organization.

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

Obter organização por ID

Obter um único recurso pelo seu identificador.

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

Listar organizações

Obter múltiplos valores de configuração

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

Criar organização

Cria um recurso OrganizationAddress.

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

Obter organização por ID

Obter um único recurso pelo seu identificador.

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

Eliminar organização

Eliminar o recurso.

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

Atualizar organização

Atualizar campos do recurso utilizando JSON Merge Patch.

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

Listar organizações

Obter múltiplos valores de configuração

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

Obter organização por ID

Obter um único recurso pelo seu identificador.

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

Atualizar organização

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Aprovisionar novos espaços de trabalho a partir da sua automação de onboarding.
Sincronizar alterações de endereço da empresa para manter faturas e registos de conformidade precisos.

Campos do esquema

OrganizationAddress-organization_address.read
Campo Tipo Descrição
id string Campo id.
organization string | null Campo organization.
type string Campo type.
name string Campo name.
street string Campo street.
city string Campo city.
postCode string Campo postCode.
country string Campo country.
email string | null Campo email.
tin string | null Campo tin.
tinCountry string | null Campo tinCountry.

Visão geral da entidade

Localização

Gerir localizações físicas utilizadas para atribuição de colaboradores, agendamento e rastreio de ativos.

Endpoints

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

Listar localizações

Obtém a coleção de recursos Location.

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

Criar localização

Cria um recurso Location.

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

Obter localização por ID

Obter um único recurso pelo seu identificador.

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

Atualizar localização

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Registar escritórios a partir do seu sistema de instalações.
Atribuir colaboradores a localizações para relatórios de trabalho híbrido.

Campos do esquema

Location-location.read
Campo Tipo Descrição
id integer Campo id.
name string Campo name.
officeOpenHour integer | null Campo officeOpenHour.
officeCloseHour integer | null Campo officeCloseHour.

Visão geral da entidade

País

Consultar países suportados utilizados para endereços, regras fiscais e configuração regional.

Endpoints

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

Listar países

Obtém a coleção de recursos Country.

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

Obter país por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Consultar códigos de país para validação de endereços.
Verificar países suportados antes de aprovisionar definições regionais.

Campos do esquema

Country-country.read
Campo Tipo Descrição
id string Campo id.

Visão geral da entidade

Idioma

Consultar e configurar idiomas disponíveis para configuração de espaços de trabalho multilingues.

Endpoints

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

Listar idiomas

Obtém a coleção de recursos Language.

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

Criar idioma

Cria um recurso Language.

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

Obter idioma por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Detetar idiomas disponíveis antes de gerar documentos localizados.
Adicionar suporte de novos idiomas para equipas multirregionais.

Campos do esquema

Language-language.read
Campo Tipo Descrição
id string Campo id.

Visão geral da entidade

Integração

Gerir ligações ao Google Workspace, Microsoft Teams, Kontomatik e outros serviços externos.

Endpoints

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

Criar inscrição

Cria um recurso MicrosoftTeamsEnrollInput.

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

Listar Google Workspace

Obtém um recurso GoogleWorkspaceIntegrationStatusOutput.

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

Criar extração

Cria um recurso Integration.

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

Criar revogação

Cria um recurso Integration.

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

Criar configuração

Cria um recurso Integration.

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

Listar requisitos

Obtém um recurso IntegrationRequirementsOutput.

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

Listar requisitos

Obtém um recurso IntegrationRequirementsOutput.

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

Listar Kontomatik

Obtém um recurso KontomatikIntegrationStatusOutput.

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

Criar inscrição

Cria um recurso MicrosoftTeamsEnrollInput.

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

Listar Microsoft Teams

Obtém um recurso MicrosoftTeamsIntegrationStatusOutput.

Casos de uso

Verificar o estado de saúde da integração a partir do seu sistema de monitorização.
Inscrever novas integrações programaticamente durante a configuração do espaço de trabalho.

Campos do esquema

IntegrationRequirementsOutput-integration_requirements.read
Campo Tipo Descrição
tenantIdLabel string Campo tenantIdLabel.
tenantIdPlaceholder string | null Campo tenantIdPlaceholder.
clientIdRequired boolean Campo clientIdRequired.
scopes array Campo scopes.

Visão geral da entidade

Reunião

Criar e acompanhar reuniões associadas a colaboradores, projetos ou clientes.

Endpoints

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

Listar reuniões

Obtém a coleção de recursos Meeting.

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

Criar reunião

Cria um recurso Meeting.

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

Obter reunião por ID

Obter um único recurso pelo seu identificador.

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

Atualizar reunião

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Sincronizar eventos de calendário do Google/Outlook como registos de reunião do Flowtly.
Acompanhar a frequência de reuniões por cliente para avaliação da saúde do relacionamento.

Campos do esquema

Meeting-meeting.read
Campo Tipo Descrição
id string Campo id.
status string Campo status.
employee string | null Campo employee.
dateFrom string Campo dateFrom.
dateTo string Campo dateTo.
notes string | null Campo notes.
time string | null Campo time.

Visão geral da entidade

Subscrição

Consultar estado da subscrição, detalhes do plano e disponibilidade de funcionalidades para o seu espaço de trabalho.

Endpoints

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

Listar subscrições

Obtém a coleção de recursos Subscription.

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

Criar subscrição

Cria um recurso Subscription.

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

Criar aplicação de cupão

Cria um recurso Subscription.

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

Criar limpeza de cupão

Cria um recurso Subscription.

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

Obter subscrição por ID

Obter um único recurso pelo seu identificador.

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

Cria um recurso Subscription.

Cria um recurso Subscription.

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

Obter subscrição por ID

Obter um único recurso pelo seu identificador.

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

Listar catálogo

Obtém a coleção de recursos SubscriptionCatalogProductOutput.

Casos de uso

Verificar o nível de subscrição antes de ativar funcionalidades premium na sua integração.
Monitorizar o estado da subscrição para automação de gestão de licenças.

Campos do esquema

Subscription-subscription.read_organization_address.read
Campo Tipo Descrição
id string Campo id.
organization string Campo organization.
organizationAddress object Campo organizationAddress.
type string Campo type.
paymentMethod string | null Campo paymentMethod.
products array Campo products.
seats integer Campo seats.
modules array Campo modules.
status string Campo status.
metadata array Campo metadata.
Whatsapp