/v1/definitions/{key}/entity-groupsList relationships on this page
Every entity group on the page: several rows that are ONE commercial relationship (a parent and its subsidiaries, an operator and its franchises), with each group's kind, principal and member count. Reach for it when the question is 'which of these companies are the same party'. NOT the named record groups (…/groups): those are curated collections a row may be in several of; a relationship is exclusive.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": [
{
"createdAt": "string",
"createdByUserId": 1.5,
"id": "",
"kind": "string",
"memberCount": 1.5,
"name": "string",
"notes": "string",
"updatedAt": "string"
}
]
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}