---
title: "List all piggy banks related to the object group."
method: GET
path: "/v1/object-groups/{id}/piggy-banks"
tags: ["object_groups"]
---

# List all piggy banks related to the object group.

`GET /v1/object-groups/{id}/piggy-banks`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/object-groups/{id}/piggy-banks`
- 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

This endpoint returns a list of all the piggy banks connected to the object group.

## Path parameters

- `id` string, required

## Query parameters

- `limit` integer
- `page` integer

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

A list of piggy banks

- PiggyBankArray
  - `data` PiggyBankRead[], required
    - `type` string, string, required: Immutable value
    - `id` string, string, required
    - `attributes` PiggyBankProperties, required
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `name` string, string, required
      - `percentage` integer, nullable: The percentage of the target amount that has been saved, if a target amount is set.
      - `start_date` string, date-time: The date you started with this piggy bank.
      - `target_date` string, date-time, nullable: The date you intend to finish saving money.
      - `order` integer
      - `active` boolean
      - `notes` string, string, nullable
      - `object_group_id` string, string, nullable: The group ID of the group this object is part of. NULL if no group.
      - `object_group_order` integer, nullable: The order of the group. At least 1, for the highest sorting.
      - `object_group_title` string, string, nullable: The name of the group. NULL if no group.
      - `accounts` PiggyBankAccountRead[]
        - `account_id` string, string: The ID of the account.
        - `name` string, string
        - `current_amount` string, amount
        - `pc_current_amount` string, amount: If convertToPrimary is on, this will show the amount in the primary currency.
      - `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.
      - `target_amount` string, amount, nullable, required
      - `pc_target_amount` string, amount, nullable: The target amount in the primary currency of the administration.
      - `current_amount` string, amount
      - `pc_current_amount` string, amount: The current amount in the primary currency of the administration.
      - `left_to_save` string, string, nullable
      - `pc_left_to_save` string, string, nullable
      - `save_per_month` string, string, nullable
      - `pc_save_per_month` 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-4-17.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-17/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-4-17/revisions/ea021802490b?raw)