Skip to main content
GET
/
v0
/
employee
/
{employee_id}
Get Employee
curl --request GET \
  --url https://public-api.salu.com.vc/dev/routes/v0/employee/{employee_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_disabled": true,
  "status": "<string>",
  "sex": "<string>",
  "admission_date": "2023-12-25",
  "is_active": true,
  "organization": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "branch": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "position": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "sector": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "social_name": "<string>",
  "gov_id": "<string>",
  "birth_date": "2023-12-25",
  "gender": "<string>",
  "mother_name": "<string>",
  "marital_status": "<string>",
  "place_of_birth": "<string>",
  "educational_stage": "<string>",
  "human_skin_tone": "<string>",
  "phone": "<string>",
  "cell_phone": "<string>",
  "email": "<string>",
  "personal_email": "<string>",
  "dismissal_date": "2023-12-25",
  "hr_code": "<string>",
  "employee_registration_number": "<string>",
  "work_shift": "<string>",
  "client_integration_code": "<string>",
  "address": {
    "address": "<string>",
    "address_number": "<string>",
    "address_detail": "<string>",
    "zip_code": "<string>",
    "neighborhood": "<string>",
    "state": "<string>",
    "city": "<string>"
  }
}
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

curl -X GET "https://public-api.salu.com.vc/dev/routes/v0/employee/{employee_id}" \
  -H "Accept: application/json" \
  -H "x-api-key: $SALU_PUBLIC_API_KEY"

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