v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
employees

Rota utilizada para buscar colaboradores da empresa.

get/v1/employees

Query parameters

emailstring

Filtro para buscar colaboradores da empresa por e-mail. Pode ser inserido parte do e-mail para realizar a busca (mínimo 3 caracteres)

taxpayerRegistrystring

Filtro para buscar colaboradores da empresa por CPF. Pode ser inserido parte do CPF para realizar a busca (mínimo 3 dígitos)

maxPageSizenumber

Quantidade máxima de registros que podem ser retornados por página (até 100 registros)

pageTokenstring

Token utilizado para acessar a próxima página de colaboradores

fieldsstring
  Campo para definir quais atributos serão retornados na resposta.

  Campos da conta (account):
  • *account - Retorna todos os campos da conta
  • id - identificador único da conta
  • firstName - Nome do colaborador
  • lastName - Sobrenome do colaborador
  • email - Endereço de e-mail do colaborador
  • taxpayerRegistry - CPF do colaborador
  • mobileNumber - Telefone do colaborador
  • createdAt - Data de criação da conta do colaborador

  Campos de atributos (attributes):
  • *attributes - Retorna todos os atributos
  • attributes.admissionDate - Data de admissão
• attributes.terminationDate - Data de desligamento
• attributes.terminationReason - Motivo do desligamento
• attributes.birthDate - Data de nascimento
• attributes.photo - Foto
• attributes.biologicalSex - Sexo
• attributes.education - Escolaridade
• attributes.language - Idiomas
• attributes.linkedinUrl - URL do LinkedIn
• attributes.streetAddress - Rua
• attributes.cityAddress - Cidade
• attributes.stateAddress - Estado
• attributes.zipCodeAddress - CEP
• attributes.neighborhoodAddress - Bairro

  Campos de soluções (solutions):
  • *solutions - Retorna todas as soluções que o colaborador tem acesso
  • solutions.recruitmentAndSelection - Indica se o colaborador tem acesso à solução de Recrutamento e Seleção
  • solutions.admission - Indica se o colaborador tem acesso à solução de Admissão
  • solutions.training - Indica se o colaborador tem acesso à solução de Educação Corporativa
  • solutions.engagement - Indica se o colaborador tem acesso à solução de Clima & Engajamento
  • solutions.performance - Indica se o colaborador tem acesso à solução de Performance
  • solutions.admin - Indica se o colaborador tem acesso ao ecossistema admistrativo
  

Response

Busca de colaboradores da empresa realizada com sucesso.

nextPageTokenstring

Token para buscar a próxima página de colaboradores