RH e pessoas – 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.

RH e pessoas

Perfis de colaboradores, departamentos, cargos, benefícios e estrutura organizacional.

Visão geral da entidade

Colaborador

Criar e gerir colaboradores para atribuições, aprovações e controlo de acesso.

Endpoints

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

Listar colaboradores

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

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

Criar colaborador

Cria um recurso Employee.

GET https://api.flowtly.eu/employees/me

Listar eu

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

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

Listar pré-visualização

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

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

Listar pesquisa

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

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

Obter colaborador por ID

Obter um único recurso pelo seu identificador.

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

Eliminar colaborador

Eliminar o recurso.

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

Atualizar colaborador

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/employees/{id}/documents

Obter colaborador por ID

Obter um único recurso pelo seu identificador.

GET https://api.flowtly.eu/employees/{id}/feedback-suggestion

Obter colaborador por ID

Obter um único recurso pelo seu identificador.

GET https://api.flowtly.eu/employees/{id}/project-rates

Obter colaborador por ID

Obter um único recurso pelo seu identificador.

POST https://api.flowtly.eu/employees/{id}/user

Cria um recurso Employee.

Cria um recurso Employee.

DELETE https://api.flowtly.eu/employees/{id}/user

Eliminar colaborador

Eliminar o recurso.

GET https://api.flowtly.eu/employees/{id}/working-hours-stats/{date}

Obter colaborador por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Aprovisionar novos contratados a partir do seu HRIS para que apareçam no Flowtly no primeiro dia.
Sincronizar alterações no organograma para manter as equipas de projeto e as cadeias de aprovação atualizadas.

Campos do esquema

Employee-employee.read_employee.detail
Campo Tipo Descrição
id integer Campo id.
userId integer Campo userId.
companyEmail string Campo companyEmail.
contactEmail string Campo contactEmail.
contactPhone string Campo contactPhone.
birthday string Campo birthday.
firstname string Campo firstname.
lastname string Campo lastname.
roles array Campo roles.
phoneTextAllowed boolean Campo phoneTextAllowed.
department string Campo department.
reportsTo string Campo reportsTo.
directReports array Campo directReports.
departments array Campo departments.
activeAgreement string Campo activeAgreement.

Visão geral da entidade

Departamento

Gerir a hierarquia de departamentos para orientar o controlo de acesso, a alocação de orçamento e os relatórios de headcount.

Endpoints

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

Listar departamentos

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

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

Criar departamento

Cria um recurso Department.

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

Obter departamento por ID

Obter um único recurso pelo seu identificador.

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

Atualizar departamento

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Espelhar a árvore de departamentos do seu HRIS no Flowtly para relatórios organizacionais unificados.
Criar departamentos para segmentar dashboards de orçamento e utilização.

Campos do esquema

Department-department.read_employee.preview
Campo Tipo Descrição
id integer Campo id.
name string Campo name.
code string | null Campo code.
manager object Campo manager.

Visão geral da entidade

Cargo

Definir cargos normalizados para orientar a atribuição por função, modelos de acordo e planeamento de headcount.

Endpoints

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

Listar cargos

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

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

Criar cargo

Cria um recurso Position.

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

Obter cargo por ID

Obter um único recurso pelo seu identificador.

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

Eliminar cargo

Eliminar o recurso.

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

Atualizar cargo

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Sincronizar vagas em aberto do seu ATS para acompanhar o pipeline de contratação no Flowtly.
Mapear cargos para tarifas de custo para cálculos automatizados de rentabilidade de projetos.

Campos do esquema

Position-position.read_responsibility.read
Campo Tipo Descrição
id string Campo id.
name string Campo name.
roles array Campo roles.
responsibilities object Campo responsibilities.

Visão geral da entidade

Benefício

Gerir o catálogo de benefícios, preços e inscrição por colaborador para manter os dados de remuneração de RH sincronizados.

Endpoints

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

Listar benefícios

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

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

Criar benefício

Cria um recurso EmployeeBenefit.

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

Obter benefício por ID

Obter um único recurso pelo seu identificador.

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

