API V2: Shared Generic Data Models
Last updated: October 5, 2026
Housing.Cloud utilizes common data models in API V2 responses to provide consistency and predictability to the data models. Obviously every entity will have its respective type, but there are commonly referenced entities (e.g. Profiles, Cycles, etc.) that are ubiquitous.
Common Standard Data Models
PhysicalAddress
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
streetAddress |
string | The string will may be empty if the value was not provided |
streetAddress2 |
string | The string will may be empty if the value was not provided |
city |
string | The string will may be empty if the value was not provided |
zip |
string | The string will may be empty if the value was not provided |
countryCode |
string | The string will may be empty if the value was not provided |
ProfileEmail
| Field Name | Data Type | Notes |
|---|---|---|
email |
string | |
isPreferred |
boolean | Whether or not the email is the preferred one. A profile should have at maximum, one preferred email |
isAuthEmail |
boolean | Whether or not this email is used for Authentication. This field is solely managed by the Housing.Cloud system |
Common "Thin" Data Models
Below are the type definitions for the common "thin" data models.
ProfileThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | Full name of the Profile |
sisId |
string |
RoleThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | Full name of the Profile |
CycleThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | Full name of the Cycle |
externalTermCode |
string | The external term code of the Cycle |
CostCodeThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | Full name of the Cost Code |
code |
string | The accounting code attribute of the Cost Code |
ProfileFieldThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | Full name of the Profile Field |
type |
string |
MealPlanThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | Full name of the Meal Plan |
externalCode |
string | The external code of the Meal Plan |
TransactionThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
amount |
string | String representation of the Transaction dollar amount |
costCode |
CostCodeThin | Cost Code associated with the Transaction |
TagCategoryThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Tag Category name |
Inventory
BuildingThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Building name |
externalCode |
string | The Building id |
BuildingTypeThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Building Type name |
SuiteThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Suite name |
externalCode |
string | The Suite id |
RoomThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Room name |
externalCode |
string | The Room id |
RoomTypeThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Room Type name |
BedThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Bed name |
externalCode |
string | The Room id |
BedTypeThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Bed Type name |
Forms
FormThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The form name |
FormSubmission
| Field Name | Data Type | Notes |
|---|---|---|
formTemplate |
FormThin | |
sections |
FormSubmissionSection[] |
FormSubmissionSection
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier of the Section |
title |
string | |
questions |
FormSubmissionQuestion[] |
FormSubmissionQuestion
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier of the Section |
title |
string | |
description |
string | |
isRequired |
boolean | |
type |
FormSubmissionQuestionType | |
choices |
FormSubmissionChoice[] or null | |
response |
FormSubmissionAnswer |
FormSubmissionAnswer
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier of the Section |
answer |
string | |
choice |
FormSubmissionChoice or null |
FormSubmissionChoice
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier of the Section |
title |
string | |
tagsToAdd |
string[] | Comma separated list of Tag Captions |
FormSubmissionQuestionType
TEXT |
Freeform text answer |
RADIO |
Exclusive one-of select |
DROPDOWN |
Exclusive one-of select with a vertical UI |
CHECKS |
Multiselect |
RANGE |
Numeric range |
RANKING |
Selection of N choices of an M list size |
FILE |
Attachment upload |
DATE |
|
DATE_AND_TIME |
|
DATE_RANGE |
|
STATIC_TEXT |
Freeform text with no answer |
INV_PREFERENCES |
Legacy Inventory Preferences |
SOCIAL_LINK |
Link to a social media site |
SIGNATURE |
Tasks
TaskAssignment
| Field Name | Data Type | Notes |
|---|---|---|
profile |
ProfileThin or null | |
role |
RoleThin or null |
TaskCategoryThin
| Field Name | Data Type | Notes |
|---|---|---|
id |
string | Globally unique identifier |
name |
string | The Task Category name |