recurrences
List all recurring transactions.
List all recurring transactions.
get/v1/recurrences
Request
- Base URLhttps://demo.firefly-iii.org/api
- URLhttps://demo.firefly-iii.org/api/v1/recurrences
- Auth
- OAuth 2Authorization code: https://demo.firefly-iii.org/oauth/authorizeToken URL: https://demo.firefly-iii.org/oauth/token
- or HTTP bearer
Query parameters
limitinteger
Example:10
Number of items per page. The default pagination is per 50 items.
pageinteger
Example:1
Page number. The default pagination is per 50 items.
Headers
X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00
Unique identifier associated with this request.
Response
A list of recurring transactions.
Example response
{
"data": [
{
"type": "recurrences",
"id": "2",
"attributes": {
"created_at": "2026-03-01T00:00:00+00:00",
"updated_at": "2026-03-01T00:00:00+00:00",
"type": "withdrawal",
"title": "Rent",
"description": "Recurring transaction for the monthly rent",
"first_date": "2026-03-31",
"latest_date": "2026-03-01",
"repeat_until": "2026-03-31",
"apply_rules": true,
"active": true,
"nr_of_repetitions": 5,
"notes": "Some notes",
"repetitions": [
{
"id": "2",
"created_at": "2026-03-01T00:00:00+00:00",
"updated_at": "2026-03-01T00:00:00+00:00",
"type": "weekly",
"moment": "3",
"weekend": 1,
"description": "Every week on Friday",
"occurrences": [
"2026-03-31T23:59:59+00:00"
]
}
],
"transactions": [
{
"id": "ID of the recurring transaction. Not to be confused with the ID of the recurrence itself.",
"description": "Rent for the current month",
"object_has_currency_setting": true,
"currency_id": "5",
"currency_name": "Euro",
"currency_code": "EUR",
"currency_symbol": "$",
"currency_decimal_places": 2,
"primary_currency_id": "5",
"primary_currency_name": "Euro",
"primary_currency_code": "EUR",
"primary_currency_symbol": "$",
"primary_currency_decimal_places": 2,
"amount": "123.45",
"pc_amount": "123.45",
"foreign_amount": "123.45",
"pc_foreign_amount": "123.45",
"foreign_currency_id": "17",
"foreign_currency_name": "British Pound",
"foreign_currency_code": "GBP",
"foreign_currency_symbol": "$",
"foreign_currency_decimal_places": 2,
"budget_id": "4",
"budget_name": "Groceries",
"category_id": "211",
"category_name": "Bills",
"source_id": "913",
"source_name": "Checking account",
"source_iban": "NL02ABNA0123456789",
"source_type": "Asset account",
"destination_id": "258",
"destination_name": "Buy and Large",
"destination_iban": "NL02ABNA0123456789",
"destination_type": "Asset account",
"tags": [
"Barbecue preparation"
],
"piggy_bank_id": "123",
"subscription_id": "123"
}
]
},
"links": {
"0": {
"rel": "self",
"uri": "/OBJECTS/1"
},
"self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
}
}
],
"meta": {
"pagination": {
"total": 3,
"count": 20,
"per_page": 100,
"current_page": 1,
"total_pages": 1
}
},
"links": {
"self": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=4",
"first": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=1",
"next": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=3",
"prev": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=2",
"last": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=12"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.