---
title: "List all recurring transactions."
method: GET
path: "/v1/recurrences"
tags: ["recurrences"]
---

# List all recurring transactions.

`GET /v1/recurrences`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/recurrences`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://demo.firefly-iii.org/oauth/authorize`
    - Token URL: `https://demo.firefly-iii.org/oauth/token`
  - HTTP bearer

List all recurring transactions.

## Query parameters

- `limit` integer
- `page` integer

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of recurring transactions.

- RecurrenceArray
  - `data` RecurrenceRead[], required
    - `type` string, string, required: Immutable value
    - `id` string, string, required
    - `attributes` RecurrenceProperties, required
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `type` 'withdrawal' | 'transfer' | 'deposit', string
      - `title` string, string
      - `description` string, string: Not to be confused with the description of the actual transaction(s) being created.
      - `first_date` string, date: First time the recurring transaction will fire. Must be after today.
      - `latest_date` string, date, nullable: Last time the recurring transaction has fired.
      - `repeat_until` string, date, nullable: Date until the recurring transaction can fire. Use either this field or repetitions.
      - `apply_rules` boolean: Whether or not to fire the rules after the creation of a transaction.
      - `active` boolean: If the recurrence is even active.
      - `nr_of_repetitions` integer, nullable: Max number of created transactions. Use either this field or repeat_until.
      - `notes` string, string, nullable
      - `repetitions` RecurrenceRepetition[]
        - `id` string, string
        - `created_at` string, date-time
        - `updated_at` string, date-time
        - `type` 'daily' | 'weekly' | 'ndom' | 'monthly' | 'yearly', string, required: The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week.
        - `moment` string, string, required: Information that defined the type of repetition. - For 'daily', this is empty. - For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday). - For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month - For 'monthly' it is the day of the month (1 - 31) - For yearly, it is a full date, ie '2026-03-01'. The year you use does not matter.
        - `skip` integer: How many occurrences to skip. 0 means skip nothing. 1 means every other.
        - `weekend` integer: How to respond when the recurring transaction falls in the weekend. Possible values: 1. Do nothing, just create it 2. Create no transaction. 3. Skip to the previous Friday. 4. Skip to the next Monday.
        - `description` string, string: Auto-generated repetition description.
        - `occurrences` string[]: Array of future dates when the repetition will apply to. Auto generated.
      - `transactions` RecurrenceTransaction[]
        - `id` string, string
        - `description` string, string, required
        - `object_has_currency_setting` boolean: Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.
        - `currency_id` string, string: The currency ID of the currency associated with this object.
        - `currency_name` string, string: The currency name of the currency associated with this object.
        - `currency_code` string, string: The currency code of the currency associated with this object.
        - `currency_symbol` string, string
        - `currency_decimal_places` integer
        - `primary_currency_id` string, string: The currency ID of the administration's primary currency.
        - `primary_currency_name` string, string: The currency name of the administration's primary currency.
        - `primary_currency_code` string, string: The currency code of the administration's primary currency.
        - `primary_currency_symbol` string, string: The currency symbol of the administration's primary currency.
        - `primary_currency_decimal_places` integer: The currency decimal places of the administration's primary currency.
        - `amount` string, amount, required: Amount of the transaction.
        - `pc_amount` string, amount: Amount of the transaction in primary currency.
        - `foreign_amount` string, amount, nullable: Foreign amount of the transaction.
        - `pc_foreign_amount` string, amount, nullable: Foreign amount of the transaction.
        - `foreign_currency_id` string, string, nullable
        - `foreign_currency_name` string, string, nullable
        - `foreign_currency_code` string, string, nullable
        - `foreign_currency_symbol` string, string, nullable
        - `foreign_currency_decimal_places` integer, nullable: Number of decimals in the currency
        - `budget_id` string, string: The budget ID for this transaction.
        - `budget_name` string, string, nullable: The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored.
        - `category_id` string, string: Category ID for this transaction.
        - `category_name` string, string: Category name for this transaction.
        - `source_id` string, string: ID of the source account. Submit either this or source_name.
        - `source_name` string, string: Name of the source account. Submit either this or source_id.
        - `source_iban` string, string, nullable
        - `source_type` 'Default account' | 'Cash account' | 'Asset account' | 'Expense account' | 'Revenue account' | 'Initial balance account' | 'Beneficiary account' | 'Import account' | 'Reconciliation account' | 'Loan' | 'Debt' | 'Mortgage', string
        - `destination_id` string, string: ID of the destination account. Submit either this or destination_name.
        - `destination_name` string, string: Name of the destination account. Submit either this or destination_id.
        - `destination_iban` string, string, nullable
        - `destination_type` 'Default account' | 'Cash account' | 'Asset account' | 'Expense account' | 'Revenue account' | 'Initial balance account' | 'Beneficiary account' | 'Import account' | 'Reconciliation account' | 'Loan' | 'Debt' | 'Mortgage', string
        - `tags` string[], nullable: Array of tags.
        - `piggy_bank_id` string, string, nullable
        - `piggy_bank_name` string, string, nullable
        - `subscription_id` string, string, nullable
        - `subscription_name` string, string, nullable
    - `links` ObjectLink, required
      - `0` object
        - `rel` string, string
        - `uri` string, string
      - `self` string, uri
  - `meta` Meta, required
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
  - `links` PageLink, required
    - `self` string, uri
    - `first` string, uri
    - `next` string, uri, nullable
    - `prev` string, uri, nullable
    - `last` string, uri

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-5.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-5/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-5/revisions/906276730447?raw)