Sign in
Savings Goals

Get a savings goal

get/api/v2/account/{accountUid}/savings-goals/{savingsGoalUid}

Path parameters

accountUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Account uid

savingsGoalUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Savings goal uid

Response

Successful operation

savingsGoalUidstring uuid required

Unique identifier of the savings goal

namestring required

Name of the savings goal

savedPercentageinteger

Percentage of target currently deposited in the savings goal

state'CREATING' | 'ACTIVE' | 'ARCHIVING' | 'ARCHIVED' | 'RESTORING' | 'PENDING' required

The state of the savings goal

Example response

{
  "savingsGoalUid": "77887788-7788-7788-7788-778877887788",
  "name": "Trip to Paris",
  "target": {
    "currency": "GBP",
    "minorUnits": 123456
  },
  "totalSaved": {
    "currency": "GBP",
    "minorUnits": 123456
  },
  "savedPercentage": 100,
  "state": "ACTIVE"
}