v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB

employees

Rota utilizada para buscar um colaborador através de seu ID.

get/v1/employees/{id}

Path parameters

idstring required

Example:f47ac10b-58cc-4372-a567-0e02b2c3d479

The ID of the employee account

Query parameters

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 colaborador da empresa realizada com sucesso.

Example response

{
  "account": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "centralCompanyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "firstName": "John",
    "lastName": "Doe",
    "email": "gupy@gupy.com.br",
    "taxpayerRegistry": "12345678909",
    "mobileNumber": "+5511999999999",
    "internalNumber": "12345",
    "createdAt": "2021-06-01T00:00:00.000Z",
    "attributes": [
      {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "name": "taxpayerRegistry",
        "value": "12345678909",
        "optionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "optionName": "Option 1",
        "type": "text"
      }
    ]
  }
}