---
updatedAt: 2025-08-27T15:58:56.000Z
agentTools:
  projectIndex: https://docs.moneyhubenterprise.com/v2.5/llms.txt
---

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

Requires **affordability_income:read** scope.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Documentation for the Moneyhub data API. <br/>Authentication is via bearer token. <br/>",
    "title": "Moneyhub Data API",
    "version": "2.0.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/affordability/income": {
      "get": {
        "summary": "List of metadata for all affordability income calculations for a user",
        "description": "Requires **affordability_income:read** scope.",
        "parameters": [
          {
            "description": "The total number of records to retrieve",
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000
            }
          },
          {
            "description": "The offset at which to start retrieving records",
            "in": "query",
            "name": "offset",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Affordability Income Response",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/AffordabilityIncomeMetadata"
                      }
                    },
                    "links": {
                      "$ref": "#/components/schemas/Links"
                    },
                    "meta": {
                      "type": "object"
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Unsuccessful Response - Forbidden - Invalid scopes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Unsuccessful Response - Resource Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "tags": [
          "affordability"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://api.moneyhub.co.uk/v2.0"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "AffordabilityIncomeMetadata": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "createdAt": {
            "description": "The timestamp at which the report was generated",
            "type": "string"
          },
          "id": {
            "description": "The report id",
            "type": "string"
          }
        },
        "example": {
          "createdAt": "2022-01-01T00:00:00Z",
          "id": "d372d09b-f50a-4114-9c83-687828fa8ac2"
        },
        "required": [
          "id"
        ]
      },
      "Links": {
        "additionalProperties": false,
        "properties": {
          "next": {
            "description": "The url to retrieve the next page of results from",
            "format": "uri",
            "type": "string"
          },
          "prev": {
            "description": "The url to retrieve the previous page of results from",
            "format": "uri",
            "type": "string"
          },
          "self": {
            "description": "The url of the current resource(s)",
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "self"
        ],
        "type": "object"
      },
      "Error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "The error code",
            "type": "string"
          },
          "message": {
            "description": "The error message",
            "type": "string"
          },
          "correlationId": {
            "description": "Id that identifies the request and can be used to ask for more details related to the error",
            "type": "string"
          },
          "id": {
            "description": "Id of the resource",
            "type": "string"
          },
          "userId": {
            "description": "UserId of the resource",
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "object"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```