Skip to main content
GET
Public Get Branch
This endpoint returns details for a branch. The response uses the PublicApiBranchBaseResponse schema.

Overview

  • Method: GET
  • Path: /v0/branch/{branch_id}
  • OperationId: public_get_branch_v0_branch__branch_id__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

Authorizations

x-api-key
string
header
required

Path Parameters

branch_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
display_name
string
required
company_name
string
required
cnpj
string
required
is_active
boolean
required
address
string | null
address_number
string | null
address_detail
string | null
zip_code
string | null
neighborhood
string | null
state
string | null
city
string | null
hr_code
string | null
client_integration_code
string | null