Documentação / Paginação v1

Quickstart OpenAPI IA Health

API REST fiscal

Liste documentos, eventos e webhooks com um padrão de paginação previsível.

Esta documentação descreve a versão pública atual da API fiscal da Contora, com base compartilhada de empresas, certificados, chaves, filas, webhooks e artefatos para NF-e, NFC-e, NFS-e, CT-e e MDF-e. NF-e, NFC-e e NFS-e operam em produção regular; CT-e e MDF-e em produção assistida e controlada.

Atualizado em 29 de agosto de 2026.

Padrão geral

Endpoints de listagem retornam coleções paginadas. O cliente deve tratar paginação de forma explícita para navegar por documentos, tentativas, eventos, webhooks e demais recursos listáveis.

GET https://fiscal.contora.com.br/api/v1/companies?page=1&per_page=25

Parâmetros esperados

page: página desejada, iniciando em 1.
per_page: quantidade de registros por página, respeitando o teto definido pelo backend.
Filtros adicionais podem variar por endpoint.

{
  "data": [],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 240,
    "last_page": 10,
    "from": 1,
    "to": 25,
    "has_more_pages": true
  },
  "links": {
    "first": "https://fiscal.contora.com.br/api/v1/companies?page=1",
    "last": "https://fiscal.contora.com.br/api/v1/companies?page=10",
    "prev": null,
    "next": "https://fiscal.contora.com.br/api/v1/companies?page=2"
  }
}

Filtros

As listagens principais tambem aceitam filtros por contexto. Empresas aceitam busca textual, regime, UF e presença de certificado. Documentos aceitam combinacoes de status, processing_status, requested_action, ambiente, número e chave de acesso.

# Global / Flat (Recomendado)
GET https://fiscal.contora.com.br/api/v1/nfe/drafts?page=1&per_page=20&status=draft&environment=homologacao

# Hierárquico
GET https://fiscal.contora.com.br/api/v1/companies/{company}/nfe/drafts?page=1&per_page=20&status=draft&environment=homologacao