Skip to main content
GET
/
v0
/
employee
Public List Employees
curl --request GET \
  --url https://public-api.salu.com.vc/prd/routes/v0/employee/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "soc_code": [
    "<string>"
  ],
  "organization_id": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": [
    {
      "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>"
    }
  ],
  "cursor": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": true
  }
}
Este endpoint retorna uma lista de funcionários (Employee). A resposta utiliza o schema PublicApiEmployeeBaseResponse em forma de lista.

​
Visão Geral

  • Método: GET
  • Path: /v0/employee/
  • OperationId: public_list_employees_v0_employee__get
  • Autenticação: header x-api-key (APIKeyHeader no OpenAPI)
curl -X GET "https://public-api.salu.com.vc/dev/routes/v0/employee/?page=0&limit=20" \
  -H "Accept: application/json" \
  -H "x-api-key: $SALU_PUBLIC_API_KEY"

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
is_active
boolean | null
​
order_by
string
default:created_at
​
order_dir
string
default:asc
​
page
integer
default:0
​
limit
integer
default:20
​
address
string | null
​
display_name
string | null
​
id
string<uuid>[] | null
​
cnpj
string | null
​
hr_code
string | null
​
client_integration_code
string | null
​
status
enum<string>[] | null
Available options:
Ativo,
Inativo,
Afastado,
Férias,
Pendente
​
position_id
string<uuid> | null
​
sector_id
string<uuid> | null
​
branch_id
string<uuid>[] | null

Body

application/json
​
soc_code
string[] | null
​
organization_id
string<uuid>[] | null

Response

Successful Response

​
data
PublicApiEmployeeBaseResponse · object[]
required
​
cursor
PaginateCursor · object
required