Ethos Ingress: Profiles
Last updated: August 28, 2026
This document describes the expected format of the data required to build the base Profile in Housing.Cloud. Housing.Cloud will only ever READ Profile information from Ethos.
Base Profile
| HC Field | Ethos Route | Required | Explanation/JSON Path |
| id | persons | Yes | id |
| name | persons | Yes | preferred.fullName |
| preferredName | persons | No | category.favored.fullName |
| sisId | persons | Yes | bannerId/colleaguePersonId |
| phone | persons | No | phoneType.mobile |
| dob | persons | No | dateOfBirth |
| personalEmail | persons | No | emailType.personal |
| schoolEmail | persons | Yes | emailType.school |
| addressId | persons | No | addressType.home |
Notes:
- Endpoint:
/persons- Version:
application/vnd.hedtech.integration.v12+json
- Version:
Profile Extensions
Address
Requirements: Home addressId from Persons data
| HC Field | Ethos Route | Required | JSON Path |
| address1 | addresses | Yes | addressLines[0] |
| address2 | addresses | No | addressLines[1] |
| addressCity | addresses | Yes | place.country.region.locality |
| addressState | addresses | Yes | place.country.region.title |
| addressZip | addresses | Yes | place.country.region.postalCode |
Notes:
- Endpoint:
/addresses -
- Version:
application/vnd.hedtech.integration.v11+json
- Version: