> ## Documentation Index > Fetch the complete documentation index at: https://docs.trio.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List Recurrence Collections > List recurrence collections with parameters ## OpenAPI ````yaml v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections openapi: 3.0.0 info: title: Trio API v2 version: 2026-10-19.v2 servers: - url: https://api.sandbox.trio.com.br variables: {} - url: https://api.qa.trio.com.br variables: {} - url: https://api.trio.com.br variables: {} security: [] tags: [] paths: /v2/in/pix/recurrences/collections: parameters: - description: >- Version of the v2 contract the client is written against. Each breaking change publishes a new version. example: 2026-10-19.v2 in: header name: Trio-Version required: true schema: enum: - 2026-10-19.v2 type: string x-struct: null x-validate: null - description: >- 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. in: header name: Trio-Target-Org-Id required: false schema: format: uuid type: string x-struct: null x-validate: null get: tags: - Receivables (in) - Recurrences - Collections summary: List recurrence collections description: List recurrence collections with parameters operationId: TrioFoundationWeb.V2.In.Pix.Recurrence.CollectionController.index parameters: - description: Entity Id in: query name: entity_id required: false schema: $ref: '#/components/schemas/UUID' - description: Recurrence Id in: query name: recurrence_id required: true schema: $ref: '#/components/schemas/UUID' - description: From datetime in: query name: from_datetime required: true schema: $ref: '#/components/schemas/DATETIME' - description: To datetime in: query name: to_datetime required: true schema: $ref: '#/components/schemas/DATETIME' - description: >- 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. example: >- g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ== in: query name: before required: false schema: type: string x-struct: null x-validate: null - description: >- 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. example: >- g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ== in: query name: after required: false schema: type: string x-struct: null x-validate: null - description: Number of registries to be returned in: query name: limit required: false schema: $ref: '#/components/schemas/Limit' responses: '200': content: application/json: schema: $ref: '#/components/schemas/V2_RecurrenceCollectionListResponse' description: Collections '400': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- Malformed request: a body that is not valid JSON (MALFORMED_REQUEST), or a Trio-Version header that is missing or not the current one (INVALID_TRIO_VERSION). '401': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: Missing or invalid API key credentials (INVALID_CREDENTIALS). '403': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- The API key may not do this (FORBIDDEN): for instance Trio-Target-Org-Id names an org it has no access to, or writes through a read-only access. '422': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of the rule the request breaks). A request outside the operation's schema lists the offending fields in `errors`. '503': content: application/json: schema: $ref: '#/components/schemas/V2_error' description: >- A service needed to answer is unavailable (TRIO_SERVICE_UNAVAILABLE). callbacks: {} security: - authorization: [] components: schemas: UUID: description: Unique identifier format: uuid title: UUID type: string x-struct: null x-validate: null DATETIME: description: Datetime schema format: date-time title: DATETIME type: string x-struct: null x-validate: null Limit: description: Limit list minimum: 10 title: Limit type: integer x-struct: null x-validate: null V2_RecurrenceCollectionListResponse: description: Recurrence collection list response example: data: - additional_info: null amount: amount: 100 currency: BRL bank_account_id: 019a0d9e-d21f-32d2-7b68-d4e55e72e528 final_date: null id: 019a0d9e-d21f-0bf6-36be-abb0e6be5792 inserted_at: '2025-10-22T20:31:43.647903Z' next_working_day: false recurrence: id: 019a0d9e-d161-cd70-e9bd-f90cf4b50e33 status: active transaction_date: null updated_at: '2025-10-22T20:31:46.843629Z' metadata: after: null before: null has_more: false properties: data: $ref: '#/components/schemas/V2_RecurrenceCollectionListData' metadata: description: Pagination cursors properties: after: description: Cursor to the next page nullable: true type: string x-struct: null x-validate: null before: description: Cursor to the previous page nullable: true type: string x-struct: null x-validate: null has_more: description: Whether a next page exists type: boolean x-struct: null x-validate: null type: object x-struct: null x-validate: null title: V2 RecurrenceCollectionListResponse type: object x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.ListResponse x-validate: null V2_error: example: error: error_code: INVALID_PARAMETER error_message: 'Invalid parameters: /amount: Invalid integer. Got: string' errors: - field: /amount message: 'Invalid integer. Got: string' properties: error: properties: error_code: description: >- Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message. type: string x-struct: null x-validate: null error_message: description: Human readable explanation of the error. type: string x-struct: null x-validate: null errors: description: >- Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field. items: properties: field: description: JSON pointer to the field, e.g. /amount. type: string x-struct: null x-validate: null message: description: What is wrong with it. type: string x-struct: null x-validate: null required: - field - message type: object x-struct: null x-validate: null type: array x-struct: null x-validate: null required: - error_code - error_message type: object x-struct: null x-validate: null required: - error title: V2 error type: object x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error x-validate: null V2_RecurrenceCollectionListData: description: A list data of automatic recurrence collections example: - additional_info: null amount: amount: 100 currency: BRL bank_account_id: 019a0d9e-d21f-32d2-7b68-d4e55e72e528 final_date: null id: 019a0d9e-d21f-0bf6-36be-abb0e6be5792 inserted_at: '2025-10-22T20:31:43.647903Z' next_working_day: false recurrence: id: 019a0d9e-d161-cd70-e9bd-f90cf4b50e33 status: active transaction_date: null updated_at: '2025-10-22T20:31:46.843629Z' items: $ref: '#/components/schemas/V2_RecurrenceCollectionData' title: V2 RecurrenceCollectionListData type: array x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.ListData x-validate: null V2_RecurrenceCollectionData: description: A recurrence collection example: additional_info: null amount: amount: 100 currency: BRL bank_account_id: 019a0d9e-d21f-32d2-7b68-d4e55e72e528 final_date: null id: 019a0d9e-d21f-0bf6-36be-abb0e6be5792 inserted_at: '2025-10-22T20:31:43.647903Z' next_working_day: false recurrence: id: 019a0d9e-d161-cd70-e9bd-f90cf4b50e33 status: active transaction_date: null updated_at: '2025-10-22T20:31:46.843629Z' properties: additional_info: description: Additional information sent to the payer nullable: true type: string x-struct: null x-validate: null amount: description: Collection amount nullable: true properties: amount: description: Amount in cents type: integer x-struct: null x-validate: null currency: description: Currency type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null bank_account_id: description: Bank account that receives the collection format: uuid type: string x-struct: null x-validate: null final_date: description: Last day of the collection format: date nullable: true type: string x-struct: null x-validate: null id: description: Collection ID format: uuid type: string x-struct: null x-validate: null inserted_at: description: When the collection was created format: date-time type: string x-struct: null x-validate: null next_working_day: description: Whether a collection on a non-working day moves to the next one type: boolean x-struct: null x-validate: null recurrence: description: Recurrence the collection belongs to properties: id: description: Recurrence ID format: uuid type: string x-struct: null x-validate: null type: object x-struct: null x-validate: null status: description: Collection status enum: - created - active - settled - expired - rejected - cancelled type: string x-struct: null x-validate: null transaction_date: description: Transaction date format: date-time nullable: true type: string x-struct: null x-validate: null updated_at: description: When the collection was last updated format: date-time type: string x-struct: null x-validate: null title: V2 RecurrenceCollectionData type: object x-struct: >- Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Collection.Data x-validate: null securitySchemes: authorization: scheme: basic type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.