Get all relations for a contact person. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the relation.
Get All Relations for a Contact Person
Retrieves the list of relations that a specific contact person is linked to.
A developer calls this endpoint to see which relations, for example a Supplier, Organisation, EstateAgent, Owner, or even another Person, a given contact person is associated with. This is the reverse lookup of Get All Contacts for a Relation.
The contact person is located via reference or externalIdentifier, at least one of which must be supplied.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Required (at least one of reference or externalIdentifier must be given) | The internal identifier of the contact person whose relations should be retrieved. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the contact person whose relations should be retrieved. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string, nullable | Optional | The internal identifier (Reference/Code) of the relation this contact person is linked to. |
type | string, nullable | Optional | The type of the linked relation, returned as its name rather than a numeric code. Observed values: "Person", "Organisation", "Supplier", "Owner", "EstateAgent". "Financier" is a defined relation type but has no dedicated endpoints in this API. |
displayName | string, nullable | Optional | The formatted display name of the linked relation. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
Person = 1 Organisation = 2 Supplier = 3 Owner = 4 EstateAgent = 5 Financier = 6
The requested contact person was not found.