v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

savings goals

Retrieve all saving goals for a user

Requires savings_goals:read scope.

get/savings-goals

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

Response

Successful Response

metaobject

Example response

{
  "data": [
    {
      "id": "9bef2cc3-e62f-4dfb-9a51-e3085bfbf5c4",
      "name": "Savings goal",
      "amount": {
        "value": 1000000,
        "majorUnits": 10000,
        "minorUnits": 0,
        "currency": "GBP"
      },
      "progressPercentage": 30,
      "progressAmount": {
        "value": 300000,
        "majorUnits": 3000,
        "minorUnits": 0,
        "currency": "GBP"
      },
      "imageUrl": "",
      "dateCreated": "2021-12-21T15:27:02+00:00",
      "targetDate": "2026-12-24",
      "accounts": [
        {
          "id": "a4f88d50-665c-461e-a54b-fb8da07d3b56"
        },
        {
          "id": "80a7f96b-ba20-43cd-82d0-e06a35f68051"
        }
      ]
    }
  ]
}