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 a list of extra relation types

Prev Next
Get
/api/v1/realestateobjects/common/extrarelationtypes

Get a list of existing extra relation types.

Get a list of extra relation types

This endpoint retrieves the list of extra relation types available in Bloxs.

An extra relation type describes the role a linked relation plays for a specific object, for example property manager or object caretaker.

Integrators call this endpoint before setting extraRelations on a building, complex, section, or unit, to know which type names are currently configured, since the list is managed in the Bloxs application and can change over time.


Request Fields

This endpoint takes no request parameters.


Response Fields

Field

Type

Required

Description

(array item)

string

No

Name of an available extra relation type. The response is a plain array of strings, not an array of objects. Values are configurable in the Bloxs application and cannot be managed through the API.

Security
Responses
200

OK

Array of string
string