Skip to navigation

List the schedulings of a recurrence

Live list of the schedulings and retries of the recurrence, with their settlement when it exists.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.
recurrenceIdstringRequired

Recurrence UUID (recurrenceId) or its Pix scheme identifier (RR…/RN…).

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

Query parameters

pageintegerOptional>=1Defaults to 1
Page number starting at 1.
pageSizeintegerOptional1-100Defaults to 50

Items per page (1–100).

orderenumOptional
Sort by creation date.
Allowed values:

Response

Page of schedulings
itemslist of objectsOptional
pageintegerOptional
pageSizeintegerOptional
totalItemsintegerOptional
totalPagesintegerOptional
hasNextbooleanOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
502
Bad Gateway Error