---
title: "Retrieve all saving goals for a user"
method: GET
path: "/savings-goals"
tags: ["savings goals"]
---

# Retrieve all saving goals for a user

`GET /savings-goals`

## Request

- Base URL: `https://api.moneyhub.co.uk/v3`
- URL: `https://api.moneyhub.co.uk/v3/savings-goals`
- Auth: API key in header `Authorization`

Requires **savings_goals:read** scope.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- object
  - `data` SavingsGoals[]
    - `id` string, required: Unique id of the saving goal.
    - `name` string, required: Name for the savings goal.
    - `amount` object, required
      - `value` integer, required: The target amount in minor unit in minor units of the currency, eg. pennies for GBP.
      - `majorUnits` integer: The major units of the value, based on the values currency, eg. pounds for GBP.
      - `minorUnits` integer: The minor units of the value, based on the values currency, eg. pennies for GBP.
      - `currency` string, required: The currency of the amount
    - `targetDate` string, date: The target date for the savings goal. Format YYYY-MM-DD
    - `dateCreated` string, date-time, required: The date at which the savings goal was added.
    - `imageUrl` string
    - `notes` string: Arbitrary text that a user can add about a savings goal.
    - `progressPercentage` number: Progress achieved towards the target amount represented in percentage.
    - `progressAmount` object: Progress achieved towards the target amount by adding up the balances of the selected accounts.
      - `value` integer: The amount of the transaction in minor units of the currency, eg. pennies for GBP, negative means money going out of an account, positive means money coming into an account.
      - `majorUnits` integer: The major units of the value, based on the values currency, eg. pounds for GBP.
      - `minorUnits` integer: The minor units of the value, based on the values currency, eg. pennies for GBP.
      - `currency` string: The currency of the amount
    - `accounts` object[], required: Accounts that will be taken into account towards the target amount.
      - `id` string, required: Id of the account
  - `links` Links
    - `next` string, uri: The url to retrieve the next page of results from
    - `prev` string, uri: The url to retrieve the previous page of results from
    - `self` string, uri, required: The url of the current resource(s)
  - `meta` object

## Other responses

- `401`: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403`: Unsuccessful Response - Forbidden - Invalid scopes

---

[API](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/revisions/2e08b5dbee56?raw)