API de Auth

Verificação de conectividade e identidade

3 endpoints · base https://api.comando.one/v1 · autenticação por chave cmd_live_…

GET/companies

Listar empresas acessíveis pela chave

Lista as empresas que a chave pode acessar. Keys single-company retornam apenas a sua; keys multi-empresa retornam todas as permitidas. Use o id em **X-Company-Id** para escolher o tenant de cada request.

Parâmetros, corpo, resposta e exemplo

Resposta 200 — Empresas acessíveis

`id`	string (uuid)
`name`	string
`trade_name`	string \| null
`document`	string \| null	CNPJ/CPF
`active`	boolean
`is_default`	boolean	Empresa padrão da chave (usada quando X-Company-Id é omitido)

Exemplo

curl -X GET "https://api.comando.one/v1/companies" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/companies/{id}

Obter empresa acessível

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Empresa

`id`	string (uuid)
`name`	string
`trade_name`	string \| null
`document`	string \| null	CNPJ/CPF
`active`	boolean
`is_default`	boolean	Empresa padrão da chave (usada quando X-Company-Id é omitido)

Exemplo

curl -X GET "https://api.comando.one/v1/companies/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

GET/me

Verificar conectividade, plano e uso da conta

Retorna os dados da empresa, da chave autenticada e o `plan`: plano da conta de faturamento e o uso de cada franquia no mês (a franquia é da CONTA, somada entre as empresas dela). Consulte antes de criar em lote para não esbarrar no 402 `limite_do_plano`. `plan` é null enquanto o plano não puder ser lido. Não exige scope específico — qualquer chave válida funciona.

Parâmetros, corpo, resposta e exemplo

Resposta 200 — Empresa e chave autenticada

`company`	object
`api_key`	object
`plan`	object \| null	Plano e uso da conta de faturamento. null se o plano não puder ser lido.

Exemplo

curl -X GET "https://api.comando.one/v1/me" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

Início rápido, autenticação, SDK, servidor MCP e o playground para testar sem escrever código estão na documentação completa. A especificação em OpenAPI está em api.comando.one/openapi.json.

Outros recursos da API

Clientes (16)Contratos (13)Faturas (12)Webhooks (12)Serviços (9)Split de Pagamentos (9)Catálogos (7)Propostas (6)

Ou deixe a IA usar a API por você

O servidor MCP expõe estes mesmos recursos ao ChatGPT, Claude ou Gemini — com OAuth, sem chave de API.

Conectar um assistente