FireFly III icon

FireFly III

Read, update, write and delete data using the powerful FireFly III API

Actions89

Piggy Banks API → List Piggy Banks

AI-generated

Overview

This node interacts with the FireFly III API to list piggy banks. It retrieves a paginated list of piggy banks, allowing users to specify pagination options such as the number of results per page and the page number. This is useful for managing and viewing savings goals or piggy banks within the FireFly III financial management system.

Use Case Examples

  1. Retrieve the first 50 piggy banks to display in a dashboard.
  2. Fetch a specific page of piggy banks when dealing with a large number of savings goals.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Options Pagination options to control the number of results and the page number.

Output

JSON

  • json - The JSON response from the FireFly III API containing the list of piggy banks.

Dependencies

  • FireFly III API
  • An API key credential for authentication

Troubleshooting

  • Ensure the API credentials are correctly configured to avoid authentication errors.
  • Verify that the pagination parameters (limit and page) are within valid ranges to prevent request errors.
  • If the API returns an error, check the X-Trace-ID for debugging and tracing the request.

Links

Discussion