API de Caixa de Entrada

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

GET/inbox/documents

Listar documentos da caixa de entrada

inbox: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)
`kind`(query)	string	Tipo do documento extraído (boleto, nfe, guia…).
`outcome`(query)	string	Desfecho do processamento.
`message_id`(query)	string (uuid)	Mensagem de origem.
`supplier_id`(query)	string (uuid)	Fornecedor casado.
`purchase_invoice_id`(query)	string (uuid)	Conta a pagar lançada a partir dele.
`due_from`(query)	string (date)	Vencimento a partir de.
`due_to`(query)	string (date)	Vencimento até.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`message_id`	string (uuid)
`filename`	string
`content_type`	string
`size_bytes`	number
`kind`	string
`direction`	string
`amount`	number
`due_date`	string (date)
`issue_date`	string (date)
`document_number`	string
`counterparty_name`	string
`counterparty_document`	string
`barcode`	string
`pix_key`	string
`outcome`	string
`outcome_reason`	string
`match_method`	string
`match_confidence`	number
`supplier_id`	string (uuid)
`customer_id`	string (uuid)
`purchase_invoice_id`	string (uuid)
`invoice_id`	string (uuid)
`duplicate_of_document_id`	string (uuid)
`dda_boleto_id`	string (uuid)

Exemplo

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

GET/inbox/documents/{id}

Obter documento da caixa de entrada

inbox:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Documento da caixa de entrada

`id`	string (uuid)
`message_id`	string (uuid)
`filename`	string
`content_type`	string
`size_bytes`	number
`kind`	string
`direction`	string
`amount`	number
`due_date`	string (date)
`issue_date`	string (date)
`document_number`	string
`counterparty_name`	string
`counterparty_document`	string
`barcode`	string
`pix_key`	string
`outcome`	string
`outcome_reason`	string
`match_method`	string
`match_confidence`	number
`supplier_id`	string (uuid)
`customer_id`	string (uuid)
`purchase_invoice_id`	string (uuid)
`invoice_id`	string (uuid)
`duplicate_of_document_id`	string (uuid)
`dda_boleto_id`	string (uuid)

Exemplo

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

GET/inbox/messages

Listar mensagens da caixa de entrada

inbox: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)
`status`(query)	string	Estado do processamento da mensagem.
`from_email`(query)	string	Remetente (busca parcial).
`subject`(query)	string	Assunto (busca parcial).
`received_from`(query)	string (date)	Recebidas a partir desta data.
`received_to`(query)	string (date)	Recebidas até esta data.

Resposta 200 — Listagem paginada

`id`	string (uuid)
`from_email`	string
`from_name`	string
`subject`	string
`status`	string
`error_reason`	string
`attempts`	number
`received_at`	string (date-time)
`processed_at`	string (date-time)
`replied_at`	string (date-time)
`created_at`	string (date-time)
`body_text`	string
`spf_verdict`	string
`dkim_verdict`	string
`dmarc_verdict`	string
`spam_verdict`	string
`virus_verdict`	string
`raw_size_bytes`	number
`thread_root_id`	string (uuid)

Exemplo

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

GET/inbox/messages/{id}

Obter mensagem da caixa de entrada

inbox:read

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Resposta 200 — Mensagem da caixa de entrada

`id`	string (uuid)
`from_email`	string
`from_name`	string
`subject`	string
`status`	string
`error_reason`	string
`attempts`	number
`received_at`	string (date-time)
`processed_at`	string (date-time)
`replied_at`	string (date-time)
`created_at`	string (date-time)
`body_text`	string
`spf_verdict`	string
`dkim_verdict`	string
`dmarc_verdict`	string
`spam_verdict`	string
`virus_verdict`	string
`raw_size_bytes`	number
`thread_root_id`	string (uuid)

Exemplo

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

PATCH/inbox/messages/{id}/status

Reprocessar ou arquivar mensagem

`recebido` devolve a mensagem ao processamento (limpando o erro anterior); `ignorado` a arquiva. Os demais estados são escritos pelo processamento, não pelo cliente.

inbox:update

Parâmetros, corpo, resposta e exemplo

Parâmetros

idobrigatório(path) string (uuid)

Corpo (JSON)

statusobrigatório "recebido" | "ignorado"

Resposta 200 — Mensagem atualizada

`id`	string (uuid)
`from_email`	string
`from_name`	string
`subject`	string
`status`	string
`error_reason`	string
`attempts`	number
`received_at`	string (date-time)
`processed_at`	string (date-time)
`replied_at`	string (date-time)
`created_at`	string (date-time)
`body_text`	string
`spf_verdict`	string
`dkim_verdict`	string
`dmarc_verdict`	string
`spam_verdict`	string
`virus_verdict`	string
`raw_size_bytes`	number
`thread_root_id`	string (uuid)

Exemplo

curl -X PATCH "https://api.comando.one/v1/inbox/messages/{id}/status" \
  -H "Authorization: Bearer cmd_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"status":"<\"recebido\" | \"ignorado\">"}'

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