Skip to main content
GET
List organization schedules
Only an organization admin can list them. Filter by status, payment type, due date or description. A list filter takes its values comma-separated (?status=SCHEDULED,FAILED); repeating the parameter (?status=SCHEDULED&status=FAILED) works too. Paginated — see Pagination.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose schedules you want to list.

Format: UUID

Query Parameters

status
enum<string>[]

Only schedules in one of these statuses.


Example (comma-separated list): ?status=SCHEDULED,FAILED

Available options:
SCHEDULED,
PROCESSING,
CANCELLED,
FAILED,
DONE
transactionTypes
enum<string>[]

Only schedules of one of these payment types.


Example (comma-separated list): ?transactionTypes=PIX_TRANSFER,BANK_SLIP_PAYMENT

Available options:
BANK_SLIP_PAYMENT,
PIX_PAYMENT,
P2P_TRANSFER,
PIX_TRANSFER
description
string

Only schedules whose description contains this text (case-insensitive).

Maximum string length: 256
scheduledAtStart
string<date-time>

Only schedules due at or after this instant (ISO 8601 date-time).

scheduledAtEnd
string<date-time>

Only schedules due at or before this instant (ISO 8601 date-time). Must not be earlier than scheduledAtStart.

next
string

Cursor returned as next by the previous page. Omit for the first page.

limit
integer
default:50

Page size.

Required range: 1 <= x <= 100

Response

Successful response

A page of schedules, newest first.

items
object[]
required

The schedules of this page.

next
string | null
required

Cursor of the next page — send it as next. null on the last page.

Example:

"6716f0a2c9e77b0012a4d5e1"