---
title: "Introduction"
slug: "introduction"
updated: 2026-08-20T10:02:54Z
published: 2026-08-20T10:02:54Z
canonical: "www.bloxs.io/introduction"
---

> ## 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.

# Introduction

### Relations v1

The Relations API provides CRUD access to the parties involved in Bloxs' real estate and financial workflows such as Owners, Persons, Suppliers, Estate Agents, and Organisations. Integrators use it to create and maintain master data for these relations, including contact details, addresses, and bank accounts, so that other Bloxs modules such as leases, invoices, and service tickets can reference a consistent set of parties.

The API also exposes a few cross-cutting endpoints. A common "get relation" endpoint retrieves any relation regardless of its type, useful when the caller only has a reference or external identifier and not the relation type. Separate lookup endpoints return the full list of relation types and supplier types configured in the system, used to validate or populate values such as `relationTypeName` and `supplierTypeName` before creating a record. Contact person endpoints retrieve all contacts linked to a relation, and conversely all relations linked to a given contact person. An admin endpoint returns the available communication forms, the allowed values for how a relation should be corresponded with, such as email or post.

A relation can be looked up by either its internal `reference` or its `externalIdentifier`, allowing integrators to use their own external system's identifier as an alternative to the Bloxs internal one.