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 every relation that a given contact person is linked to.
A developer calls this endpoint to find out which relations, for example a supplier, organisation, estate agent, owner or another person, a contact person belongs to. This is the reverse lookup of the "Get all contacts for a relation" endpoint, which starts from a relation and returns its contact persons.
Use this endpoint when contact data needs to be resolved back to the relations it serves, for example when synchronising a contact person record from an external system.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Conditional | The internal identifier of the contact person, for example its Reference or Code. Either reference or externalIdentifier must be given. If both are given, both are used to locate the contact person. |
externalIdentifier | string | Conditional | The external API identifier of the contact person. Either reference or externalIdentifier must be given. If both are given, both are used to locate the contact person. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string, nullable | No | The internal identifier of the relation that the contact person is linked to. |
type | integer (int32) | No | The type of the linked relation, returned as a numeric code. Allowed values: 1 (Person), 2 (Organisation), 3 (Supplier), 4 (Owner), 5 (EstateAgent), 6 (Financier). |
displayName | string, nullable | No | 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.