Skip to navigation

Read Income Limit

Info for a specific income limit

Authentication

x-api-keystring
API Key authentication via header

Path parameters

incomeLimitIdstringRequired
The id of the income limit

Response

Expected response to a valid request
namestringOptional

Short name of the income limit policy (e.g. “60%”)

amountdoubleOptional
Income limit amount in USD
numHouseholdMembersintegerOptional
Number of people in the household for the income limit
amiPercentagestringOptional

Display-formatted Area Median Income (AMI) percentage for the income limit (e.g. “50%”, “60%”, “80%”). Use equality filtering only (e.g. amiPercentage=60%).

effectiveDatedateOptional
Date when the income limit became effective
overIncomeThresholdPercentagestringOptional

Over-income tolerance percentage for the program (e.g. “140%” for LIHTC, “80%” for HOME). Households exceeding the income limit but within this threshold may still qualify under program rules.

programDescriptionstringOptional

Full descriptive name of the set-aside program (e.g. “51 units at or below 60% of median income”).

idstringOptionalformat: "uuid"
readableIdstringOptional
idempotencyIdstringOptionalformat: "uuid"
createdAtdatetimeOptional
updatedAtdatetimeOptional
deletedAtdatetimeOptional
propertyIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"