Skip to main content
GET
Public Get Employee
Este endpoint retorna os dados de um funcionário (Employee). A resposta utiliza o schema PublicApiEmployeeBaseResponse.

Visão Geral

  • Método: GET
  • Path: /v0/employee/{employee_id}
  • OperationId: public_get_employee_v0_employee__employee_id__get
  • Autenticação: header x-api-key (APIKeyHeader no OpenAPI)
Observações de uso
  • Parâmetro de rota: employee_id deve ser um UUID válido. UUID inválido pode retornar 400 Bad Request.
  • Não encontrado: se o funcionário não existir (ou não pertencer à sua organização), a API pode retornar 404 Not Found.
  • Schema: a resposta segue PublicApiEmployeeBaseResponse (consulte o OpenAPI para a lista completa de campos e tipos).

Exemplo de requisição

Authorizations

x-api-key
string
header
required

Path Parameters

employee_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
name
string
required
is_disabled
boolean
required
status
string
required
sex
string
required
admission_date
string<date>
required
is_active
boolean
required
organization
SimpleEntity · object
required
branch
SimpleEntity · object
required
position
SimpleEntity · object
required
sector
SimpleEntity · object
required
social_name
string | null
gov_id
string | null
birth_date
string<date> | null
gender
string | null
mother_name
string | null
marital_status
string | null
place_of_birth
string | null
educational_stage
string | null
human_skin_tone
string | null
phone
string | null
cell_phone
string | null
email
string | null
personal_email
string | null
dismissal_date
string<date> | null
hr_code
string | null
employee_registration_number
string | null
work_shift
string | null
client_integration_code
string | null
address
Address · object | null