Skip to main content
GET
/
v0
/
branch
List Branches
curl --request GET \
  --url https://public-api.salu.com.vc/dev/routes/v0/branch/ \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "display_name": "<string>",
      "company_name": "<string>",
      "cnpj": "<string>",
      "is_active": true,
      "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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.salu.com.vc/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns a list of branches. The response is an array of PublicApiBranchBaseResponse.

​
Overview

  • Method: GET
  • Path: /v0/branch/
  • OperationId: public_list_branches_v0_branch__get
  • Authentication: header x-api-key (APIKeyHeader in the OpenAPI)

​
Fields

  1. cnpj — Company / Branch identifier A CNPJ (Cadastro Nacional da Pessoa Jurídica) is the tax ID for a legal entity (company). A single company group may have multiple CNPJs, because each branch/worksite can have its own legal registration (branch-specific CNPJ). In our model, the Branch is identified by cnpj because that defines the legal employer entity responsible for compliance.

​
Example Request

curl -X GET "https://public-api.salu.com.vc/dev/routes/v0/branch/?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
​
organization_id
string<uuid>[] | null
​
display_name
string | null
​
branch_id
string<uuid>[] | null
​
cnpj
string | null
​
hr_code
string | null
​
client_integration_code
string | null

Response

Successful Response

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