Skip to main content
GET
/
unidade-negocio
/
{unidadeNegocioId}
Coleta principais dados da unidade de negócio
curl --request GET \
  --url https://api.example.com/unidade-negocio/{unidadeNegocioId}
{
  "unidadeNegocioId": "1234567890",
  "nome": "Transportadora Brasil Ltda",
  "step": "DADOS",
  "status": "RASCUNHO",
  "tipoIdentificacao": "CNPJ",
  "numeroCadastro": "36.937.877/0001-08",
  "email": "unidade.go@tbrasil.com.br",
  "emailNotificacao": "unidade.go@tbrasil.com.br",
  "endereco": "<string>",
  "colaboradores": {
    "ativos": 10,
    "inativos": 2
  },
  "createdAt": "2026-05-11T13:08:52.937Z",
  "updatedAt": "2026-05-11T13:08:52.937Z",
  "logo": "//logo.png"
}

Path Parameters

​
unidadeNegocioId
string
required

ID da unidade de negócio

Response

Dados da unidade de negócio

​
unidadeNegocioId
string
required

ID da unidade de negócio

Example:

"1234567890"

​
nome
string
required

Nome da unidade de negócio

Example:

"Transportadora Brasil Ltda"

​
step
enum<string>
default:DADOS
required

Step de configuração

Available options:
DADOS,
CONTATO,
PERSONALIZACAO,
CONCLUIDO
​
status
enum<string>
default:RASCUNHO
required

Status da unidade de negócio

Available options:
ATIVO,
INATIVO,
RASCUNHO
​
tipoIdentificacao
enum<string>
default:CNPJ
required

Tipo de identificação

Available options:
CNPJ,
CPF
​
numeroCadastro
string
required

CPF ou CNPJ

Example:

"36.937.877/0001-08"

​
email
string
required

Email da unidade de negócio

Example:

"unidade.go@tbrasil.com.br"

​
emailNotificacao
string
required

Email de notificações da unidade de negócio

Example:

"unidade.go@tbrasil.com.br"

​
endereco
string
required

Endereço da unidade de negócio

​
colaboradores
object
required

Quantidade de colaboradores vinculados

​
createdAt
string<date-time>
required

Data de criação

Example:

"2026-05-11T13:08:52.937Z"

​
updatedAt
string<date-time>
required

Data do ultimo update

Example:

"2026-05-11T13:08:52.937Z"

Caminho da logo da unidade de negócio

Example:

"//logo.png"