---
title: "List of metadata for all affordability income calculations for a user"
method: GET
path: "/affordability/income"
tags: ["affordability"]
---

# List of metadata for all affordability income calculations for a user

`GET /affordability/income`

Requires **affordability_income:read** scope.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful Affordability Income Response

- object
  - `data` AffordabilityIncomeMetadata[]
    - `createdAt` string — The timestamp at which the report was generated
    - `id` string, required — The report id
  - `links` Links
    - `next` string, uri — The url to retrieve the next page of results from
    - `prev` string, uri — The url to retrieve the previous page of results from
    - `self` string, uri, required — The url of the current resource(s)
  - `meta` object

## Other responses

- `401` — Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403` — Unsuccessful Response - Forbidden - Invalid scopes
- `404` — Unsuccessful Response - Resource Not found

---

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