FF3
FF3 KEY
1 subscribers
100 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
FF3 endpoints
| Method | Endpoint | Description |
|---|---|---|
| configuration | ||
| PUT |
setConfiguration /api/v1/configuration/{name} |
Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small. |
| GET |
getSingleConfiguration /api/v1/configuration/{name} |
Returns one configuration variable for this Firefly III installation |
| users | ||
| GET |
getUser /api/v1/users/{id} |
Gets all info of a single user. |
| GET |
listUser /api/v1/users |
List all the users in this instance of Firefly III. |
| PUT |
updateUser /api/v1/users/{id} |
Update existing user. |
| DELETE |
deleteUser /api/v1/users/{id} |
Delete a user. You cannot delete the user you're authenticated with. This cannot be undone. Be careful! |
| autocomplete | ||
| GET |
getRecurringAC /api/v1/autocomplete/recurring |
|
| GET |
getTransactionTypesAC /api/v1/autocomplete/transaction-types |
|
| GET |
getBillsAC /api/v1/autocomplete/bills |
|
| GET |
getTransactionsIDAC /api/v1/autocomplete/transactions-with-id |
|
| GET |
getCategoriesAC /api/v1/autocomplete/categories |
|
| data | ||
| GET |
exportAccounts /api/v1/data/export/accounts |
This endpoint allows you to export your accounts from Firefly III into a file. Currently supports CSV exports only. |
| GET |
exportTags /api/v1/data/export/tags |
This endpoint allows you to export your tags from Firefly III into a file. Currently supports CSV exports only. |
| DELETE |
destroyData /api/v1/data/destroy |
A call to this endpoint permanently destroys the requested data type. Use it with care and always with user permission. The demo user is incapable of using this endpoint. |
| GET |
exportBills /api/v1/data/export/bills |
This endpoint allows you to export your bills from Firefly III into a file. Currently supports CSV exports only. |
| GET |
exportTransactions /api/v1/data/export/transactions |
This endpoint allows you to export transactions from Firefly III into a file. Currently supports CSV exports only. |
| GET |
exportBudgets /api/v1/data/export/budgets |
This endpoint allows you to export your budgets and associated budget data from Firefly III into a file. Currently supports CSV exports only. |
| GET |
exportPiggies /api/v1/data/export/piggy-banks |
This endpoint allows you to export your piggy banks from Firefly III into a file. Currently supports CSV exports only. |
| GET |
exportCategories /api/v1/data/export/categories |
This endpoint allows you to export your categories from Firefly III into a file. Currently supports CSV exports only. |
| insight | ||
| GET |
insightIncomeTotal /api/v1/insight/income/total |
This endpoint gives a sum of the total income received by the user. |
| GET |
insightIncomeNoCategory /api/v1/insight/income/no-category |
This endpoint gives a summary of the income received by the user, including only income with no category. |
| GET |
insightExpenseNoCategory /api/v1/insight/expense/no-category |
This endpoint gives a summary of the expenses made by the user, including only expenses with no category. |
| GET |
insightTransferNoCategory /api/v1/insight/transfer/no-category |
This endpoint gives a summary of the transfers made by the user, including only transfers with no category. |
| GET |
insightExpenseExpense /api/v1/insight/expense/expense |
This endpoint gives a summary of the expenses made by the user, grouped by expense account. |
| GET |
insightTransferCategory /api/v1/insight/transfer/category |
This endpoint gives a summary of the transfers made by the user, grouped by (any) category. |
| GET |
insightExpenseCategory /api/v1/insight/expense/category |
This endpoint gives a summary of the expenses made by the user, grouped by (any) category. |
| GET |
insightTransfers /api/v1/insight/transfer/asset |
This endpoint gives a summary of the transfers made by the user, grouped by asset account or lability. |
| GET |
insightTransferTag /api/v1/insight/transfer/tag |
This endpoint gives a summary of the transfers created by the user, grouped by (any) tag. |
| GET |
insightExpenseTag /api/v1/insight/expense/tag |
This endpoint gives a summary of the expenses made by the user, grouped by (any) tag. |
| GET |
insightExpenseBudget /api/v1/insight/expense/budget |
This endpoint gives a summary of the expenses made by the user, grouped by (any) budget. |
| GET |
insightExpenseNoBudget /api/v1/insight/expense/no-budget |
This endpoint gives a summary of the expenses made by the user, including only expenses with no budget. |
| summary | ||
| GET |
getBasicSummary /api/v1/summary/basic |
Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is used in Firefly III to populate the dashboard. |
| search | ||
| GET |
searchAccounts /api/v1/search/accounts |
Search for accounts |
| preferences | ||
| POST |
storePreference /api/v1/preferences |
This endpoint creates a new preference. The name and data are free-format, and entirely up to you. If the preference is not used in Firefly III itself it may not be configurable… |
| GET |
getPreference /api/v1/preferences/{name} |
Return a single preference and the value. |
| PUT |
updatePreference /api/v1/preferences/{name} |
Update a user's preference. |
| webhooks | ||
| POST |
submitWebook /api/v1/webhooks/{id}/submit |
This endpoint will submit any open messages for this webhook. This is an asynchronous operation, so you can't see the result. Refresh the webhook message and/or the webhook… |
| GET |
getWebhookMessages /api/v1/webhooks/{id}/messages |
When a webhook is triggered the actual message that will be send is stored in a "message". You can view and analyse these messages. |
| DELETE |
deleteWebhookMessage /api/v1/webhooks/{id}/messages/{messageId} |
Delete a webhook message. Any time a webhook is triggered the message is stored before it's sent. You can delete them before or after sending. |
| GET |
getWebhookMessageAttempts /api/v1/webhooks/{id}/messages/{messageId}/attempts |
When a webhook message fails to send it will store the failure in an "attempt". You can view and analyse these. Webhook messages that receive too many attempts (failures) will… |
| DELETE |
deleteWebhookMessageAttempt /api/v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId} |
Delete a webhook message attempt. If you delete all attempts for a webhook message, Firefly III will (once again) assume all is well with the webhook message and will try to send… |
| DELETE |
deleteWebhook /api/v1/webhooks/{id} |
Delete a webhook. |
| POST |
storeWebhook /api/v1/webhooks |
Creates a new webhook. The data required can be submitted as a JSON body or as a list of parameters. The webhook will be given a random secret. |
| PUT |
updateWebhook /api/v1/webhooks/{id} |
Update an existing webhook's information. If you wish to reset the secret, submit any value as the "secret". Firefly III will take this as a hint and reset the secret of the… |
| accounts | ||
| GET |
listPiggyBankByAccount /api/v1/accounts/{id}/piggy_banks |
This endpoint returns a list of all the piggy banks connected to the account. |
| POST |
storeAccount /api/v1/accounts |
Creates a new account. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform). |
| DELETE |
deleteAccount /api/v1/accounts/{id} |
Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from. |
| attachments | ||
| DELETE |
deleteAttachment /api/v1/attachments/{id} |
With this endpoint you delete an attachment, including any stored file data. |
| PUT |
updateAttachment /api/v1/attachments/{id} |
Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below. |
| available_budgets | ||
| PUT |
updateAvailableBudget /api/v1/available_budgets/{id} |
Update existing available budget. |
+ 50 more endpoints on the provider's documentation.
FF3 pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | $200 / month | — |
|
| PRO | $200 / month | — |
|
