Skip to main content
GET
/
v0
/
employee
List Employees
curl --request GET \
  --url https://public-api.salu.com.vc/dev/routes/v0/employee/ \
  --header 'x-api-key: <api-key>'
{
  "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>",
      "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
  }
}
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)

​
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írgula
  • order_dir (padrão: asc,desc) — direções correspondem aos campos em order_by
  • is_active (padrão: true)
  • is_disabled (opcional)
  • name, gov_id (CPF), email
  • status[] (lista de valores permitidos pelo schema StatusEnumFilter)
  • position_id, sector_id (UUID)
  • branch_id[], organization_id[], id[] (listas de UUID)
  • birth_date, admission_date, dismissal_date (formato YYYY-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 como ACTIVE.
  • 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_by e order_dir sã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_id devem ser UUIDs válidos; caso contrário, a API pode retornar 400 Bad Request.
  • Paginação: combine page e limit para 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

​
x-api-key
string
header
required

Query Parameters

​
is_active
default:true
​
order_by
string
default:name,status
​
order_dir
string
default:asc,desc
​
page
integer
default:0
​
limit
integer
default:20
​
name
string | null
​
gov_id
string | null
​
email
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
​
organization_id
string<uuid>[] | null
​
id
string<uuid>[] | null
​
birth_date
string<date> | null
​
admission_date
string<date> | null
​
dismissal_date
string<date> | null
​
client_integration_code
string | null
​
is_disabled
boolean | null

Response

Successful Response

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