---
title: "List all events linked to a piggy bank."
method: GET
path: "/v1/piggy-banks/{id}/events"
tags: ["piggy_banks"]
---

# List all events linked to a piggy bank.

`GET /v1/piggy-banks/{id}/events`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/piggy-banks/{id}/events`
- 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 events linked to a piggy bank (adding and removing money).

## Path parameters

- `id` string, required

## Query parameters

- `limit` integer
- `page` integer

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of piggy bank related events

- PiggyBankEventArray
  - `data` PiggyBankEventRead[], required
    - `type` string, string, required: Immutable value
    - `id` string, string, required
    - `attributes` PiggyBankEventProperties, required
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `amount` string, amount
      - `pc_amount` string, amount
      - `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.
      - `transaction_journal_id` string, string, nullable: The journal associated with the event.
      - `transaction_group_id` string, string, nullable: The transaction group associated with the event.
    - `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-4-0.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-0/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-0/revisions/445332924ac5?raw)
