API V2 Route: Related Human Relationships

Last updated: October 5, 2026

General Details:

Endpoint	`/api/v2/related-human-relationships`
Headers	`Authorization: <JWT>`
HTTP Methods	`GET`
Request Body Format	`N/A`
Response Body Format	`JSON`
Required Scopes	`RELATED_HUMAN_RELATIONSHIPS_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	A string or complex string filter can be utilized

API Response:

Field Name	Data Type	Notes
id	string	Globally unique identifier
name	string

Example Collection Response:

{
	"entities": [
		{
			"id": "1",
			"name": "emergency"
		},
		{
			"id": "2",
			"name": "parent/guardian"
		}
	],
	"metaData": {
		"agentId": "634afe7e-b41d-470e-98c1-c9fb147e7226",
		"rateLimits": {
			"tenant": {
				"limit": 50,
				"remaining": 49,
				"reset": 1761924351000
			},
			"agent": {
				"limit": 10,
				"remaining": 9,
				"reset": 1761924351000
			}
		},
		"pagination": {
			"offset": 0,
			"limit": 2
		}
	}
}