Skip to main content
GET
List recurrences

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

entity_id
string<uuid>

Recurrence Entity Id

virtual_account_id
string<uuid>

Virtual Account Id

from_datetime
string<date-time>
required

Recurrence datetime, lower bound for the list of recurrences

to_datetime
string<date-time>
required

Recurrence datetime, upper bound for the list of recurrences

before
string

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

after
string

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

limit
integer

Number of registries to be returned

Response

Recurrences

Recurrence lists response

data
RecurrenceData · object[]

A list data of automatic recurrences

Example: