Introduction

Prev Next

Relations v1

Relation API Documentation

This API allows you to perform CRUD operations on multiple relation types, including persons, organisations, suppliers, estate agents and owners.


Authentication

To access the API, include your API key in the request headers. Refer to the Authorization documentation for instructions on obtaining and using your API key.


CRUD Operations

The API supports CRUD operations for the following relation types:

  • Persons

  • Organisations

  • Suppliers

  • Estate Agents

  • Owners

For each relation type, the following operations are available:

  • GET: Retrieve a list of entries or apply filters.

  • POST: Create a new entry.

  • PUT: Update an existing entry (full update).

  • DELETE: Delete an entry.