Buscar colaborador por ID

Este endpoint permite buscar os dados de um colaborador específico da empresa pelo seu identificador único.

Regras de negócio e validações

Campos obrigatórios

id: Identificador único da conta do colaborador.

Campos opcionais

fields: Campo para definir quais atributos serão retornados na resposta. Se não informado, todos os dados são retornados.

Seletor de campos (`fields`)

O parâmetro fields permite filtrar quais dados serão incluídos na resposta. Os campos são separados por vírgula.

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 Treinamento.
solutions.engagement: Indica se o colaborador tem acesso à solução de Engajamento.
solutions.performance: Indica se o colaborador tem acesso à solução de Performance.
solutions.admin: Indica se o colaborador tem acesso ao ecossistema administrativo.

Exemplos de uso do `fields`

Exemplo	Valor de `fields`	Descrição
Sem filtro	(vazio)	Retorna a conta completa com todos os atributos e soluções
Apenas dados de conta	`*account`	Retorna todos os campos da conta, sem atributos e soluções
Campos específicos da conta	`firstName,lastName,email`	Retorna apenas os campos solicitados da conta
Apenas atributos	`*attributes`	Retorna o identificador da conta com todos os atributos cadastrados
Apenas soluções	`*solutions`	Retorna o identificador da conta com todas as soluções
Dados específicos combinados	`firstName,lastName,attributes.admissionDate,attributes.biologicalSex,solutions.recruitmentAndSelection,solutions.performance`	Retorna apenas os campos solicitados de contas, atributos e soluções

Exemplo de requisição (cURL)

curl --request GET 'https://api.gupy.io/user-management/v1/employees/f47ac10b-58cc-4372-a567-0e02b2c3d479?fields=firstName,lastName,email,attributes.admissionDate,solutions.training' --header 'Authorization: Bearer bearer_token_value_here'

Exemplo de resposta (cURL)

{
  "account": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]"
  },
  "attributes": {
    "admissionDate": "2020-01-01"
  },
  "solutions": {
    "training": true
  }
}

Atenção: Forneça o token de autenticação no cabeçalho Authorization.

Possíveis erros

Colaborador não encontrado

Erro lançado quando o colaborador não foi encontrado através do id informado, ou o colaborador não pertence à empresa do token.

{
  "statusCode": 404,
  "timestamp": "2025-05-29T21:00:00.000Z",
  "path": "/v1/employees/f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "method": "GET",
  "title": "NotFoundException",
  "message": "Employee not found",
  "errors": [
    {
      "code": "EMPLOYEE_NOT_FOUND",
      "target": "NotFoundException",
      "message": "Employee not found"
    }
  ]
}

Colaborador não pertence à empresa

Erro lançado quando o colaborador encontrado não pertence à empresa vinculada ao token de autenticação.

{
  "statusCode": 400,
  "timestamp": "2025-05-29T21:00:00.000Z",
  "path": "/v1/employees/f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "method": "GET",
  "title": "BadRequestException",
  "message": "Employee does not belong to the company",
  "errors": [
    {
      "code": "EMPLOYEE_DOES_NOT_BELONG_TO_COMPANY",
      "target": "BadRequestException",
      "message": "Employee does not belong to the company"
    }
  ]
}

Não autenticado

Erro lançado quando o token de autenticação não é informado ou é inválido.

{
  "statusCode": 401,
  "timestamp": "2025-05-29T21:00:00.000Z",
  "path": "/v1/employees/f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "method": "GET",
  "title": "UnauthorizedException",
  "message": "Unauthorized"
}

Sem permissão

Erro lançado quando o token de autenticação não possui a permissão necessária (READ ou WRITE) para acessar o endpoint.

{
  "statusCode": 403,
  "timestamp": "2025-05-29T21:00:00.000Z",
  "path": "/v1/employees/f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "method": "GET",
  "title": "ForbiddenException",
  "message": "Forbidden"
}