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

# List of metadata for all affordability calculations for a user

`GET /affordability`

## Request

- Base URL: `https://api.moneyhub.co.uk/v3`
- URL: `https://api.moneyhub.co.uk/v3/affordability`
- Auth: API key in header `Authorization`

Requires **affordability:read** scope.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful Affordability Response

- object
  - `data` AffordabilityMetadata[]
    - `createdAt` string, nullable: The timestamp at which the report was generated
    - `requestedAt` string, nullable: The timestamp at which the report was requested
    - `id` string, required: The report id
    - `status` 'pending' | 'complete' | 'failed': Whether the report is 'complete', 'pending' or 'failed'.
    - `statusDetails` object: Additional information about the status of the report (if applicable)
      - `message` string: A message describing the status of the report, e.g. an error if the report status is 'failed'
  - `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.dev/moneyhubenterprise/apis/moneyhub-data-api-v3.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/revisions/2e08b5dbee56?raw)