Get an existing relation. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the relation.
Get a Relation
Retrieves the general-purpose record of a single existing relation, regardless of its specific type.
Through this operation, a developer can display a specific relation and its associated information, for example when the relation's type (Person, Organisation, Supplier, Owner, EstateAgent, or Financier) isn't known in advance. It's also useful when only the fields common across all relation types are needed, such as resolving a reference to its display name and type before calling the appropriate type-specific endpoint for full details.
This endpoint returns a smaller, type-agnostic subset of fields; it does not return type-specific data such as a person's name fields or a supplier's payment preferences.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Required (at least one of reference or externalIdentifier must be given) | The internal identifier of the relation (equivalent to the relation's Reference/Code in Bloxs). |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the relation. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string, max 100, nullable | Optional | The internal identifier (Reference/Code) of the relation in Bloxs. |
type | string, nullable | Optional | The specific relation type this record represents, returned as its name rather than a numeric code (for example "Person", "Organisation", "Supplier", "Owner", "EstateAgent", or "Financier"). |
displayName | string, max 788 | Required | The formatted display name of the relation. |
languageISOCode | string, max 2, nullable | Optional | ISO 639-1 two-letter language code (for example "nl" or "en") determining the language used in correspondence. |
address.street | string, max 200 | Conditionally required | Street name of the relation's main address. |
address.houseNumber | string, max 40, nullable | Optional | House number of the relation's main address, including any suffix (for example "12A"). |
address.postalCode | string, max 20 | Conditionally required | Postal code of the relation's main address. |
address.city | string, max 200 | Conditionally required | City of the relation's main address. |
address.countryISOCode | string, max 2 | Conditionally required | ISO 3166-1 alpha-2 country code of the relation's main address, for example "NL". |
invoiceAddress.street | string, max 200 | Required (if invoiceAddress is set) | Street name of the address used for invoicing this relation, if different from the main address. |
invoiceAddress.houseNumber | string, max 40, nullable | Optional | House number of the invoice address, including any suffix. |
invoiceAddress.postalCode | string, max 20 | Required (if invoiceAddress is set) | Postal code of the invoice address. |
invoiceAddress.city | string, max 200 | Required (if invoiceAddress is set) | City of the invoice address. |
invoiceAddress.countryISOCode | string, max 2 | Required (if invoiceAddress is set) | ISO 3166-1 alpha-2 country code of the invoice address. |
postalAddress.street | string, max 200 | Required (if postalAddress is set) | Street name of the postal correspondence address, if different from the main address. |
postalAddress.houseNumber | string, max 40, nullable | Optional | House number of the postal address, including any suffix. |
postalAddress.postalCode | string, max 20 | Required (if postalAddress is set) | Postal code of the postal address. |
postalAddress.city | string, max 200 | Required (if postalAddress is set) | City of the postal address. |
postalAddress.countryISOCode | string, max 2 | Required (if postalAddress is set) | ISO 3166-1 alpha-2 country code of the postal address. |
primaryEmailAddresses | array of string, nullable | Optional | The relation's primary email address(es), used for general correspondence. |
invoicesEmailAddresses | array of string, nullable | Optional | Email address(es) that receive invoices for this relation. |
paymentRemindersEmailAddresses | array of string, nullable | Optional | Email address(es) that receive payment reminder correspondence. |
indexationsEmailAddresses | array of string, nullable | Optional | Email address(es) that receive rent or fee indexation notices. |
serviceTicketsEmailAddresses | array of string, nullable | Optional | Email address(es) that receive service or maintenance ticket correspondence. |
purchaseOrdersEmailAddresses | array of string, nullable | Optional | Email address(es) that receive purchase order correspondence. |
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 relation was not found.