Retrieve Savings Goals

The GET goals/v1/savings endpoint retrieves all savings goals for a customer.

This endpoint can be filtered account_id using the query parameter filter. An example of a 200 response can be seen below, the result is filtered by the account_id RxsYshVGded4JeilkXgWKdXA.

The response includes the saved_amount field which is a running total of the Savings Goal Actions against the goal.

{
  "operation_id": "goals_v1_savings_get",
  "data": [
    {
      "id": "f46d76c4-56d3-11ee-ac69-d6df71eb5902",
      "account_id": "RxsYshVGded4JeilkXgWKdXA",
      "name": "Car Savings",
      "target_amount": {
        "currency": "GBP",
        "value": "3000.00"
      },
      "recurrent_amount": {
        "currency": "GBP",
        "value": "750.00"
      },
      "target_date": "2023-12-30",
      "saved_amount": {
        "currency": "GBP",
        "value": "0.00"
      },
      "created_at": "2023-09-19T10:04:43Z"
    },
    {
      "id": "265a4aed-348d-4ff1-802e-2d08d7cace77",
      "account_id": "RxsYshVGded4JeilkXgWKdXA",
      "name": "Holiday Savings",
      "target_amount": {
        "currency": "GBP",
        "value": "1000.00"
      },
      "recurrent_amount": {
        "currency": "GBP",
        "value": "100.00"
      },
      "target_date": "2023-07-30",
      "saved_amount": {
        "currency": "GBP",
        "value": "0.00"
      },
      "created_at": "2023-09-19T10:04:43Z"
    }
  ],
  "metadata": {
    "results": 2,
    "account_id": "RxsYshVGded4JeilkXgWKdXA"
  }
}

curl --request GET \
     --url https://api-sandbox.thisisbud.com/goals/v1/savings \
     --header 'X-Client-Id: ecfa9b53-963b-4f8a-9811-e09a79ff7019' \
     --header 'X-Customer-Id: 2a7a1f1c-18b9-4af1-8424-91c5848e8037' \
     --header 'X-Customer-Secret: 2efbed02ac697a80354e0a792bbe733aed904820d030321a0b50b51c1dd05bd3' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer dddd'

In the case that the customer has no savings goals, a 200 is still returned with a response as below.

{
  "operation_id": "goals_v1_savings_get",
  "data": [],
  "metadata": {
    "results": 0,
    "account_id": null
  }
}

curl --request GET \
     --url https://api-sandbox.thisisbud.com/goals/v1/savings \
     --header 'X-Client-Id: ecfa9b53-963b-4f8a-9811-e09a79ff7019' \
     --header 'X-Customer-Id: 2a7a1f1c-18b9-4af1-8424-91c5848e8037' \
     --header 'X-Customer-Secret: 2efbed02ac697a80354e0a792bbe733aed904820d030321a0b50b51c1dd05bd3' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer dddd'

If you receive a 400 response, please check the headers you're sending in the request before trying again.

If you receive a 401 response from either of the endpoints this would indicate that you are not authorised to make this request, if you believe this to be a mistake or are receiving persistent 500 responses please raise a support request.

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.