Skip to main content
GET
List boletos

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

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.

Query Parameters

status
enum<string>

Status filter.

Available options:
PENDING,
CREATED,
SETTLED,
CANCELED,
INACTIVATED,
FAILED
Example:

"CREATED"

kind
enum<string>

Boleto kind filter.

Available options:
SINGLE,
INSTALLMENT
Example:

"SINGLE"

type
enum<string>

Boleto type filter.

Available options:
TRADITIONAL,
QR_CODE,
HYBRID
Example:

"TRADITIONAL"

from
string<date>

Created-from date, inclusive.

Example:

"2026-01-01"

to
string<date>

Created-to date, inclusive.

Example:

"2026-12-31"

dueDateFrom
string<date>

Due-date lower bound, inclusive.

Example:

"2026-02-01"

dueDateTo
string<date>

Due-date upper bound, inclusive.

Example:

"2026-11-30"

page
integer<int64>
default:1

Page number, one-based.

Required range: x >= 1
Example:

1

limit
integer<int64>
default:20

Items per page.

Required range: 1 <= x <= 100
Example:

20

Response

OK

items
object[] | null
required
limit
integer<int64>
required
page
integer<int64>
required
total
integer<int64>
required