Returns the the round-up goal associated with an account if one has been created

get/api/v2/feed/account/{accountUid}/round-up

Request

Base URL
https://api.starlingbank.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/starlingbank/apis/starling-bank-api/docs/api/v2/feed/account/:accountUid/round-up/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountUidstring uuid required

Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Account uid

Response

Successful operation

activeboolean

Example response

{
  "roundUpGoal": {
    "primaryCategoryUid": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
    "roundUpGoalUid": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
    "activatedBy": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
  },
  "roundUpGoalDetails": {
    "primaryCategoryUid": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
    "roundUpGoalUid": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa",
    "activatedBy": "aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

No recorded changes to this operation across all 14 revisions of this API.