Skip to main content
GET
Public Get Branch
Este endpoint retorna os dados de uma unidade (Branch). A resposta utiliza o schema PublicApiBranchBaseResponse.

Visão Geral

  • Método: GET
  • Path: /v0/branch/{branch_id}
  • OperationId: public_get_branch_v0_branch__branch_id__get
  • Autenticação: header x-api-key (APIKeyHeader no OpenAPI)

Campos

  1. cnpj — Identificador da Empresa / Filial A CNPJ (Cadastro Nacional da Pessoa Jurídica) é o identificador fiscal de uma entidade legal (empresa). Um único grupo de empresas pode ter vários CNPJs, pois cada filial/local de trabalho pode ter seu próprio registro legal (CNPJ específico da filial). Em nosso modelo, a Filial é identificada pelo CNPJ porque isso define a entidade empregadora legal responsável pela conformidade.

Exemplo de requisição

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