API de Serviços

Catálogo de serviços

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

GET/service-categories

Listar categorias de serviço

services:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

`page`(query)	integer	Número da página (default: 1)
`per_page`(query)	integer	Itens por página (default: 20, máx: 100)
`search`(query)	string	Filtro por nome (ilike)
`query`(query)	string	Apelido de 'search' — o código já aceitava os dois nomes; agora está documentado.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`name`	string
`color`	string \| null
`created_at`	string (date-time)

Exemplo

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

POST/service-categories

Criar categoria(s) de serviço

services:write

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`name`	string	Nome de uma categoria
`names`	array de string	Lista de nomes (cria várias de uma vez)
`color`	string	Cor hex (default #6366f1)

Resposta 201 — Categoria(s) criada(s)

`id`	string (uuid)
`name`	string
`color`	string \| null
`created_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/service-categories" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE"

DELETE/service-categories/{id}

Excluir categoria de serviço

services:delete

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 204 — Excluída

Sem corpo.

Exemplo

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

PATCH/service-categories/{id}

Atualizar categoria de serviço

services:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`name`	string
`color`	string

Resposta 200 — Atualizada

`id`	string (uuid)
`name`	string
`color`	string \| null
`created_at`	string (date-time)

Exemplo

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

GET/services

Listar serviços

services:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

`page`(query)	integer	Número da página (default: 1)
`per_page`(query)	integer	Itens por página (default: 20, máx: 100)
`search`(query)	string	Busca por nome ou descrição
`active`(query)	"true" \| "false"

Resposta 200 — Listagem paginada

`id`	string (uuid)
`name`	string
`description`	string \| null
`price`	number
`unit`	string	Unidade (texto livre, ex: hora, unidade, mensal)
`item_type`	"venda" \| "compra" \| "ambos"
`categories`	array de string
`active`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

POST/services

Criar serviço

services:write

Parâmetros, corpo, resposta e exemplo

Corpo (JSON)

`name`obrigatório	string
`description`	string
`price`obrigatório	number
`unit`	string
`item_type`	"venda" \| "compra" \| "ambos"
`categories`	array de string
`active`	boolean

Resposta 201 — Serviço criado

`id`	string (uuid)
`name`	string
`description`	string \| null
`price`	number
`unit`	string	Unidade (texto livre, ex: hora, unidade, mensal)
`item_type`	"venda" \| "compra" \| "ambos"
`categories`	array de string
`active`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X POST "https://api.comando.one/v1/services" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"name":"<string>","price":"<number>"}'

DELETE/services/{id}

Excluir serviço

services:delete

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 204 — Excluído

Sem corpo.

Exemplo

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

GET/services/{id}

Obter serviço

services:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Serviço

`id`	string (uuid)
`name`	string
`description`	string \| null
`price`	number
`unit`	string	Unidade (texto livre, ex: hora, unidade, mensal)
`item_type`	"venda" \| "compra" \| "ambos"
`categories`	array de string
`active`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

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

PATCH/services/{id}

Atualizar serviço

services:write

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

`name`obrigatório	string
`description`	string
`price`obrigatório	number
`unit`	string
`item_type`	"venda" \| "compra" \| "ambos"
`categories`	array de string
`active`	boolean

Resposta 200 — Serviço atualizado

`id`	string (uuid)
`name`	string
`description`	string \| null
`price`	number
`unit`	string	Unidade (texto livre, ex: hora, unidade, mensal)
`item_type`	"venda" \| "compra" \| "ambos"
`categories`	array de string
`active`	boolean
`created_at`	string (date-time)
`updated_at`	string (date-time)

Exemplo

curl -X PATCH "https://api.comando.one/v1/services/{id}" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"name":"<string>","price":"<number>"}'

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)Split de Pagamentos (9)Catálogos (7)Propostas (6)NFS-e (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