> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get all contacts for a relation > Get all contacts for a relation. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the relation. ## OpenAPI ````json GET /api/v1/relations/contacts { "openapi": "3.0.4", "info": { "title": "Relations V1", "description": "# Relation API Documentation\n\nWelcome to the Relationship Management API documentation. This API allows you to perform CRUD operations on various relationship types, including Owners, Persons, Suppliers, Estate Agents, and Organisations. \n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## CRUD Operations \n\nThe API supports CRUD operations for the following relationship types: \n\n- **Owners**\n- **Persons**\n- **Suppliers**\n- **Estate Agents**\n- **Organisations**\n\nFor each relationship type, you can: \n\n- **GET**: Retrieve a list or apply filters.\n- **POST**: Add a new entry.\n- **PUT**: Update existing details.\n- **PATCH**: Apply partial updates.\n- **DELETE**: Remove an entry.\n\nThank you for choosing our Relation API. If you have any questions or need assistance, please contact our support team. \n", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Common" }, { "name": "CommunicationFormAPI" }, { "name": "EstateAgentAPI" }, { "name": "Metadata" }, { "name": "OrganisationAPI" }, { "name": "OwnerAPI" }, { "name": "PersonAPI" }, { "name": "RelationTypeAPI" }, { "name": "SupplierAPI" }, { "name": "SupplierTypeAPI" } ], "paths": { "/api/v1/relations/contacts": { "get": { "tags": [ "ContactPersons" ], "summary": "Get all contacts for a relation", "description": "Get all contacts for a relation. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the relation.", "operationId": "GetContactPersons", "parameters": [ { "name": "reference", "in": "query", "description": "The internal identifier of the model (i.e. Reference, Code, Name, depends on model).", "schema": { "type": "string" } }, { "name": "externalIdentifier", "in": "query", "description": "The external API identifier of the model.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } } } }, "404": { "description": "The requested relation was not found." } }, "x-d360-narrative-url": "

Get All Contacts for a Relation

Retrieves the list of contact persons linked to a specific relation.

A contact person is always a Person relation, shown under the \"Contactpersonen\" tab of the parent relation in Bloxs, for example an employee of a Supplier, Organisation, or EstateAgent.

A developer calls this endpoint to see who to reach out to at a given relation, beyond the relation's own general contact details.

The relation 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 relation whose contacts should be retrieved.

externalIdentifier

string

Required (at least one of reference or externalIdentifier must be given)

The external API identifier of the relation whose contacts should be retrieved.

Response Fields

Field

Type

Required

Description

reference

string, nullable

Optional

The internal identifier (Reference/Code) of the contact person, referring to the underlying Person relation.

externalIdentifier

string, max 100, nullable

Optional

The external API identifier of the contact person, if any.

initials

string, nullable

Optional

The contact person's initials.

firstName

string, nullable

Optional

The contact person's first name.

lastNamePrefix

string, nullable

Optional

A name prefix or particle preceding the last name (for example \"van\" or \"de\").

lastName

string, nullable

Optional

The contact person's last name (surname).

relationType

string, nullable

Optional

The relation type assigned to this contact person, corresponding to relationTypeName on the Person relation.

correspondenceMethod

integer (enum)

Required

How correspondence is delivered to this contact person. Allowed values: 1 = Email, 2 = Post.

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 contact person's address.

address.houseNumber

string, max 40, nullable

Optional

House number of the contact person's address, including any suffix (for example \"12A\").

address.postalCode

string, max 20

Conditionally required

Postal code of the contact person's address.

address.city

string, max 200

Conditionally required

City of the contact person's address.

address.countryISOCode

string, max 2

Conditionally required

ISO 3166-1 alpha-2 country code of the contact person's address, for example \"NL\".

invoiceAddress.street

string, max 200

Required (if invoiceAddress is set)

Street name of the contact person's invoice address, 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 contact person's 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.

phoneNumber

string, nullable

Optional

The contact person's landline phone number.

mobileNumber

string, nullable

Optional

The contact person's mobile phone number.

primaryEmailAddresses

array of string, nullable

Conditionally required

The contact person's primary email address(es), used for general correspondence. Required when correspondenceMethod is set to Email (1).

invoicesEmailAddresses

array of string, nullable

Optional

Email address(es) that receive invoices addressed to this contact person.

paymentRemindersEmailAddresses

array of string, nullable

Optional

Email address(es) that receive payment reminder correspondence addressed to this contact person.

indexationsEmailAddresses

array of string, nullable

Optional

Email address(es) that receive rent or fee indexation notices addressed to this contact person.

serviceTicketsEmailAddresses

array of string, nullable

Optional

Email address(es) that receive service or maintenance ticket correspondence addressed to this contact person.

purchaseOrdersEmailAddresses

array of string, nullable

Optional

Email address(es) that receive purchase order correspondence addressed to this contact person.

portalsEmailAddresses

array of string, nullable

Optional

Email address(es) used for portal-related notifications addressed to this contact person.

otherEmailAddresses

array of string, nullable

Optional

Any additional email address(es) not covered by the categories above.

cocNumber

string, max 256, nullable

Optional

Chamber of Commerce (KVK-style) registration number, if relevant for this contact person.

cocDescription

string, nullable

Optional

Free-text description associated with the Chamber of Commerce registration.

vatNumber

string, max 256, nullable

Optional

The contact person's VAT identification number, if applicable.

remarks

string, nullable

Optional

Free-text internal remarks about this contact person.

" } } }, "components": { "schemas": { "Contact": { "required": [ "correspondenceMethod" ], "type": "object", "properties": { "languageISOCode": { "maxLength": 2, "minLength": 0, "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Address" }, "invoiceAddress": { "$ref": "#/components/schemas/Address" }, "postalAddress": { "$ref": "#/components/schemas/Address" }, "primaryEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "invoicesEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "paymentRemindersEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "indexationsEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "serviceTicketsEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "purchaseOrdersEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "portalsEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "otherEmailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "mobileNumber": { "type": "string", "nullable": true }, "cocNumber": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "cocDescription": { "type": "string", "nullable": true }, "vatNumber": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "correspondenceMethod": { "type": "integer", "description": "Email = 1\nPost = 2", "format": "int32", "x-enumNames": [ "Email", "Post" ] }, "remarks": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "relationType": { "type": "string", "nullable": true }, "initials": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "lastNamePrefix": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Address": { "required": [ "city", "countryISOCode", "postalCode", "street" ], "type": "object", "properties": { "street": { "maxLength": 200, "minLength": 0, "type": "string" }, "houseNumber": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "postalCode": { "maxLength": 20, "minLength": 0, "type": "string" }, "city": { "maxLength": 200, "minLength": 0, "type": "string" }, "countryISOCode": { "maxLength": 2, "minLength": 0, "type": "string" } }, "additionalProperties": false } } } } ````