Skip to navigation
API ReferenceApplications

List Application Minors

List the minors (household members under 18) on an application. Read-only; use the POST, PUT and DELETE routes to change them. A minor is never a customer until aged up at 18, so /customers does not return minors.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

applicationIdstringRequiredformat: "uuid"
The id of the application

Response

A paged array of the application's minors
idstringformat: "uuid"
Id of the minor. The same id the update and delete minor routes take as minorId.
applicationIdstringformat: "uuid"
firstNamestring or nullOptional
As entered on the application. null when it was left blank.
middleNamestring or nullOptional
lastNamestring or nullOptional
As entered on the application. null when it was left blank.
preferredNamestring or nullOptional
suffixstring or nullOptional
birthDatedate or nullOptional
genderstring or nullOptional
Gender as stored on the application. null when not answered.
relationshipenumOptional
Relationship to the head of household.
studentTypestring or nullOptional

Student type code from the application: f_tK_12 (full-time, kindergarten to grade 12), f_tPost12 (full-time, after grade 12) or p_t (part-time). null when the answer is not a student (n_s, Not a student or No es estudiante) or the question was not answered.

alienRegistrationNumberLastFourstring or nullOptional

Last 4 characters of the alien registration number (A-Number), spaces and dashes removed. null when no number is on file or it has 4 characters or fewer. The full number is never returned.

statusenumOptional

APPLICANT until move-in; RESIDENT while the minor lives in the unit; PRIOR after move-out. A minor who aged up at 18 is not listed (the adult appears as a new customer).

Allowed values:
readableIdstringOptional
idempotencyIdstringOptionalformat: "uuid"
createdAtdatetimeOptional
updatedAtdatetimeOptional
deletedAtdatetimeOptional
householdIdstringOptionalformat: "uuid"

Household of the minor. Not a route: minors are read only under their application.

propertyIdstringOptionalformat: "uuid"
Property of the minor, from the household or, when the minor has no household, from the application.
organizationIdstringOptionalformat: "uuid"