API FlashAPI FlashAPI Flash
  • Guias
  • Especificação de API
Geral
Empresas
Colaboradores
Candidatos
    Criação de um CandidatoListar Candidatos
Beneficios
Cartão Corporativo
Cargos
Centros de custo
Controle de jornada
Departamentos
Grupos
PII
Despesas
Férias
Pagamentos
powered by Zudoku
Candidatos

​Listar Candidatos

Este endpoint permite buscar candidatos pertencentes ao grupo econômico de sua empresa.

URL: /candidates
Método: GET
Descrição: Busca por candidatos pertencentes ao grupo econômico. Busca com multiplos valores devem ser feitas através de valores separados por vírgula.
Ex.: /candidates?candidateIds=123,321,456

Headers:

  • x-flash-auth: <chave_api>

Parâmetros de Rota:

  • candidateIds - Busca por candidatos que tenham esses IDs
  • name - Busca por candidatos com esse nome
  • cnpj - Filtra por candidatos com o CNPJ exato
  • nationality - Filtra candidatos por nacionalidade
  • documentNumber - Filtra pelo CPF exato do candidato
  • managerId - Filtra pelo ID de colaborador do lider de candidatos
  • email - Filtra pelo email exato do candidato exato
  • phone - Filtra pelo número de celular exato do candidato
  • companyId - Filtra pelo ID da empresa
  • page - Página da resposta (Se não informado, o valor é 1)
  • pageSize - Número de candidatos por página (Se não informado, o valor é 10)

Criação de um CandidatoPedidos de Benefícios