Skip to main content
GET
/
v0
/
sector
Public List Sectors
curl --request GET \
  --url https://public-api.salu.com.vc/prd/routes/v0/sector/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
[
  "3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "is_active": true,
      "description": "<string>",
      "address": "<string>",
      "address_number": "<string>",
      "address_detail": "<string>",
      "zip_code": "<string>",
      "neighborhood": "<string>",
      "state": "<string>",
      "city": "<string>",
      "hr_code": "<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 setores (Sector). A resposta utiliza o schema PublicApiSectorBaseResponse em forma de lista.

Visão Geral

  • Método: GET
  • Path: /v0/sector/
  • OperationId: public_list_sectors_v0_sector__get
  • Autenticação: header x-api-key (APIKeyHeader no OpenAPI)

Exemplo de requisição

curl -X GET "https://public-api.salu.com.vc/dev/routes/v0/sector/" \
  -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:desc
page
integer
default:0
limit
integer
default:20
organization_id
string<uuid>[] | null
name
string | null
soc_code
string | null
position_id
string<uuid> | null
hr_code
string | null
client_integration_code
string | null
customer_id
string<uuid>[] | null

Body

application/json

Response

Successful Response

data
PublicApiSectorBaseResponse · object[]
required
cursor
PaginateCursor · object
required