Skip to main content
GET
List boletos

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Organization-Id
string

Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.

Parâmetros de consulta

status
enum<string>

Status filter.

Opções disponíveis:
PENDING,
CREATED,
SETTLED,
CANCELED,
INACTIVATED,
FAILED
Exemplo:

"CREATED"

kind
enum<string>

Boleto kind filter.

Opções disponíveis:
SINGLE,
INSTALLMENT
Exemplo:

"SINGLE"

type
enum<string>

Boleto type filter.

Opções disponíveis:
TRADITIONAL,
QR_CODE,
HYBRID
Exemplo:

"TRADITIONAL"

from
string<date>

Created-from date, inclusive.

Exemplo:

"2026-01-01"

to
string<date>

Created-to date, inclusive.

Exemplo:

"2026-12-31"

dueDateFrom
string<date>

Due-date lower bound, inclusive.

Exemplo:

"2026-02-01"

dueDateTo
string<date>

Due-date upper bound, inclusive.

Exemplo:

"2026-11-30"

page
integer<int64>
padrão:1

Page number, one-based.

Intervalo obrigatório: x >= 1
Exemplo:

1

limit
integer<int64>
padrão:20

Items per page.

Intervalo obrigatório: 1 <= x <= 100
Exemplo:

20

Resposta

OK

items
object[] | null
obrigatório
limit
integer<int64>
obrigatório
page
integer<int64>
obrigatório
total
integer<int64>
obrigatório