Atualizar benefício

Atualizar campos do recurso utilizando JSON Merge Patch.

POST https://api.flowtly.eu/benefit-prices

Criar benefício

Cria um recurso EmployeeBenefit.

GET https://api.flowtly.eu/benefit-prices/{id}

Obter benefício por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/benefit-prices/{id}

Eliminar benefício

Eliminar o recurso.

PATCH https://api.flowtly.eu/benefit-prices/{id}

Atualizar benefício

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/employee-benefits

Listar benefícios

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

POST https://api.flowtly.eu/employee-benefits

Criar benefício

Cria um recurso EmployeeBenefit.

GET https://api.flowtly.eu/employee-benefits/{id}

Obter benefício por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/employee-benefits/{id}

Atualizar benefício

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Importar planos de benefícios do seu corretor e inscrever automaticamente colaboradores elegíveis.
Acompanhar custos de benefícios por colaborador para relatórios de remuneração total.

Campos do esquema

BenefitPrice-benefit.read_benefit_price.read
Campo Tipo Descrição
id integer Campo id.
validFrom string Campo validFrom.
validTo string | null Campo validTo.
price number Campo price.
taxPercent number Campo taxPercent.
defaultCompanyCoverageAmount number Campo defaultCompanyCoverageAmount.

Visão geral da entidade

Nota de colaborador

Armazenar e obter notas de RH para avaliações de desempenho, estado de integração e memorandos internos.

Endpoints

GET https://api.flowtly.eu/employee-notes

Listar notas de colaboradores

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

POST https://api.flowtly.eu/employee-notes

Criar nota de colaborador

Cria um recurso EmployeeNote.

GET https://api.flowtly.eu/employee-notes/{id}

Obter nota de colaborador por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/employee-notes/{id}

Eliminar nota de colaborador

Eliminar o recurso.

PATCH https://api.flowtly.eu/employee-notes/{id}

Atualizar nota de colaborador

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Enviar feedback de gestores da sua ferramenta de reuniões 1:1 para registos de colaboradores do Flowtly.
Associar notas de conformidade ou de verificação de antecedentes a perfis de colaboradores.

Campos do esquema

EmployeeNote-employee_note.read
Campo Tipo Descrição
id string Campo id.
employee string Campo employee.
author string Campo author.
note string Campo note.
createdAt string Campo createdAt.

Visão geral da entidade

Saúde e segurança de colaborador

Acompanhar certificações obrigatórias de formação em SST (BHP), datas de validade e estado de conformidade.

Endpoints

GET https://api.flowtly.eu/employee-bhps

Listar saúde e segurança de colaboradores

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

POST https://api.flowtly.eu/employee-bhps

Criar saúde e segurança de colaborador

Cria um recurso EmployeeBhp.

GET https://api.flowtly.eu/employee-bhps/{id}

Obter saúde e segurança de colaborador por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/employee-bhps/{id}

Atualizar saúde e segurança de colaborador

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Sincronizar conclusões de formação em segurança do seu LMS para o Flowtly.
Alertar gestores quando a certificação de SST de um colaborador estiver prestes a expirar.

Campos do esquema

EmployeeBhp-employee_bhp.read
Campo Tipo Descrição
id integer Campo id.
employee string | null Campo employee.
dateFrom string Campo dateFrom.
dateTo string | null Campo dateTo.
note string | null Campo note.

Visão geral da entidade

Responsabilidade

Definir responsabilidades, agrupá-las e atribuí-las a colaboradores ou cargos para responsabilização estruturada.

Endpoints

GET https://api.flowtly.eu/position-responsibilities

Listar responsabilidades

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

POST https://api.flowtly.eu/position-responsibilities

Criar responsabilidade

Cria um recurso ResponsibilityGroup.

GET https://api.flowtly.eu/position-responsibilities/{id}

Obter responsabilidade por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/position-responsibilities/{id}

Eliminar responsabilidade

Eliminar o recurso.

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

Listar responsabilidades

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

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

Criar responsabilidade

Cria um recurso ResponsibilityGroup.

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

Obter responsabilidade por ID

Obter um único recurso pelo seu identificador.

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

Atualizar responsabilidade

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/responsibility-employees

Listar responsabilidades

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

POST https://api.flowtly.eu/responsibility-employees

Criar responsabilidade

Cria um recurso ResponsibilityGroup.

GET https://api.flowtly.eu/responsibility-employees/{id}

Obter responsabilidade por ID

Obter um único recurso pelo seu identificador.

DELETE https://api.flowtly.eu/responsibility-employees/{id}

Eliminar responsabilidade

Eliminar o recurso.

PATCH https://api.flowtly.eu/responsibility-employees/{id}

Atualizar responsabilidade

Atualizar campos do recurso utilizando JSON Merge Patch.

GET https://api.flowtly.eu/responsibility-groups

Listar responsabilidades

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

POST https://api.flowtly.eu/responsibility-groups

Criar responsabilidade

Cria um recurso ResponsibilityGroup.

GET https://api.flowtly.eu/responsibility-groups/{id}

Obter responsabilidade por ID

Obter um único recurso pelo seu identificador.

PATCH https://api.flowtly.eu/responsibility-groups/{id}

Atualizar responsabilidade

Atualizar campos do recurso utilizando JSON Merge Patch.

Casos de uso

Mapear obrigações de conformidade a funções para que as ferramentas de auditoria possam verificar a cobertura.
Construir uma matriz RACI sincronizando responsabilidades com a sua ferramenta de gestão de projetos.

Campos do esquema

Responsibility-responsibility.read_responsibility_employee.read
Campo Tipo Descrição
id integer Campo id.
parent object Campo parent.
responsibilityGroup string Campo responsibilityGroup.
name string Campo name.
description string Campo description.
children array Campo children.
responsibilityEmployees array Campo responsibilityEmployees.

Visão geral da entidade

Feedback

Recolher, gerir e consultar feedback de pares e gestores para ciclos de avaliação de desempenho.

Endpoints

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

Listar feedbacks

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

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

Criar feedback

Cria um recurso FeedbackRequest.

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

Obter feedback por ID

Obter um único recurso pelo seu identificador.

GET https://api.flowtly.eu/feedback-requests

Listar feedbacks

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

POST https://api.flowtly.eu/feedback-requests

Criar feedback

Cria um recurso FeedbackRequest.

GET https://api.flowtly.eu/feedback-requests/{id}

Obter feedback por ID

Obter um único recurso pelo seu identificador.

Casos de uso

Acionar pedidos de feedback a partir da sua plataforma de gestão de desempenho.
Obter pontuações de feedback agregadas para dashboards de talento.

Campos do esquema

Feedback-feedback.read
Campo Tipo Descrição
id string Campo id.
employee string | null Campo employee.
authorEmployee string | null Campo authorEmployee.
description string Campo description.
details string | null Campo details.
visibility string Campo visibility.
rate string Campo rate.
createdAt string Campo createdAt.

Visão geral da entidade

Utilizador da organização

Gerir quem tem acesso ao espaço de trabalho do Flowtly, enviar convites e remover utilizadores.

Endpoints

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

Listar utilizadores da organização

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

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

Eliminar utilizador da organização

Eliminar o recurso.

GET https://api.flowtly.eu/organization-user-invitations

Listar utilizadores da organização

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

POST https://api.flowtly.eu/organization-user-invitations/{id}/accept

Cria um recurso OrganizationUserInvitation.

Cria um recurso OrganizationUserInvitation.

POST https://api.flowtly.eu/organization-user-invitations/{id}/reject

Cria um recurso OrganizationUserInvitation.

Cria um recurso OrganizationUserInvitation.

Casos de uso

Convidar automaticamente novos contratados quando são aprovisionados no seu fornecedor de identidade.
Revogar acesso quando os colaboradores são desligados do seu HRIS.

Campos do esquema

OrganizationUser-organization_user.read_user.read
Campo Tipo Descrição
id string Campo id.
user object Campo user.
type string Campo type.
Whatsapp