Skip to content
API/
/v1

Retornar os contratos por filtro

Request

Permite consultar contratos existentes, com suporte a filtros que facilitam a busca e a gestão dos contratos criados (ex. por cliente, data, status, entre outros). Os parâmetros de múltiplos valores (ex.: cliente_id, tipo_pagamento) aceitam dois formatos equivalentes: chaves repetidas (?cliente_id=<uuid1>&cliente_id=<uuid2>) ou valores separados por vírgula (?cliente_id=<uuid1>,<uuid2>).

Security
BearerAuth
Query
paginainteger

Página

Default:1
Example:pagina=1
tamanho_paginainteger

Tamanho da página (máximo 50)

Default:10
Example:tamanho_pagina=10
campo_ordenado_ascendentestring

Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente.

Enum:"DATA_INICIO""DATA_FIM"
Example:campo_ordenado_ascendente=DATA_INICIO
campo_ordenado_descendentestring

Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado.

Enum:"DATA_INICIO""DATA_FIM"
Example:campo_ordenado_descendente=DATA_INICIO
busca_textualstring

Busca textual por nome

Example:busca_textual=Contrato 1
cliente_idArray of strings

id do cliente

Example:cliente_id=123e4567-e89b-12d3-a456-426614174000
data_iniciostringrequired

Data inicio do intervalo de busca

Example:data_inicio=2026-08-15
data_fimstringrequired

Data fim do intervalo de busca

Example:data_fim=2027-08-15
tipo_pagamentoArray of strings

Tipos de pagamento

Items Enum:"BOLETO_BANCARIO""CARTAO_CREDITO""CARTAO_DEBITO""CARTEIRA_DIGITAL""CASHBACK""CHEQUE""CREDITO_LOJA""CREDITO_VIRTUAL""DEPOSITO_BANCARIO""DINHEIRO"
Example:tipo_pagamento=BOLETO_BANCARIO
statusstring

Status dos contratos

Enum:"TODOS""ATIVO""INATIVO""PROXIMO_AO_VENCIMENTO"
Example:status=ATIVO
curl -i -X GET \
  'https://api-v2.contaazul.com/v1/contratos?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=DATA_INICIO&campo_ordenado_descendente=DATA_INICIO&busca_textual=Contrato%201&cliente_id=123e4567-e89b-12d3-a456-426614174000&data_inicio=2026-08-15&data_fim=2027-08-15&tipo_pagamento=BOLETO_BANCARIO&status=ATIVO' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itensArray of objects(ItemContrato)

Lista de contratos

itens_totaisinteger

Total de contratos encontrados

Example:1
Response
{
  "itens": [
    { … }
  ],
  "itens_totais": 1
}