Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Finance Management.Savings Goals
ENTERPRISE

List Savings Goals

List the user's Savings Goals.

get/api/v1/savings-goals

Query parameters

page_sizeinteger

(Optional) Size of the page to fetch.

page_tokenstring

(Optional) The first token is presented on the response of the first call if there are multiple pages.

status_instring[]

Filter Savings Goals by status. If left out, it will by default, filter out <code>ARCHIVED</code> Savings Goals. The status of a Saving Goal changes from <code>CREATED</code> to <code>IN_PROGRESS</code> just after the first deposit of fund to it.

account_instring[]

Filter the list of Savings Goals by account ids.

Response

The list Savings Goals.

nextPageTokenstring

Next page token to be used for pagination, use it with the next request parameter <code>page_token</code> to request the next page of the list.

savingsGoalsFinance20ManagementSavings20Goals20Response[] — unresolved $ref