---
title: "List periods progress"
method: GET
path: "/api/v1/savings-goals/{id}/period_progress"
tags: ["Finance Management.Savings Goals", "ENTERPRISE"]
---

# List periods progress

`GET /api/v1/savings-goals/{id}/period_progress`

Get a list of periodProgresses, based on Users <code>periodMode</code> between the Savings Goal <code>createTime</code> and <code>targetDate</code>.<br />If no targetDate is set on the Savings Goal, it will return PeriodProgresses between createTime and the current date

## Path parameters

- `id` string, required

## Query parameters

- `page_size` integer
- `page_token` string

## Response `200`

List of PeriodProgresses between the createTime and targetDate.

- ListPeriodProgressResponse
  - `nextPageToken` string — 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.
  - `periodProgresses` PeriodProgress[]
    - `amountSavedThisPeriod` Amount — Amount moved with the allocation.
      - `currencyCode` string, required — The ISO 4217 currency code of the amount
      - `scale` integer, required — The scale of the amount. <br/>The `unscaledValue` is used with `scale` to accurately represent floating point values. <br/>The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0.
      - `unscaledValue` integer, required — The unscaled value of the amount. <br/>The `unscaledValue` is used with `scale` to accurately represent floating point values. <br/>The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0.
    - `periodEndDate` string — The end date of the period, ISO 8601 formatted date (yyyy-MM-dd).
    - `periodStartDate` string — The start date of the period, ISO 8601 formatted date (yyyy-MM-dd).
    - `reachedAmountForSavingsGoalThisPeriod` Amount — Amount moved with the allocation.
      - `currencyCode` string, required — The ISO 4217 currency code of the amount
      - `scale` integer, required — The scale of the amount. <br/>The `unscaledValue` is used with `scale` to accurately represent floating point values. <br/>The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0.
      - `unscaledValue` integer, required — The unscaled value of the amount. <br/>The `unscaledValue` is used with `scale` to accurately represent floating point values. <br/>The formula is `unscaledValue * (10^-scale)`. For example, if scale is 1 and unscaledValue is 1230, the end result would be 123.0.

## Other responses

- `401` — If the user is not authorized.
- `404` — Savings Goal not found.

---

[API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)