API V2 Route: Related Humans

Last updated: October 5, 2026

General Details:

Endpoint	`/api/v2/related-humans` and `/api/v2/related-humans/<id>`
Headers	`Authorization: <JWT>`
HTTP Methods	`GET` and `POST`

GET Details:

Request Body Format	`N/A`
Response Body Format	`JSON`
Required Scopes	`RELATED_HUMANS_GET`

Supported Request Filters:

These filters should be query parts in the URL string and follow the standard pattern of <baseUrl>?<key>=<filter>&...

Field Name	Filter Type	Notes
`name`	string or String Filter
`phone`	string or String Filter
`email`	string or String Filter
`relationship`	string or String Filter	The name of the relationship

API Response:

Field Name	Data Type	Notes
id	string	Globally unique identifier
name	string
dateOfBirth	date string	ISO Date string
phone	string
email	string[]
relationshipType	RelatedHumanRelationType or null
relatedProfile	ProfileThin or null
address	PhsysicalAddress or null
relatedHumanType	enum	EMERGENCY_CONTACT, GUARDIAN, MISSING_PERSON_CONTACT, VISITOR

Example Collection Response:

{
	"entities": [
		{
			"id": "1",
			"name": "Darren Leuschke",
			"phone": "+194649476052250",
			"email": "[email protected]",
			"dateOfBirth": "",
			"relatedHumanType": "EMERGENCY_CONTACT", 
			"relationshipType": {
				"id": "1",
				"name": "other"
			},
			"relatedProfile": {
				"id": "14",
				"name": "Rudolph Ryan",
				"sisId": "78xxn"
			},
			"address": {
				"id": "1",
				"streetAddress": "31 Spooner St",
				"streetAddress2": "",
				"city": "Porstmouth",
				"state": "RI",
				"zip": "12345",
				"countryCode": ""
			}
		},
		{
			"id": "2",
			"name": "Randolph Nicolas",
			"phone": "+19927212255930",
			"email": "[email protected]",
			"dateOfBirth": "",
			"relatedHumanType": "GUARDIAN",
			"relationshipType": {
				"id": "1",
				"name": "other"
			},
			"relatedProfile": {
				"id": "23",
				"name": "Stephanie Smith Sr.",
				"sisId": "bychb"
			},
			"address": {
				"id": "1",
				"streetAddress": "31 Spooner St",
				"streetAddress2": "",
				"city": "Porstmouth",
				"state": "RI",
				"zip": "12345",
				"countryCode": ""
			}
		}
	],
	"metaData": {
		"agentId": "634afe7e-b41d-470e-98c1-c9fb147e7226",
		"rateLimits": {
			"tenant": {
				"limit": 50,
				"remaining": 49,
				"reset": 1761929786000
			},
			"agent": {
				"limit": 10,
				"remaining": 9,
				"reset": 1761929786000
			}
		},
		"pagination": {
			"offset": 0,
			"limit": 2
		}
	}
}

POST Details:

Request Body Format	`JSON`
Response Body Format	`JSON`
Required Scopes	`RELATED_PROFILES_POST`

POST Behavior:

Housing.Cloud will create or update the Related Human entity based on the existence (or lack there of) of a Related Human's id.

POST API Request Body:

Housing.Cloud supports batch creation, as such every POST payload should contain an array of objects with the following structure:

API Request:

Field Name	Data Type	Required	Notes
id	string	No	Globally unique identifier
name	string	Yes
dateOfBirth	date string	No	ISO Date string
phone	string	No
email	string[]	No
relationshipTypeId	id of RelatedHumanRelationType	Yes
relatedProfileId	id of ProfileThin	Yes
addressId	id of PhsysicalAddress	No
relatedHumanType	enum	Yes	EMERGENCY_CONTACT, GUARDIAN, MISSING_PERSON_CONTACT, VISITOR