API FlashAPI FlashAPI Flash
  • Guias
  • Especificação de API
Geral
Empresas
Colaboradores
Candidatos
Beneficios
    Realizar um pedido de benefícioListar Benefícios de uma empresa
Cartão Corporativo
Cargos
Centros de custo
Controle de jornada
Departamentos
Despesas
Férias
Pagamentos
powered by Zudoku
Beneficios

​Listar Benefícios de uma empresa

A integração via API é uma das soluções que a Flash oferece para que as empresas possam conectar-se à nossa plataforma e listar os benefícios da empresa de forma eficiente.

​Busca de Benefícios

O objetivo deste fluxo é trazer os benefícios cadastrados de uma empresa, sendo possivel filtrar também por nome e/ou status dos benefícios. Caso nenhum filtro seja aplicado todos os beneficios (ativos ou não) retornarão da busca.

​Busca de Benefícios por status

Os benefícios possuem dois possíveis status: active (benefício ativo) e inactive (benefício desativado). Para realizar a busca dos benefícios com filtro de status é necessário adicionar &status=active à url.

​Busca de Benefícios por nome

A busca dos benefícios com filtro por nome pode ser aplicado com nomes exatos ou parte do nome do benefício. Para adicionar o filtro à busca é necessário adicionar &name=home à url.

​Busca de Benefícios por nome e status

A busca dos benefícios com filtro por nome e status pode ser aplicado com nomes exatos ou parte do nome do benefício e os possíveis status dos benefícios, sendo: active (benefício ativo) e inactive (benefício desativado). Para adicionar o filtro à busca é necessário adicionar &name=home&status=active à url.


Realizar um pedido de benefícioCriar Pedido em Aberto
On this page
  • Busca de Benefícios
  • Busca de Benefícios por status
  • Busca de Benefícios por nome
  • Busca de Benefícios por nome e status