facilioo API

facilioo's API is organized around REST and is entity-based. Our API has predictable, resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded, paginated responses, and uses standard HTTP response codes.

API Design Principle: Entities

📘

What are Entities?

In the facilioo platform, entities are the core domain objects that define the structure and behavior of the system — such as Properties, Units, Parties, or Processes.
They are similar to resources in RESTful APIs but represent more than just endpoints: they are the fundamental building blocks of the application logic, permissions, and workflows.

Entities are used throughout the platform for data modeling, relationship handling, and feature configuration.

Our API returns flat entities. References to related entities are made via <referenced-entity-name>Id properties.

• These ID fields point to related resources but are not expanded by default.
• To retrieve details of a related entity, perform an additional request to the respective resource using the <referenced-entity-name>Id.
• In most cases, the name of the ID field aligns with the related entity (e.g., entranceId → /api/entrances/{id}).
• However, there are some exceptions, especially for sub-entities (e.g., unit.typeId → /api/unit-type/{id})

Environments

facilioo provides three environments. One for production and two for testing (development and staging). The staging environment includes the same data as production with 3–6 weeks old data, so you can use it for testing with real data. To access the development environment, you need an account, which you can get by emailing us to [email protected].

The endpoints are:

production: https://api.facilioo.de/api (Web access via https://app.facilioo.de)

staging: https://stage-api.facilioo.de/api (Web access via https://stage-app.facilioo.de)

development: https://dev-api.facilioo.de/api (Web access via https://dev-app.facilioo.de)

You can find all endpoints in the API Reference by expanding “Base URL” as well.

API Reference

If you want to test some endpoints or just want to see what's available, feel free to check out our explorable API Reference. You can also work with this API with tools that you are already familiar with, as Swagger UI and Postman, but be sure to check out the referenced resources below.

📘

Quick Start

Refer to our quick start guide and the concepts in our API Reference to get a first understanding of our API.

Swagger UI

Our API documentation is also available as Swagger UI here: https://api.facilioo.de/swagger/index.html

This is also available for the different environments, if you want to access features or changes that are not yet published to production.

Postman

To quickly get started with the facilioo API, you can also use Postman. You can download Postman here: https://www.postman.com/downloads/

To unlock the full potential of Postman, be sure to import the swagger.json of the environment you want to work with.