Buscar colaborador por ID

GET /api/v1/valepix/employees/{employee_id}

Consulta os dados de um colaborador específico.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json

Path params

Parâmetro	Tipo	Obrigatório	Descrição
employee_id	string	Sim	Identificador do colaborador retornado pela API

Query params

Esta rota não possui query params documentados.

Exemplo curl

curl --request GET \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json" \
  --url "https://routes.valepix.com.br/api/v1/valepix/employees/$EMPLOYEE_ID"

Response

{
  "success": "success",
  "data": {
    "employee": {
      "id": "00000000-0000-4000-8000-000000000001",
      "name": "Maria Exemplo Santos",
      "document": "***",
      "email": "maria.exemplo@empresa.test",
      "phone": "***",
      "birth_date": "1990-05-20T00:00:00.000Z",
      "benefit": {
        "id": "00000000-0000-4000-8000-000000000030",
        "name": "Benefício Exemplo",
        "description": "Plano exemplo"
      },
      "cbo": "4110-05",
      "situation": "active",
      "admission_date": "2024-02-01T00:00:00.000Z",
      "status": "active",
      "has_account": false
    }
  }
}

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	Identificador inválido	Conferir employee_id
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
404	Colaborador não encontrado	Conferir employee_id
500	Erro interno temporário	Tentar novamente com backoff