Get a person

reference

string

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

The internal identifier of the person (equivalent to the person's Reference/Code in Bloxs).

externalIdentifier

string

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

The external API identifier of the person, used when the integrating system tracks its own identifier for the record.

reference

string, max 100

Optional

The internal identifier (Reference/Code) of the person in Bloxs.

externalIdentifier

string, max 100

Optional

The external API identifier previously assigned to this person, if any.

displayName

string

Optional

The formatted display name of the person, typically composed from initials, first name, last name prefix, and last name.

initials

string, max 20

Optional

The person's initials.

firstName

string, max 200

Optional

The person's first name.

lastNamePrefix

string, max 112

Optional

A name prefix or particle preceding the last name (for example "van" or "de"), common in Dutch naming conventions.

lastName

string, max 200

Required

The person's last name (surname).

dateOfBirth

string (date), nullable

Optional

The person's date of birth, formatted as an ISO 8601 date (YYYY-MM-DD), for example "1985-06-23".

jobTitle

string, max 256

Optional

The person's job title, relevant when the person acts in a professional capacity (for example as a contact for an organisation).

relationTypeName

string, max 256

Required

The name of the relation type assigned to this person. Valid values can be retrieved from the Get all relation types endpoint (GET /api/v1/relations/relationTypes).

communicationFormName

string, max 256

Required

The salutation/gender form used to address this person in correspondence, for example Male, Female, or Unknown by default. This value is used to generate standard correspondence expressions such as the salutation line in letters and emails. Unlike organisations, owners, suppliers, and estate agents (which use a generic salutation such as "Dear Sir/Madam"), persons require this field because correspondence is addressed to an individual. The list of available values is configurable in Bloxs and can be retrieved from the Get all communication forms endpoint (GET /api/v1/relations/communicationForms).

correspondenceMethod

integer (enum)

Required

How correspondence is delivered to this person. Allowed values: 1 = Email, 2 = Post. This value determines which of primaryEmailAddresses or address is mandatory (see below).

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 person's main address. Required when correspondenceMethod is set to Post (2).

address.houseNumber

string, max 40, nullable

Optional

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

address.postalCode

string, max 20

Conditionally required

Postal code of the person's main address. Required when correspondenceMethod is set to Post (2).

address.city

string, max 200

Conditionally required

City of the person's main address. Required when correspondenceMethod is set to Post (2).

address.countryISOCode

string, max 2

Conditionally required

ISO 3166-1 alpha-2 country code of the person's main address, for example "NL". Required when correspondenceMethod is set to Post (2).

invoiceAddress.street

string, max 200

Required (if invoiceAddress is set)

Street name of the address used for invoicing this person, 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.

phoneNumber

string, nullable

Optional

The person's landline phone number.

mobileNumber

string, nullable

Optional

The person's mobile phone number.

primaryEmailAddresses

array of string, nullable

Conditionally required

The 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 for this person.

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.

portalsEmailAddresses

array of string, nullable

Optional

Email address(es) used for portal-related notifications.

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 associated with the person, where applicable (for example a sole proprietor).

cocDescription

string, nullable

Optional

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

vatNumber

string, max 256, nullable

Optional

The person's VAT identification number, used for invoicing and determining VAT/reverse-charge treatment where applicable.

identificationTypes

array of objects, nullable

Optional

Identification documents held for this person. See identificationTypes.identificationTypeItemName and identificationTypes.identificationNumber below.

identificationTypes.identificationTypeItemName

string, max 256

Required (within each entry)

The type of identification document, for example "Passport" or "Driving Licence".

identificationTypes.identificationNumber

string, max 100

Required (within each entry)

The document number for the identification entry.

remarks

string, nullable

Optional

Free-text internal remarks about the person.

archiveDate

string (date), nullable

Optional

The date from which the person is archived, formatted as an ISO 8601 date (YYYY-MM-DD). Null if the person is not archived.