Skip to main content
GET
List recurrence collections

Authorizations

Authorization
string
header
required

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

Headers

Trio-Version
enum<string>
required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:
2026-10-19.v2
Trio-Target-Org-Id
string<uuid>

ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.

Query Parameters

entity_id
string<uuid>

Entity Id Unique identifier

recurrence_id
string<uuid>
required

Recurrence Id Unique identifier

from_datetime
string<date-time>
required

From datetime Datetime schema

to_datetime
string<date-time>
required

To datetime Datetime schema

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 Limit list

Required range: x >= 10

Response

Collections

Recurrence collection list response

data
V2 RecurrenceCollectionData · object[]

A list data of automatic recurrence collections

Example:
metadata
object

Pagination cursors