Skip to main content
GET
Public List Branches
Este endpoint retorna uma lista de filiais (Branch). A resposta utiliza o schema PublicApiBranchBaseResponse em forma de lista.

Visão Geral

  • Método: GET
  • Path: /v0/branch/
  • OperationId: public_list_branches_v0_branch__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

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
updated_after
string<date-time> | null

Response

Successful Response

data
PublicApiBranchBaseResponse · object[]
required
cursor
PaginateCursor · object | null
required