Public List Employees
curl --request GET \
--url https://public-api.salu.com.vc/dev/routes/v0/employee/ \
--header 'x-api-key: <api-key>'import requests
url = "https://public-api.salu.com.vc/dev/routes/v0/employee/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://public-api.salu.com.vc/dev/routes/v0/employee/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.salu.com.vc/dev/routes/v0/employee/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://public-api.salu.com.vc/dev/routes/v0/employee/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public-api.salu.com.vc/dev/routes/v0/employee/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.salu.com.vc/dev/routes/v0/employee/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>",
"preferred_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>"
}
}
],
"cursor": {
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"next_page": true
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Employees
List Employees
GET
/
v0
/
employee
/
Public List Employees
curl --request GET \
--url https://public-api.salu.com.vc/dev/routes/v0/employee/ \
--header 'x-api-key: <api-key>'import requests
url = "https://public-api.salu.com.vc/dev/routes/v0/employee/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://public-api.salu.com.vc/dev/routes/v0/employee/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.salu.com.vc/dev/routes/v0/employee/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://public-api.salu.com.vc/dev/routes/v0/employee/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public-api.salu.com.vc/dev/routes/v0/employee/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.salu.com.vc/dev/routes/v0/employee/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>",
"preferred_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>"
}
}
],
"cursor": {
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"next_page": true
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}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(APIKeyHeaderno OpenAPI)
Parâmetros de consulta (principais)
page(padrão:0)limit(padrão:20)order_by(padrão:name,status) — aceita múltiplos campos separados por vírgulaorder_dir(padrão:asc,desc) — direções correspondem aos campos emorder_byis_active(padrão:true)is_disabled(opcional)name,gov_id(CPF),emailstatus[](lista de valores permitidos pelo schemaStatusEnumFilter)position_id,sector_id(UUID)branch_id[],organization_id[],id[](listas de UUID)birth_date,admission_date,dismissal_date(formatoYYYY-MM-DD)client_integration_code(opcional)
Dicas e cuidados
- Filtro de status: a API espera os valores de enum em português em
status[](ex.:Ativo,Pendente). Não envie palavras em inglês comoACTIVE. - Múltiplos valores: você pode repetir o parâmetro para enviar mais de um valor (ex.:
&status=Ativo&status=Pendente) ou usar a notação de array conforme seu cliente HTTP. - Ordenação:
order_byeorder_dirsão posicionais — a primeira direção corresponde ao primeiro campo, e assim por diante. Se enviar apenas uma direção, ela vale para todos os campos listados. - UUIDs: campos como
id,branch_id,sector_id,organization_iddevem ser UUIDs válidos; caso contrário, a API pode retornar400 Bad Request. - Paginação: combine
pageelimitpara controlar a janela de resultados; os padrões estão acima.
Exemplo de requisição
curl -X GET "https://public-api.salu.com.vc/dev/routes/v0/employee/?page=0&limit=20&order_by=name,status&order_dir=asc,desc&is_active=true&name=Maria&branch_id=11111111-1111-1111-1111-111111111111&status=ACTIVE&status=PENDING" \
-H "Accept: application/json" \
-H "x-api-key: $SALU_PUBLIC_API_KEY"
Authorizations
Query Parameters
Required range:
x >= 0Required range:
x >= 1Available options:
Ativo, Inativo, Afastado, Férias, Pendente