{ "openapi": "3.0.1", "info": { "title": "facilioo", "description": "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.", "termsOfService": "https://app.facilioo.de/gbt.html", "contact": { "name": "Marc André Freiheit", "email": "marcandre@freiheit.software" }, "version": "v2.0" }, "servers": [ { "url": "https://api.facilioo.de" }, { "url": "https://stage-api.facilioo.de" }, { "url": "https://dev-api.facilioo.de" }, { "url": "http://localhost:5163" }, { "url": "http://localhost:5162" } ], "paths": { "/api/accounts": { "post": { "tags": [ "Account" ], "summary": "Create Account", "description": "

Create Account

Creates a new account from the provided data, associating it within the requester's scope.

Module: Authentication

Returns: Identity → Accounts → AccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Account" ], "summary": "List Accounts", "description": "

List Accounts

Returns a paginated list of accounts filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Authentication

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/batch": { "post": { "tags": [ "Account" ], "summary": "Batch List Accounts", "description": "

Batch List Accounts

Retrieves accounts matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Authentication

Returns: Identity → Accounts → AccountRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Account" ], "summary": "Update Accounts", "description": "

Update Accounts

Performs an partial update on multiple accounts identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Authentication

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/myself": { "get": { "tags": [ "Account" ], "summary": "Get Myself", "description": "

Get Myself

Returns the account of the currently used authentication token.

Module: Authentication

Returns: Identity → Accounts → AccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/search": { "post": { "tags": [ "Account" ], "summary": "Search Accounts", "description": "

Search Accounts

Performs a search applying filtering, sorting, and pagination criteria within the accounts, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Authentication

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/unblock-recovery-code": { "post": { "tags": [ "Account" ], "summary": "Unblock Recovery Code", "description": "

Unblock Recovery Code

Unblocks a user's recovery code attempts. Requires authentication, either Admin or PropertyManagementCompany account role, and Platform scope.

Module: Authentication

Returns: Identity → Application Requests → UnblockRecoveryCodeResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnblockRecoveryCodeRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnblockRecoveryCodeRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnblockRecoveryCodeRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UnblockRecoveryCodeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnblockRecoveryCodeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnblockRecoveryCodeResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/{id}": { "get": { "tags": [ "Account" ], "summary": "Get Account", "description": "

Get Account

Provides detailed information for a single account identified by its ID, if it falls within the caller’s scope.

Module: Authentication

Returns: Identity → Accounts → AccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Account" ], "summary": "Update Account", "description": "

Update Account

Applies an partial update to an existing account specified by its ID, affecting only accounts within the caller’s permitted scope.

Module: Authentication

Returns: Identity → Accounts → AccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Account" ], "summary": "Delete Account", "description": "

Delete Account

Deletes the specified account, if it falls within the caller’s scope.

Module: Authentication

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/{id}/accessible-accounts": { "get": { "tags": [ "Account" ], "summary": "List Accessible Accounts", "description": "

List Accessible Accounts

Shows the accessible accounts of the given account.

Module: Authentication

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/{id}/account-contact-details": { "get": { "tags": [ "Account" ], "summary": "List Contact Details", "description": "

List Contact Details

Shows the account contact details for the given account.

Module: Authentication

Returns: Master Data → Accounts → Contact Details → AccountContactDetailsRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountContactDetailsRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountContactDetailsRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountContactDetailsRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/{id}/activation-message": { "post": { "tags": [ "Account" ], "summary": "Send Password Recovery Message", "description": "

Send Password Recovery Message

Module: Authentication

Returns: Identity → Application Requests → AccountActivationMessageResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountActivationMessageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountActivationMessageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountActivationMessageResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/{id}/party": { "get": { "tags": [ "Account" ], "summary": "Show Party", "description": "

Show Party

Returns the party of the given account.

Module: Authentication

Returns: Identity → Parties → PartyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/accounts/{id}/password": { "put": { "tags": [ "Account" ], "summary": "Change Password", "description": "

Change Password

Module: Authentication

Returns: Void

Authorization

Required Token Scopes: Platform (0) and Change Password (2)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChangePasswordRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChangePasswordRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChangePasswordRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Void" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Void" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Void" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-contact-details": { "post": { "tags": [ "AccountContactDetails" ], "summary": "Create Account Contact Detail", "description": "

Create Account Contact Detail

Creates a new account contact detail from the provided data, associating it within the requester's scope.

Module: Identity

Returns: Master Data → Accounts → Contact Details → AccountContactDetailsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountContactDetailsWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountContactDetailsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "AccountContactDetails" ], "summary": "List Account Contact Detailses", "description": "

List Account Contact Detailses

Returns a paginated list of account contact detailses filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Master Data → Accounts → Contact Details → AccountContactDetailsRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountContactDetailsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-contact-details/batch": { "post": { "tags": [ "AccountContactDetails" ], "summary": "Batch List Account Contact Detailses", "description": "

Batch List Account Contact Detailses

Retrieves account contact detailses matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Master Data → Accounts → Contact Details → AccountContactDetailsRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountContactDetailsRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "AccountContactDetails" ], "summary": "Update Account Contact Detailses", "description": "

Update Account Contact Detailses

Performs an partial update on multiple account contact detailses identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Identity

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-contact-details/{id}": { "get": { "tags": [ "AccountContactDetails" ], "summary": "Get Account Contact Detail", "description": "

Get Account Contact Detail

Provides detailed information for a single account contact detail identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Master Data → Accounts → Contact Details → AccountContactDetailsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountContactDetailsRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "AccountContactDetails" ], "summary": "Update Account Contact Detail", "description": "

Update Account Contact Detail

Applies an partial update to an existing account contact detail specified by its ID, affecting only account contact detailses within the caller’s permitted scope.

Module: Identity

Returns: Master Data → Accounts → Contact Details → AccountContactDetailsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountContactDetailsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "AccountContactDetails" ], "summary": "Delete Account Contact Detail", "description": "

Delete Account Contact Detail

Deletes the specified account contact detail, if it falls within the caller’s scope.

Module: Identity

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-groups": { "post": { "tags": [ "AccountGroup" ], "summary": "Create Account Group", "description": "

Create Account Group

Creates a new account group from the provided data, associating it within the requester's scope.

Module: Identity

Returns: Master Data → Accounts → Groups → AccountGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AccountGroupWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "AccountGroup" ], "summary": "List Account Groups", "description": "

List Account Groups

Returns a paginated list of account groups filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Master Data → Accounts → Groups → AccountGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-groups/batch": { "post": { "tags": [ "AccountGroup" ], "summary": "Batch List Account Groups", "description": "

Batch List Account Groups

Retrieves account groups matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Master Data → Accounts → Groups → AccountGroupRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountGroupRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "AccountGroup" ], "summary": "Update Account Groups", "description": "

Update Account Groups

Performs an partial update on multiple account groups identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Identity

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-groups/search": { "post": { "tags": [ "AccountGroup" ], "summary": "Search Account Groups", "description": "

Search Account Groups

Performs a search applying filtering, sorting, and pagination criteria within the account groups, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Identity

Returns: Master Data → Accounts → Groups → AccountGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-groups/{id}": { "get": { "tags": [ "AccountGroup" ], "summary": "Get Account Group", "description": "

Get Account Group

Provides detailed information for a single account group identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Master Data → Accounts → Groups → AccountGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountGroupRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "AccountGroup" ], "summary": "Update Account Group", "description": "

Update Account Group

Applies an partial update to an existing account group specified by its ID, affecting only account groups within the caller’s permitted scope.

Module: Identity

Returns: Master Data → Accounts → Groups → AccountGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "AccountGroup" ], "summary": "Delete Account Group", "description": "

Delete Account Group

Deletes the specified account group, if it falls within the caller’s scope.

Module: Identity

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-groups/{id}/permission-mappings": { "get": { "tags": [ "AccountGroup" ], "summary": "List Permission Mappings", "description": "

List Permission Mappings

Module: Identity

Returns: Master Data → Accounts → Groups → AccountGroupPermissionMappingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountGroupPermissionMappingRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountGroupPermissionMappingRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountGroupPermissionMappingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-permissions": { "get": { "tags": [ "AccountPermission" ], "summary": "List Account Permissions", "description": "

List Account Permissions

Returns a paginated list of account permissions filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Master Data → Accounts → Account Permissions → AccountPermissionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountPermissionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-permissions/batch": { "post": { "tags": [ "AccountPermission" ], "summary": "Batch List Account Permissions", "description": "

Batch List Account Permissions

Retrieves account permissions matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Master Data → Accounts → Account Permissions → AccountPermissionRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountPermissionRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-permissions/search": { "post": { "tags": [ "AccountPermission" ], "summary": "Search Account Permissions", "description": "

Search Account Permissions

Performs a search applying filtering, sorting, and pagination criteria within the account permissions, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Identity

Returns: Master Data → Accounts → Account Permissions → AccountPermissionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountPermissionRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/account-permissions/{id}": { "get": { "tags": [ "AccountPermission" ], "summary": "Get Account Permission", "description": "

Get Account Permission

Provides detailed information for a single account permission identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Master Data → Accounts → Account Permissions → AccountPermissionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPermissionRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attendances": { "post": { "tags": [ "Attendance" ], "summary": "Create Attendance", "description": "

Create Attendance

Creates a new attendance from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Attendances → AttendanceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttendanceWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Attendance" ], "summary": "List Attendances", "description": "

List Attendances

Returns a paginated list of attendances filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Attendances → AttendanceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttendanceRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attendances/batch": { "post": { "tags": [ "Attendance" ], "summary": "Batch List Attendances", "description": "

Batch List Attendances

Retrieves attendances matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Attendances → AttendanceRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttendanceRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Attendance" ], "summary": "Update Attendances", "description": "

Update Attendances

Performs an partial update on multiple attendances identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attendances/{id}": { "get": { "tags": [ "Attendance" ], "summary": "Get Attendance", "description": "

Get Attendance

Provides detailed information for a single attendance identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Attendances → AttendanceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Attendance" ], "summary": "Update Attendance", "description": "

Update Attendance

Applies an partial update to an existing attendance specified by its ID, affecting only attendances within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Attendances → AttendanceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Attendance" ], "summary": "Delete Attendance", "description": "

Delete Attendance

Deletes the specified attendance, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attributes": { "post": { "tags": [ "Attribute" ], "summary": "Create Attribute", "description": "

Create Attribute

Creates a new attribute from the provided data, associating it within the requester's scope.

Module: Attributes

Returns: Master Data → Properties → Attributes → AttributeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Attribute" ], "summary": "List Attributes", "description": "

List Attributes

Returns a paginated list of attributes filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Attributes

Returns: Master Data → Properties → Attributes → AttributeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attributes/batch": { "post": { "tags": [ "Attribute" ], "summary": "Batch List Attributes", "description": "

Batch List Attributes

Retrieves attributes matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Attributes

Returns: Master Data → Properties → Attributes → AttributeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Attribute" ], "summary": "Update Attributes", "description": "

Update Attributes

Performs an partial update on multiple attributes identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Attributes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attributes/search": { "post": { "tags": [ "Attribute" ], "summary": "Search Attributes", "description": "

Search Attributes

Performs a search applying filtering, sorting, and pagination criteria within the attributes, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Attributes

Returns: Master Data → Properties → Attributes → AttributeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attributes/{id}": { "get": { "tags": [ "Attribute" ], "summary": "Get Attribute", "description": "

Get Attribute

Provides detailed information for a single attribute identified by its ID, if it falls within the caller’s scope.

Module: Attributes

Returns: Master Data → Properties → Attributes → AttributeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Attribute" ], "summary": "Update Attribute", "description": "

Update Attribute

Applies an partial update to an existing attribute specified by its ID, affecting only attributes within the caller’s permitted scope.

Module: Attributes

Returns: Master Data → Properties → Attributes → AttributeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Attribute" ], "summary": "Delete Attribute", "description": "

Delete Attribute

Deletes the specified attribute, if it falls within the caller’s scope.

Module: Attributes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-groups": { "post": { "tags": [ "AttributeGroup" ], "summary": "Create Attribute Group", "description": "

Create Attribute Group

Creates a new attribute group from the provided data, associating it within the requester's scope.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeGroupWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "AttributeGroup" ], "summary": "List Attribute Groups", "description": "

List Attribute Groups

Returns a paginated list of attribute groups filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-groups/batch": { "post": { "tags": [ "AttributeGroup" ], "summary": "Batch List Attribute Groups", "description": "

Batch List Attribute Groups

Retrieves attribute groups matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeGroupRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "AttributeGroup" ], "summary": "Update Attribute Groups", "description": "

Update Attribute Groups

Performs an partial update on multiple attribute groups identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Attributes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-groups/search": { "post": { "tags": [ "AttributeGroup" ], "summary": "Search Attribute Groups", "description": "

Search Attribute Groups

Performs a search applying filtering, sorting, and pagination criteria within the attribute groups, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeGroupSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-groups/{id}": { "get": { "tags": [ "AttributeGroup" ], "summary": "Get Attribute Group", "description": "

Get Attribute Group

Provides detailed information for a single attribute group identified by its ID, if it falls within the caller’s scope.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeGroupRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "AttributeGroup" ], "summary": "Update Attribute Group", "description": "

Update Attribute Group

Applies an partial update to an existing attribute group specified by its ID, affecting only attribute groups within the caller’s permitted scope.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "AttributeGroup" ], "summary": "Delete Attribute Group", "description": "

Delete Attribute Group

Deletes the specified attribute group, if it falls within the caller’s scope.

Module: Attributes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-groups/{id}/values": { "post": { "tags": [ "AttributeGroup" ], "summary": "Add Attribute Value", "description": "

Add Attribute Value

Module: Attributes

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeValueWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeValueWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeValueWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "AttributeGroup" ], "summary": "List Attribute Values", "description": "

List Attribute Values

Module: Attributes

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-groups/{id}/values/{valueId}": { "delete": { "tags": [ "AttributeGroup" ], "summary": "Remove Attribute Value", "description": "

Remove Attribute Value

Module: Attributes

Returns: Master Data → Properties → Attribute Values → AttributeValueRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeValueRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeValueRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeValueRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-group-types": { "get": { "tags": [ "AttributeGroupType" ], "summary": "List Attribute Group Types", "description": "

List Attribute Group Types

Returns a paginated list of attribute group types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → Types → AttributeGroupTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-group-types/batch": { "post": { "tags": [ "AttributeGroupType" ], "summary": "Batch List Attribute Group Types", "description": "

Batch List Attribute Group Types

Retrieves attribute group types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → Types → AttributeGroupTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeGroupTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-group-types/{id}": { "get": { "tags": [ "AttributeGroupType" ], "summary": "Get Attribute Group Type", "description": "

Get Attribute Group Type

Provides detailed information for a single attribute group type identified by its ID, if it falls within the caller’s scope.

Module: Attributes

Returns: Master Data → Properties → Attribute Groups → Types → AttributeGroupTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeGroupTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-values": { "post": { "tags": [ "AttributeValue" ], "summary": "Create Attribute Value", "description": "

Create Attribute Value

Creates a new attribute value from the provided data, associating it within the requester's scope.

Module: Attributes

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeValueWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NestedAttributeValueRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "AttributeValue" ], "summary": "List Attribute Values", "description": "

List Attribute Values

Returns a paginated list of attribute values filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Attributes

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-values/batch": { "post": { "tags": [ "AttributeValue" ], "summary": "Batch List Attribute Values", "description": "

Batch List Attribute Values

Retrieves attribute values matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Attributes

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NestedAttributeValueRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "AttributeValue" ], "summary": "Update Attribute Values", "description": "

Update Attribute Values

Performs an partial update on multiple attribute values identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Attributes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-values/search": { "post": { "tags": [ "AttributeValue" ], "summary": "Search Attribute Values", "description": "

Search Attribute Values

Performs a search applying filtering, sorting, and pagination criteria within the attribute values, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Attributes

Returns: Master Data → Properties → Attribute Values → AttributeValueRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeValueSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeValueRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/attribute-values/{id}": { "get": { "tags": [ "AttributeValue" ], "summary": "Get Attribute Value", "description": "

Get Attribute Value

Provides detailed information for a single attribute value identified by its ID, if it falls within the caller’s scope.

Module: Attributes

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NestedAttributeValueRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "AttributeValue" ], "summary": "Update Attribute Value", "description": "

Update Attribute Value

Applies an partial update to an existing attribute value specified by its ID, affecting only attribute values within the caller’s permitted scope.

Module: Attributes

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NestedAttributeValueRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "AttributeValue" ], "summary": "Delete Attribute Value", "description": "

Delete Attribute Value

Deletes the specified attribute value, if it falls within the caller’s scope.

Module: Attributes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/auth/api-key-login": { "post": { "tags": [ "Auth" ], "summary": "Login With Api Key", "description": "

Login With Api Key

Authenticates a user using an API key.

Module: Authentication

Returns: Identity → Application Requests → LoginWithApiKeyCommandResponse (single)

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiKeyLoginRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiKeyLoginRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiKeyLoginRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginWithApiKeyCommandResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginWithApiKeyCommandResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginWithApiKeyCommandResponse" } } } } } } }, "/api/auth/challenge/complete": { "post": { "tags": [ "Auth" ], "summary": "Complete Challenge", "description": "

Complete Challenge

Completes the MFA challenge using a token and nonce. Requires authentication and MFA scope.

Module: Authentication

Returns: Identity → Application Requests → LoginCommandResponse (single)

Authorization

Required Token Scopes: Multi Factor Challenge (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompleteChallengeRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompleteChallengeRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CompleteChallengeRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginCommandResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginCommandResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginCommandResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/auth/challenge/get": { "post": { "tags": [ "Auth" ], "summary": "Create Challenge", "description": "

Create Challenge

Creates a multi-factor authentication (MFA) challenge for a user.

Module: Authentication

Returns: Identity → Application Requests → MultiFactorChallenge (single)

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateChalllengeRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateChalllengeRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateChalllengeRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MultiFactorChallenge" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MultiFactorChallenge" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MultiFactorChallenge" } } } } } } }, "/api/auth/challenge/resend": { "post": { "tags": [ "Auth" ], "summary": "Resend Challenge Email", "description": "

Resend Challenge Email

Resends the MFA challenge email to the user. Requires authentication and MFA scope.

Module: Authentication

Returns: Void

Authorization

Required Token Scopes: Multi Factor Challenge (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResendChallengeRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResendChallengeRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResendChallengeRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Void" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Void" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Void" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/auth/change-password-with-recovery-code": { "put": { "tags": [ "Auth" ], "summary": "Change Password With Recovery Code", "description": "

Change Password With Recovery Code

Changes a user's password using a recovery code.

Module: Authentication

Returns: Identity → Application Requests → ChangePasswordWithRecoveryCodeResponse (single)

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChangePasswordWithRecoveryCodeRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChangePasswordWithRecoveryCodeRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChangePasswordWithRecoveryCodeRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChangePasswordWithRecoveryCodeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordWithRecoveryCodeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordWithRecoveryCodeResponse" } } } } }, "deprecated": true } }, "/api/auth/login": { "post": { "tags": [ "Auth" ], "summary": "Login", "description": "

Login

Authenticates a user with email and password.

Module: Authentication

Returns: Identity → Application Requests → LoginCommandResponse (single)

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LoginRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LoginRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LoginRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginCommandResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginCommandResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginCommandResponse" } } } } } } }, "/api/auth/logout": { "post": { "tags": [ "Auth" ], "summary": "Logout", "description": "

Logout

Logout and remove refresh token for a user.

Module: Authentication

Returns: Void

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LogoutRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LogoutRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LogoutRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Void" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Void" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Void" } } } } } } }, "/api/auth/recover-password": { "post": { "tags": [ "Auth" ], "summary": "Send Password Recovery Message", "description": "

Send Password Recovery Message

Sends a password recovery message to the user's email.

Module: Authentication

Returns: Identity → Application Requests → PasswordRecoveryResponse (single)

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PasswordRecoveryRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PasswordRecoveryRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PasswordRecoveryRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryResponse" } } } } }, "deprecated": true } }, "/api/auth/refresh": { "post": { "tags": [ "Auth" ], "summary": "Refresh Token", "description": "

Refresh Token

Refreshes an existing session token to obtain a new access token pair. Used for session continuation.

Module: Authentication

Returns: Identity → Application Requests → TokenPair (single)

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RefreshTokenRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RefreshTokenRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RefreshTokenRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TokenPair" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TokenPair" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TokenPair" } } } } } } }, "/api/auth/sso": { "post": { "tags": [ "Auth" ], "summary": "Create Sso Token", "description": "

Create Sso Token

Creates a Single Sign-On (SSO) token for the authenticated user.

Module: Authentication

Returns: Identity → Application Requests → SsoResponse (single)

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SsoResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SsoResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SsoResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/bank-accounts": { "post": { "tags": [ "BankAccount" ], "summary": "Create Bank Account", "description": "

Create Bank Account

Creates a new bank account from the provided data, associating it within the requester's scope.

Module: Bank Accounts

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BankAccountWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "BankAccount" ], "summary": "List Bank Accounts", "description": "

List Bank Accounts

Returns a paginated list of bank accounts filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Bank Accounts

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/bank-accounts/batch": { "post": { "tags": [ "BankAccount" ], "summary": "Batch List Bank Accounts", "description": "

Batch List Bank Accounts

Retrieves bank accounts matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Bank Accounts

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccountRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "BankAccount" ], "summary": "Update Bank Accounts", "description": "

Update Bank Accounts

Performs an partial update on multiple bank accounts identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Bank Accounts

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/bank-accounts/search": { "post": { "tags": [ "BankAccount" ], "summary": "Search Bank Accounts", "description": "

Search Bank Accounts

Performs a search applying filtering, sorting, and pagination criteria within the bank accounts, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Bank Accounts

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BankAccountSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/bank-accounts/{id}": { "get": { "tags": [ "BankAccount" ], "summary": "Get Bank Account", "description": "

Get Bank Account

Provides detailed information for a single bank account identified by its ID, if it falls within the caller’s scope.

Module: Bank Accounts

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "BankAccount" ], "summary": "Update Bank Account", "description": "

Update Bank Account

Applies an partial update to an existing bank account specified by its ID, affecting only bank accounts within the caller’s permitted scope.

Module: Bank Accounts

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "BankAccount" ], "summary": "Delete Bank Account", "description": "

Delete Bank Account

Deletes the specified bank account, if it falls within the caller’s scope.

Module: Bank Accounts

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booked-platform-products": { "get": { "tags": [ "BookedPlatformProduct" ], "summary": "List Booked Platform Products", "description": "

List Booked Platform Products

Returns a paginated list of booked platform products filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Platform

Returns: Platform → Booked Platform Products → BookedPlatformProductRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBookedPlatformProductRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booked-platform-products/batch": { "post": { "tags": [ "BookedPlatformProduct" ], "summary": "Batch List Booked Platform Products", "description": "

Batch List Booked Platform Products

Retrieves booked platform products matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Platform

Returns: Platform → Booked Platform Products → BookedPlatformProductRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BookedPlatformProductRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booked-platform-products/search": { "post": { "tags": [ "BookedPlatformProduct" ], "summary": "Search Booked Platform Products", "description": "

Search Booked Platform Products

Performs a search applying filtering, sorting, and pagination criteria within the booked platform products, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Platform

Returns: Platform → Booked Platform Products → BookedPlatformProductRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BookedPlatformProductSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBookedPlatformProductRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booked-platform-products/{id}": { "get": { "tags": [ "BookedPlatformProduct" ], "summary": "Get Booked Platform Product", "description": "

Get Booked Platform Product

Provides detailed information for a single booked platform product identified by its ID, if it falls within the caller’s scope.

Module: Platform

Returns: Platform → Booked Platform Products → BookedPlatformProductRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookedPlatformProductRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booking-accounts": { "post": { "tags": [ "BookingAccount" ], "summary": "Create Booking Account", "description": "

Create Booking Account

Creates a new booking account from the provided data, associating it within the requester's scope.

Module: Booking Accounts

Returns: Financial → Booking Accounts → BookingAccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BookingAccountWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingAccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "BookingAccount" ], "summary": "List Booking Accounts", "description": "

List Booking Accounts

Returns a paginated list of booking accounts filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Booking Accounts

Returns: Financial → Booking Accounts → BookingAccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBookingAccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booking-accounts/batch": { "post": { "tags": [ "BookingAccount" ], "summary": "Batch List Booking Accounts", "description": "

Batch List Booking Accounts

Retrieves booking accounts matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Booking Accounts

Returns: Financial → Booking Accounts → BookingAccountRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BookingAccountRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "BookingAccount" ], "summary": "Update Booking Accounts", "description": "

Update Booking Accounts

Performs an partial update on multiple booking accounts identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Booking Accounts

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booking-accounts/search": { "post": { "tags": [ "BookingAccount" ], "summary": "Search Booking Accounts", "description": "

Search Booking Accounts

Performs a search applying filtering, sorting, and pagination criteria within the booking accounts, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Booking Accounts

Returns: Financial → Booking Accounts → BookingAccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BookingAccountSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBookingAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booking-accounts/{id}": { "get": { "tags": [ "BookingAccount" ], "summary": "Get Booking Account", "description": "

Get Booking Account

Provides detailed information for a single booking account identified by its ID, if it falls within the caller’s scope.

Module: Booking Accounts

Returns: Financial → Booking Accounts → BookingAccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingAccountRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "BookingAccount" ], "summary": "Update Booking Account", "description": "

Update Booking Account

Applies an partial update to an existing booking account specified by its ID, affecting only booking accounts within the caller’s permitted scope.

Module: Booking Accounts

Returns: Financial → Booking Accounts → BookingAccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingAccountRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "BookingAccount" ], "summary": "Delete Booking Account", "description": "

Delete Booking Account

Deletes the specified booking account, if it falls within the caller’s scope.

Module: Booking Accounts

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booking-account-items": { "post": { "tags": [ "BookingAccountItem" ], "summary": "Create Booking Account Item", "description": "

Create Booking Account Item

Creates a new booking account item from the provided data, associating it within the requester's scope.

Module: Booking Accounts

Returns: Financial → Booking Account Items → BookingAccountItemRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BookingAccountItemWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingAccountItemRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "BookingAccountItem" ], "summary": "List Booking Account Items", "description": "

List Booking Account Items

Returns a paginated list of booking account items filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Booking Accounts

Returns: Financial → Booking Account Items → BookingAccountItemRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBookingAccountItemRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booking-account-items/batch": { "post": { "tags": [ "BookingAccountItem" ], "summary": "Batch List Booking Account Items", "description": "

Batch List Booking Account Items

Retrieves booking account items matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Booking Accounts

Returns: Financial → Booking Account Items → BookingAccountItemRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BookingAccountItemRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "BookingAccountItem" ], "summary": "Update Booking Account Items", "description": "

Update Booking Account Items

Performs an partial update on multiple booking account items identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Booking Accounts

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booking-account-items/search": { "post": { "tags": [ "BookingAccountItem" ], "summary": "Search Booking Account Items", "description": "

Search Booking Account Items

Performs a search applying filtering, sorting, and pagination criteria within the booking account items, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Booking Accounts

Returns: Financial → Booking Account Items → BookingAccountItemRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BookingAccountItemSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBookingAccountItemRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/booking-account-items/{id}": { "get": { "tags": [ "BookingAccountItem" ], "summary": "Get Booking Account Item", "description": "

Get Booking Account Item

Provides detailed information for a single booking account item identified by its ID, if it falls within the caller’s scope.

Module: Booking Accounts

Returns: Financial → Booking Account Items → BookingAccountItemRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingAccountItemRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "BookingAccountItem" ], "summary": "Update Booking Account Item", "description": "

Update Booking Account Item

Applies an partial update to an existing booking account item specified by its ID, affecting only booking account items within the caller’s permitted scope.

Module: Booking Accounts

Returns: Financial → Booking Account Items → BookingAccountItemRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingAccountItemRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "BookingAccountItem" ], "summary": "Delete Booking Account Item", "description": "

Delete Booking Account Item

Deletes the specified booking account item, if it falls within the caller’s scope.

Module: Booking Accounts

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/call-logs": { "get": { "tags": [ "CallLog" ], "summary": "List Call Logs", "description": "

List Call Logs

Returns a paginated list of call logs filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Integrations

Returns: Integrations → Voice Bot → CallLogRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfCallLogRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/call-logs/batch": { "post": { "tags": [ "CallLog" ], "summary": "Batch List Call Logs", "description": "

Batch List Call Logs

Retrieves call logs matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Integrations

Returns: Integrations → Voice Bot → CallLogRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallLogRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/call-logs/{id}": { "get": { "tags": [ "CallLog" ], "summary": "Get Call Log", "description": "

Get Call Log

Provides detailed information for a single call log identified by its ID, if it falls within the caller’s scope.

Module: Integrations

Returns: Integrations → Voice Bot → CallLogRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-configurations": { "post": { "tags": [ "ChatbotConfiguration" ], "summary": "Create Chatbot Configuration", "description": "

Create Chatbot Configuration

Creates a new chatbot configuration from the provided data, associating it within the requester's scope.

Module: Chatbot

Returns: Chatbot → Chatbot Configurations → ChatbotConfigurationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatbotConfigurationWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConfigurationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ChatbotConfiguration" ], "summary": "List Chatbot Configurations", "description": "

List Chatbot Configurations

Returns a paginated list of chatbot configurations filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Chatbot

Returns: Chatbot → Chatbot Configurations → ChatbotConfigurationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfChatbotConfigurationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-configurations/batch": { "post": { "tags": [ "ChatbotConfiguration" ], "summary": "Batch List Chatbot Configurations", "description": "

Batch List Chatbot Configurations

Retrieves chatbot configurations matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Chatbot

Returns: Chatbot → Chatbot Configurations → ChatbotConfigurationRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotConfigurationRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ChatbotConfiguration" ], "summary": "Update Chatbot Configurations", "description": "

Update Chatbot Configurations

Performs an partial update on multiple chatbot configurations identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Chatbot

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-configurations/{id}": { "get": { "tags": [ "ChatbotConfiguration" ], "summary": "Get Chatbot Configuration", "description": "

Get Chatbot Configuration

Provides detailed information for a single chatbot configuration identified by its ID, if it falls within the caller’s scope.

Module: Chatbot

Returns: Chatbot → Chatbot Configurations → ChatbotConfigurationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConfigurationRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ChatbotConfiguration" ], "summary": "Update Chatbot Configuration", "description": "

Update Chatbot Configuration

Applies an partial update to an existing chatbot configuration specified by its ID, affecting only chatbot configurations within the caller’s permitted scope.

Module: Chatbot

Returns: Chatbot → Chatbot Configurations → ChatbotConfigurationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConfigurationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ChatbotConfiguration" ], "summary": "Delete Chatbot Configuration", "description": "

Delete Chatbot Configuration

Deletes the specified chatbot configuration, if it falls within the caller’s scope.

Module: Chatbot

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-conversations": { "get": { "tags": [ "ChatbotConversation" ], "summary": "List Chatbot Conversations", "description": "

List Chatbot Conversations

Returns a paginated list of chatbot conversations filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Chatbot

Returns: Chatbot → Chatbot Conversations → ChatbotConversationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfChatbotConversationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-conversations/batch": { "post": { "tags": [ "ChatbotConversation" ], "summary": "Batch List Chatbot Conversations", "description": "

Batch List Chatbot Conversations

Retrieves chatbot conversations matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Chatbot

Returns: Chatbot → Chatbot Conversations → ChatbotConversationRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotConversationRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-conversations/search": { "post": { "tags": [ "ChatbotConversation" ], "summary": "Search Chatbot Conversations", "description": "

Search Chatbot Conversations

Performs a search applying filtering, sorting, and pagination criteria within the chatbot conversations, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Chatbot

Returns: Chatbot → Chatbot Conversations → ChatbotConversationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfChatbotConversationRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-conversations/{id}": { "get": { "tags": [ "ChatbotConversation" ], "summary": "Get Chatbot Conversation", "description": "

Get Chatbot Conversation

Provides detailed information for a single chatbot conversation identified by its ID, if it falls within the caller’s scope.

Module: Chatbot

Returns: Chatbot → Chatbot Conversations → ChatbotConversationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConversationRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-conversations/{id}/messages": { "get": { "tags": [ "ChatbotConversation" ], "summary": "List Messages", "description": "

List Messages

Module: Chatbot

Returns: Chatbot → Chatbot Messages → ChatbotMessageRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfChatbotMessageRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfChatbotMessageRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfChatbotMessageRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-messages": { "post": { "tags": [ "ChatbotMessage" ], "summary": "Create Chatbot Message", "description": "

Create Chatbot Message

Creates a new chatbot message from the provided data, associating it within the requester's scope.

Module: Chatbot

Returns: Chatbot → Chatbot Messages → ChatbotMessageRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatbotMessageWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotMessageRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ChatbotMessage" ], "summary": "List Chatbot Messages", "description": "

List Chatbot Messages

Returns a paginated list of chatbot messages filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Chatbot

Returns: Chatbot → Chatbot Messages → ChatbotMessageRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfChatbotMessageRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-messages/batch": { "post": { "tags": [ "ChatbotMessage" ], "summary": "Batch List Chatbot Messages", "description": "

Batch List Chatbot Messages

Retrieves chatbot messages matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Chatbot

Returns: Chatbot → Chatbot Messages → ChatbotMessageRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotMessageRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ChatbotMessage" ], "summary": "Update Chatbot Messages", "description": "

Update Chatbot Messages

Performs an partial update on multiple chatbot messages identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Chatbot

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chatbot-messages/{id}": { "get": { "tags": [ "ChatbotMessage" ], "summary": "Get Chatbot Message", "description": "

Get Chatbot Message

Provides detailed information for a single chatbot message identified by its ID, if it falls within the caller’s scope.

Module: Chatbot

Returns: Chatbot → Chatbot Messages → ChatbotMessageRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotMessageRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ChatbotMessage" ], "summary": "Update Chatbot Message", "description": "

Update Chatbot Message

Applies an partial update to an existing chatbot message specified by its ID, affecting only chatbot messages within the caller’s permitted scope.

Module: Chatbot

Returns: Chatbot → Chatbot Messages → ChatbotMessageRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotMessageRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ChatbotMessage" ], "summary": "Delete Chatbot Message", "description": "

Delete Chatbot Message

Deletes the specified chatbot message, if it falls within the caller’s scope.

Module: Chatbot

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chat-gpt-settings": { "post": { "tags": [ "ChatGptSettings" ], "summary": "Create Chat Gpt Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Create Chat Gpt Setting

Creates a new chat gpt setting from the provided data, associating it within the requester's scope.

Module: Integrations

Returns: Integrations → Ai Assistants → ChatGptSettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ChatGptSettingsWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatGptSettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ChatGptSettings" ], "summary": "List Chat Gpt Settingses", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

List Chat Gpt Settingses

Returns a paginated list of chat gpt settingses filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Integrations

Returns: Integrations → Ai Assistants → ChatGptSettingsRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfChatGptSettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chat-gpt-settings/batch": { "post": { "tags": [ "ChatGptSettings" ], "summary": "Batch List Chat Gpt Settingses", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Batch List Chat Gpt Settingses

Retrieves chat gpt settingses matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Integrations

Returns: Integrations → Ai Assistants → ChatGptSettingsRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatGptSettingsRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ChatGptSettings" ], "summary": "Update Chat Gpt Settingses", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Update Chat Gpt Settingses

Performs an partial update on multiple chat gpt settingses identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Integrations

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/chat-gpt-settings/{id}": { "get": { "tags": [ "ChatGptSettings" ], "summary": "Get Chat Gpt Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Get Chat Gpt Setting

Provides detailed information for a single chat gpt setting identified by its ID, if it falls within the caller’s scope.

Module: Integrations

Returns: Integrations → Ai Assistants → ChatGptSettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatGptSettingsRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ChatGptSettings" ], "summary": "Update Chat Gpt Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Update Chat Gpt Setting

Applies an partial update to an existing chat gpt setting specified by its ID, affecting only chat gpt settingses within the caller’s permitted scope.

Module: Integrations

Returns: Integrations → Ai Assistants → ChatGptSettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatGptSettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ChatGptSettings" ], "summary": "Delete Chat Gpt Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Delete Chat Gpt Setting

Deletes the specified chat gpt setting, if it falls within the caller’s scope.

Module: Integrations

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/cloud-connect-audits": { "post": { "tags": [ "CloudConnectAudit" ], "summary": "Create Cloud Connect Audit", "description": "

Create Cloud Connect Audit

Creates a new cloud connect audit from the provided data, associating it within the requester's scope.

Module: Cloud Connect

Returns: Cloud Connect → CloudConnectAuditRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectAuditWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnectAuditRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "CloudConnectAudit" ], "summary": "List Cloud Connect Audits", "description": "

List Cloud Connect Audits

Returns a paginated list of cloud connect audits filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Cloud Connect

Returns: Cloud Connect → CloudConnectAuditRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfCloudConnectAuditRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/cloud-connect-audits/batch": { "post": { "tags": [ "CloudConnectAudit" ], "summary": "Batch List Cloud Connect Audits", "description": "

Batch List Cloud Connect Audits

Retrieves cloud connect audits matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Cloud Connect

Returns: Cloud Connect → CloudConnectAuditRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudConnectAuditRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "CloudConnectAudit" ], "summary": "Update Cloud Connect Audits", "description": "

Update Cloud Connect Audits

Performs an partial update on multiple cloud connect audits identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Cloud Connect

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/cloud-connect-audits/search": { "post": { "tags": [ "CloudConnectAudit" ], "summary": "Search Cloud Connect Audits", "description": "

Search Cloud Connect Audits

Performs a search applying filtering, sorting, and pagination criteria within the cloud connect audits, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Cloud Connect

Returns: Cloud Connect → CloudConnectAuditRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfCloudConnectAuditRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/cloud-connect-audits/{id}": { "get": { "tags": [ "CloudConnectAudit" ], "summary": "Get Cloud Connect Audit", "description": "

Get Cloud Connect Audit

Provides detailed information for a single cloud connect audit identified by its ID, if it falls within the caller’s scope.

Module: Cloud Connect

Returns: Cloud Connect → CloudConnectAuditRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnectAuditRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "CloudConnectAudit" ], "summary": "Update Cloud Connect Audit", "description": "

Update Cloud Connect Audit

Applies an partial update to an existing cloud connect audit specified by its ID, affecting only cloud connect audits within the caller’s permitted scope.

Module: Cloud Connect

Returns: Cloud Connect → CloudConnectAuditRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnectAuditRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "CloudConnectAudit" ], "summary": "Delete Cloud Connect Audit", "description": "

Delete Cloud Connect Audit

Deletes the specified cloud connect audit, if it falls within the caller’s scope.

Module: Cloud Connect

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/colors": { "get": { "tags": [ "Color" ], "summary": "List Colors", "description": "

List Colors

Returns a paginated list of colors filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Miscellaneous → Colors → ColorRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfColorRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/colors/batch": { "post": { "tags": [ "Color" ], "summary": "Batch List Colors", "description": "

Batch List Colors

Retrieves colors matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Miscellaneous → Colors → ColorRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColorRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/colors/{id}": { "get": { "tags": [ "Color" ], "summary": "Get Color", "description": "

Get Color

Provides detailed information for a single color identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Miscellaneous → Colors → ColorRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColorRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences": { "post": { "tags": [ "Conference" ], "summary": "Create Conference", "description": "

Create Conference

Creates a new conference from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Conferences → ConferenceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceRead" }, "examples": { "Sample Conference": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Innenhof Rechts beim Restaurant","additionalInfo":null,"room":"Raum 201","externalId":"10059d14-0468-47ae-9e54-00b5fbd99ffa","date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":1} }, "Minimal Sample Conference": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":null,"additionalLocation":null,"additionalInfo":null,"room":null,"externalId":null,"date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":2} }, "English Conference Example": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Annual Owners Meeting 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Inner courtyard Behind the fountain","additionalInfo":null,"room":"Room 201","externalId":"a85cda04-974f-435e-a58c-149c0d025b74","date":"2026-11-01T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":2,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":3} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Conference" ], "summary": "List Conferences", "description": "

List Conferences

Returns a paginated list of conferences filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Conferences → ConferenceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceRead" }, "example": {"items":[{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Innenhof Rechts beim Restaurant","additionalInfo":null,"room":"Raum 201","externalId":"10059d14-0468-47ae-9e54-00b5fbd99ffa","date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":1},{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":null,"additionalLocation":null,"additionalInfo":null,"room":null,"externalId":null,"date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":2},{"partyId":null,"propertyManagementCompanyId":null,"title":"Annual Owners Meeting 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Inner courtyard Behind the fountain","additionalInfo":null,"room":"Room 201","externalId":"a85cda04-974f-435e-a58c-149c0d025b74","date":"2026-11-01T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":2,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/batch": { "post": { "tags": [ "Conference" ], "summary": "Batch List Conferences", "description": "

Batch List Conferences

Retrieves conferences matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Conferences → ConferenceRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Conference" ], "summary": "Update Conferences", "description": "

Update Conferences

Performs an partial update on multiple conferences identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/search": { "post": { "tags": [ "Conference" ], "summary": "Search Conferences", "description": "

Search Conferences

Performs a search applying filtering, sorting, and pagination criteria within the conferences, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Conferences → ConferenceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceRead" }, "example": {"items":[{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Innenhof Rechts beim Restaurant","additionalInfo":null,"room":"Raum 201","externalId":"10059d14-0468-47ae-9e54-00b5fbd99ffa","date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":1},{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":null,"additionalLocation":null,"additionalInfo":null,"room":null,"externalId":null,"date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":2},{"partyId":null,"propertyManagementCompanyId":null,"title":"Annual Owners Meeting 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Inner courtyard Behind the fountain","additionalInfo":null,"room":"Room 201","externalId":"a85cda04-974f-435e-a58c-149c0d025b74","date":"2026-11-01T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":2,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{conferenceId}/attendances/{ownerId}": { "get": { "tags": [ "Conference" ], "summary": "Get Attendance", "description": "

Get Attendance

Module: Conferences

Returns: Conferences → Attendances → AttendanceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "conferenceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Conference" ], "summary": "Set Attendance", "description": "

Set Attendance

Module: Conferences

Returns: Conferences → Attendances → AttendanceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "conferenceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SetAttendanceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SetAttendanceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SetAttendanceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{conferenceId}/topics/{topicId}/order": { "post": { "tags": [ "Conference" ], "summary": "Order Topics", "description": "

Order Topics

Module: Conferences

Returns: Conferences → Topics → TopicRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "conferenceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "topicId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderTopicsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderTopicsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderTopicsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}": { "get": { "tags": [ "Conference" ], "summary": "Get Conference", "description": "

Get Conference

Provides detailed information for a single conference identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Conferences → ConferenceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceRead" }, "examples": { "Sample Conference": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Innenhof Rechts beim Restaurant","additionalInfo":null,"room":"Raum 201","externalId":"10059d14-0468-47ae-9e54-00b5fbd99ffa","date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":1} }, "Minimal Sample Conference": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":null,"additionalLocation":null,"additionalInfo":null,"room":null,"externalId":null,"date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":2} }, "English Conference Example": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Annual Owners Meeting 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Inner courtyard Behind the fountain","additionalInfo":null,"room":"Room 201","externalId":"a85cda04-974f-435e-a58c-149c0d025b74","date":"2026-11-01T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":2,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":3} } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Conference" ], "summary": "Update Conference", "description": "

Update Conference

Applies an partial update to an existing conference specified by its ID, affecting only conferences within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Conferences → ConferenceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceRead" }, "examples": { "Sample Conference": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Innenhof Rechts beim Restaurant","additionalInfo":null,"room":"Raum 201","externalId":"10059d14-0468-47ae-9e54-00b5fbd99ffa","date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":1} }, "Minimal Sample Conference": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":null,"additionalLocation":null,"additionalInfo":null,"room":null,"externalId":null,"date":"2026-10-19T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":2} }, "English Conference Example": { "value": {"partyId":null,"propertyManagementCompanyId":null,"title":"Annual Owners Meeting 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Inner courtyard Behind the fountain","additionalInfo":null,"room":"Room 201","externalId":"a85cda04-974f-435e-a58c-149c0d025b74","date":"2026-11-01T12:14:02Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":2,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":3} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Conference" ], "summary": "Delete Conference", "description": "

Delete Conference

Deletes the specified conference, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/agenda": { "post": { "tags": [ "Conference" ], "summary": "Get Agenda Document", "description": "

Get Agenda Document

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AgendaCreate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AgendaCreate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AgendaCreate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } }, "application/vnd.openxmlformats-officedocument.wordprocessingml.document": { "schema": { "type": "string", "format": "byte" } }, "text/html": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/agenda-from-template": { "post": { "tags": [ "Conference" ], "summary": "Get Agenda Document From Template", "description": "

Get Agenda Document From Template

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceDocumentCreateFromTemplate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceDocumentCreateFromTemplate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceDocumentCreateFromTemplate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/attachments": { "get": { "tags": [ "Conference" ], "summary": "List Attachments", "description": "

List Attachments

Module: Conferences

Returns: Documents → Files → FileAttachmentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileAttachmentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileAttachmentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileAttachmentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/attendances": { "get": { "tags": [ "Conference" ], "summary": "List Attendances", "description": "

List Attendances

Module: Conferences

Returns: Conferences → Attendances → AttendanceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttendanceRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttendanceRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttendanceRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/checklist": { "get": { "tags": [ "Conference" ], "summary": "Show Checklist", "description": "

Show Checklist

Module: Conferences

Returns: Conferences → Conferences → ConferenceChecklist (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConferenceChecklist" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceChecklist" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConferenceChecklist" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/cover-letter-from-template": { "post": { "tags": [ "Conference" ], "summary": "Get Cover Letter Document From Template", "description": "

Get Cover Letter Document From Template

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupDocumentCreateFromTemplate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupDocumentCreateFromTemplate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupDocumentCreateFromTemplate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/document-stacks": { "post": { "tags": [ "Conference" ], "summary": "Generate Document Stack", "description": "

Generate Document Stack

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateDocumentStackRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateDocumentStackRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GenerateDocumentStackRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Void" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Void" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Void" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/eligible-units": { "get": { "tags": [ "Conference" ], "summary": "List Eligible Units", "description": "

List Eligible Units

Module: Conferences

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Conference" ], "summary": "Set Eligible Units", "description": "

Set Eligible Units

Module: Conferences

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/events": { "get": { "tags": [ "Conference" ], "summary": "Get Conference Events", "description": "

Get Conference Events

Module: Conferences

Returns: Conferences → Conference Events → ConferenceEventRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceEventRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceEventRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceEventRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/generate-invitation-letters": { "post": { "tags": [ "Conference" ], "summary": "Generate Invitation Letters", "description": "

Generate Invitation Letters

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/mandates": { "get": { "tags": [ "Conference" ], "summary": "Get Mandates", "description": "

Get Mandates

Module: Conferences

Returns: Conferences → Mandates → MandateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfMandateRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfMandateRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfMandateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/mandate-from-template": { "post": { "tags": [ "Conference" ], "summary": "Get Mandate Document From Template", "description": "

Get Mandate Document From Template

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupDocumentCreateFromTemplate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupDocumentCreateFromTemplate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupDocumentCreateFromTemplate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/non-collection-resolutions": { "get": { "tags": [ "Conference" ], "summary": "Get Non Collection Resolutions", "description": "

Get Non Collection Resolutions

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:02 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:02 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:02 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/onsite-presentation-image": { "get": { "tags": [ "Conference" ], "summary": "Download Image", "description": "

Download Image

Module: Conferences

Returns: Documents → Files → FileDownloadResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/owners-available-for-mandates": { "get": { "tags": [ "Conference" ], "summary": "List Owners Available For Mandates", "description": "

List Owners Available For Mandates

Module: Conferences

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/predefined-votes": { "get": { "tags": [ "Conference" ], "summary": "Get Predefined Votes", "description": "

Get Predefined Votes

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPredefinedVoteRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPredefinedVoteRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPredefinedVoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/property": { "get": { "tags": [ "Conference" ], "summary": "Get Property", "description": "

Get Property

Module: Conferences

Returns: Master Data → Properties → Properties → PropertyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4} } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/protocol": { "post": { "tags": [ "Conference" ], "summary": "Get Protocol Document", "description": "

Get Protocol Document

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProtocolCreate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProtocolCreate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProtocolCreate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } }, "application/vnd.openxmlformats-officedocument.wordprocessingml.document": { "schema": { "type": "string", "format": "byte" } }, "text/html": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/protocol-from-template": { "post": { "tags": [ "Conference" ], "summary": "Get Protocol Document From Template", "description": "

Get Protocol Document From Template

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceDocumentCreateFromTemplate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceDocumentCreateFromTemplate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceDocumentCreateFromTemplate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/resolutions": { "get": { "tags": [ "Conference" ], "summary": "Get Resolutions", "description": "

Get Resolutions

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:02 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:02 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:02 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/resolution-collection": { "get": { "tags": [ "Conference" ], "summary": "Get Resolution Collection", "description": "

Get Resolution Collection

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:02 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/resolution-collection-document": { "get": { "tags": [ "Conference" ], "summary": "Get Resolution Collection Document", "description": "

Get Resolution Collection Document

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "byte" } }, "application/pdf": { "schema": { "type": "string", "format": "byte" } }, "text/csv": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/resolution-collection-votes-document": { "get": { "tags": [ "Conference" ], "summary": "Get Resolution Collection Votes Document", "description": "

Get Resolution Collection Votes Document

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/csv": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/resolution-options": { "get": { "tags": [ "Conference" ], "summary": "Get Resolution Options", "description": "

Get Resolution Options

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/results": { "get": { "tags": [ "Conference" ], "summary": "Get Results Document", "description": "

Get Results Document

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/roles": { "get": { "tags": [ "Conference" ], "summary": "List Roles", "description": "

List Roles

Module: Conferences

Returns: Conferences → Roles → ConferenceRole (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceRole" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Conference" ], "summary": "Set Roles", "description": "

Set Roles

Module: Conferences

Returns: Conferences → Roles → ConferenceRole (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRole" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRole" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRole" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRole" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRole" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRole" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/signees": { "get": { "tags": [ "Conference" ], "summary": "List Signees", "description": "

List Signees

Module: Conferences

Returns: Conferences → Signees → SigneeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSigneeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSigneeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSigneeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/technical-protocol": { "get": { "tags": [ "Conference" ], "summary": "Get Conference Event Document", "description": "

Get Conference Event Document

Module: Conferences

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/topics": { "get": { "tags": [ "Conference" ], "summary": "Get Topics", "description": "

Get Topics

Module: Conferences

Returns: Conferences → Topics → TopicRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicRead" }, "example": {"items":[{"number":1,"title":"Begrüßung und Protokoll","description":"Die Verwaltung begrüßt die Liegenschaft zur diesjährigen Versammlung und ernennt Herrn Müller als Protokollant.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"title":"Amendment of the house rules for bicycle storage","description":"Ms Franke suggested renewing the parking spaces for the bicycles. We have obtained several offers from three different companies.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicRead" }, "example": {"items":[{"number":1,"title":"Begrüßung und Protokoll","description":"Die Verwaltung begrüßt die Liegenschaft zur diesjährigen Versammlung und ernennt Herrn Müller als Protokollant.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"title":"Amendment of the house rules for bicycle storage","description":"Ms Franke suggested renewing the parking spaces for the bicycles. We have obtained several offers from three different companies.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicRead" }, "example": {"items":[{"number":1,"title":"Begrüßung und Protokoll","description":"Die Verwaltung begrüßt die Liegenschaft zur diesjährigen Versammlung und ernennt Herrn Müller als Protokollant.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":3,"title":"Amendment of the house rules for bicycle storage","description":"Ms Franke suggested renewing the parking spaces for the bicycles. We have obtained several offers from three different companies.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:02Z","lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/voting-groups": { "get": { "tags": [ "Conference" ], "summary": "List Voting Groups", "description": "

List Voting Groups

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/voting-groups/shares": { "get": { "tags": [ "Conference" ], "summary": "List Voting Group Shares", "description": "

List Voting Group Shares

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupShares (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupShares" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupShares" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupShares" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/voting-sessions": { "get": { "tags": [ "Conference" ], "summary": "Get Voting Sessions", "description": "

Get Voting Sessions

Module: Conferences

Returns: Conferences → Voting → Sessions → VotingSessionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingSessionRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingSessionRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingSessionRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-document-settings": { "post": { "tags": [ "ConferenceDocumentSettings" ], "summary": "Create Conference Document Setting", "description": "

Create Conference Document Setting

Creates a new conference document setting from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Document Settings → DocumentSettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentSettingsWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ConferenceDocumentSettings" ], "summary": "List Conference Document Settingses", "description": "

List Conference Document Settingses

Returns a paginated list of conference document settingses filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Document Settings → DocumentSettingsRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentSettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-document-settings/batch": { "post": { "tags": [ "ConferenceDocumentSettings" ], "summary": "Batch List Conference Document Settingses", "description": "

Batch List Conference Document Settingses

Retrieves conference document settingses matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Document Settings → DocumentSettingsRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSettingsRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConferenceDocumentSettings" ], "summary": "Update Conference Document Settingses", "description": "

Update Conference Document Settingses

Performs an partial update on multiple conference document settingses identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-document-settings/global": { "get": { "tags": [ "ConferenceDocumentSettings" ], "summary": "Show Global Settings", "description": "

Show Global Settings

Module: Conferences

Returns: Conferences → Document Settings → DocumentSettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentSettingsRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSettingsRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentSettingsRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-document-settings/{id}": { "get": { "tags": [ "ConferenceDocumentSettings" ], "summary": "Get Conference Document Setting", "description": "

Get Conference Document Setting

Provides detailed information for a single conference document setting identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Document Settings → DocumentSettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSettingsRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConferenceDocumentSettings" ], "summary": "Update Conference Document Setting", "description": "

Update Conference Document Setting

Applies an partial update to an existing conference document setting specified by its ID, affecting only conference document settingses within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Document Settings → DocumentSettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ConferenceDocumentSettings" ], "summary": "Delete Conference Document Setting", "description": "

Delete Conference Document Setting

Deletes the specified conference document setting, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-document-templates": { "post": { "tags": [ "ConferenceDocumentTemplate" ], "summary": "Create Conference Document Template", "description": "

Create Conference Document Template

Creates a new conference document template from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Document Templates → DocumentTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentTemplateWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ConferenceDocumentTemplate" ], "summary": "List Conference Document Templates", "description": "

List Conference Document Templates

Returns a paginated list of conference document templates filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Document Templates → DocumentTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-document-templates/batch": { "post": { "tags": [ "ConferenceDocumentTemplate" ], "summary": "Batch List Conference Document Templates", "description": "

Batch List Conference Document Templates

Retrieves conference document templates matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Document Templates → DocumentTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentTemplateRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConferenceDocumentTemplate" ], "summary": "Update Conference Document Templates", "description": "

Update Conference Document Templates

Performs an partial update on multiple conference document templates identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-document-templates/search": { "post": { "tags": [ "ConferenceDocumentTemplate" ], "summary": "Search Conference Document Templates", "description": "

Search Conference Document Templates

Performs a search applying filtering, sorting, and pagination criteria within the conference document templates, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Document Templates → DocumentTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentTemplateSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentTemplateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-document-templates/{id}": { "get": { "tags": [ "ConferenceDocumentTemplate" ], "summary": "Get Conference Document Template", "description": "

Get Conference Document Template

Provides detailed information for a single conference document template identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Document Templates → DocumentTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTemplateRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConferenceDocumentTemplate" ], "summary": "Update Conference Document Template", "description": "

Update Conference Document Template

Applies an partial update to an existing conference document template specified by its ID, affecting only conference document templates within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Document Templates → DocumentTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ConferenceDocumentTemplate" ], "summary": "Delete Conference Document Template", "description": "

Delete Conference Document Template

Deletes the specified conference document template, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-settings": { "post": { "tags": [ "ConferenceSettings" ], "summary": "Create Conference Setting", "description": "

Create Conference Setting

Creates a new conference setting from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Settings → SettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SettingsWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ConferenceSettings" ], "summary": "List Conference Settingses", "description": "

List Conference Settingses

Returns a paginated list of conference settingses filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Settings → SettingsRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-settings/batch": { "post": { "tags": [ "ConferenceSettings" ], "summary": "Batch List Conference Settingses", "description": "

Batch List Conference Settingses

Retrieves conference settingses matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Settings → SettingsRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SettingsRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConferenceSettings" ], "summary": "Update Conference Settingses", "description": "

Update Conference Settingses

Performs an partial update on multiple conference settingses identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-settings/global": { "get": { "tags": [ "ConferenceSettings" ], "summary": "Show Global Settings", "description": "

Show Global Settings

Module: Conferences

Returns: Conferences → Settings → SettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SettingsRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SettingsRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SettingsRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-settings/{id}": { "get": { "tags": [ "ConferenceSettings" ], "summary": "Get Conference Setting", "description": "

Get Conference Setting

Provides detailed information for a single conference setting identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Settings → SettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConferenceSettings" ], "summary": "Update Conference Setting", "description": "

Update Conference Setting

Applies an partial update to an existing conference setting specified by its ID, affecting only conference settingses within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Settings → SettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ConferenceSettings" ], "summary": "Delete Conference Setting", "description": "

Delete Conference Setting

Deletes the specified conference setting, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-votes": { "post": { "tags": [ "ConferenceVote" ], "summary": "Create Conference Vote", "description": "

Create Conference Vote

Creates a new conference vote from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Voting → Votes → ConferenceVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConferenceVoteWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ConferenceVote" ], "summary": "List Conference Votes", "description": "

List Conference Votes

Returns a paginated list of conference votes filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Voting → Votes → ConferenceVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-votes/batch": { "post": { "tags": [ "ConferenceVote" ], "summary": "Batch List Conference Votes", "description": "

Batch List Conference Votes

Retrieves conference votes matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Voting → Votes → ConferenceVoteRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceVoteRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConferenceVote" ], "summary": "Update Conference Votes", "description": "

Update Conference Votes

Performs an partial update on multiple conference votes identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conference-votes/{id}": { "get": { "tags": [ "ConferenceVote" ], "summary": "Get Conference Vote", "description": "

Get Conference Vote

Provides detailed information for a single conference vote identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Voting → Votes → ConferenceVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceVoteRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConferenceVote" ], "summary": "Update Conference Vote", "description": "

Update Conference Vote

Applies an partial update to an existing conference vote specified by its ID, affecting only conference votes within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Voting → Votes → ConferenceVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ConferenceVote" ], "summary": "Delete Conference Vote", "description": "

Delete Conference Vote

Deletes the specified conference vote, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/connects": { "post": { "tags": [ "Connect" ], "summary": "Create Connect", "description": "

Create Connect

Creates a new connect from the provided data, associating it within the requester's scope.

Module: Integrations

Returns: Integrations → Connect → ConnectRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConnectWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Connect" ], "summary": "List Connects", "description": "

List Connects

Returns a paginated list of connects filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Integrations

Returns: Integrations → Connect → ConnectRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConnectRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/connects/batch": { "post": { "tags": [ "Connect" ], "summary": "Batch List Connects", "description": "

Batch List Connects

Retrieves connects matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Integrations

Returns: Integrations → Connect → ConnectRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Connect" ], "summary": "Update Connects", "description": "

Update Connects

Performs an partial update on multiple connects identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Integrations

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/connects/search": { "post": { "tags": [ "Connect" ], "summary": "Search Connects", "description": "

Search Connects

Performs a search applying filtering, sorting, and pagination criteria within the connects, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Integrations

Returns: Integrations → Connect → ConnectRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConnectSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConnectRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/connects/{id}": { "get": { "tags": [ "Connect" ], "summary": "Get Connect", "description": "

Get Connect

Provides detailed information for a single connect identified by its ID, if it falls within the caller’s scope.

Module: Integrations

Returns: Integrations → Connect → ConnectRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Connect" ], "summary": "Update Connect", "description": "

Update Connect

Applies an partial update to an existing connect specified by its ID, affecting only connects within the caller’s permitted scope.

Module: Integrations

Returns: Integrations → Connect → ConnectRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Connect" ], "summary": "Delete Connect", "description": "

Delete Connect

Deletes the specified connect, if it falls within the caller’s scope.

Module: Integrations

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-brands": { "get": { "tags": [ "ConsumptionBrand" ], "summary": "List Consumption Brands", "description": "

List Consumption Brands

Returns a paginated list of consumption brands filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Consumptions

Returns: Consumptions → Brands → ConsumptionBrandRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionBrandRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-brands/batch": { "post": { "tags": [ "ConsumptionBrand" ], "summary": "Batch List Consumption Brands", "description": "

Batch List Consumption Brands

Retrieves consumption brands matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Consumptions

Returns: Consumptions → Brands → ConsumptionBrandRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionBrandRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-brands/search": { "post": { "tags": [ "ConsumptionBrand" ], "summary": "Search Consumption Brands", "description": "

Search Consumption Brands

Performs a search applying filtering, sorting, and pagination criteria within the consumption brands, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Consumptions

Returns: Consumptions → Brands → ConsumptionBrandRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionBrandRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-brands/{id}": { "get": { "tags": [ "ConsumptionBrand" ], "summary": "Get Consumption Brand", "description": "

Get Consumption Brand

Provides detailed information for a single consumption brand identified by its ID, if it falls within the caller’s scope.

Module: Consumptions

Returns: Consumptions → Brands → ConsumptionBrandRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionBrandRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters": { "get": { "tags": [ "ConsumptionMeter" ], "summary": "List Consumption Meters", "description": "

List Consumption Meters

Returns a paginated list of consumption meters filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Consumptions

Returns: Consumptions → Meters → ConsumptionMeterRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionMeterRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters/assigned-reader-parties": { "post": { "tags": [ "ConsumptionMeter" ], "summary": "List Consumption Meter Assigned Reader Parties", "description": "

List Consumption Meter Assigned Reader Parties

Lists the assigned reading parties of the specified consumption meters and/or consumption meters that belong to a assigned reader party.

Module: Consumptions

Returns: Consumptions → Meters → ConsumptionMeterAssignedReaderParty (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionMeterAccessibleRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionMeterAccessibleRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionMeterAccessibleRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionMeterAssignedReaderParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionMeterAssignedReaderParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionMeterAssignedReaderParty" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters/batch": { "post": { "tags": [ "ConsumptionMeter" ], "summary": "Batch List Consumption Meters", "description": "

Batch List Consumption Meters

Retrieves consumption meters matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Consumptions

Returns: Consumptions → Meters → ConsumptionMeterRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionMeterRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters/consumption-document": { "post": { "tags": [ "ConsumptionMeter" ], "summary": "Get Consumption Document", "description": "

Get Consumption Document

Module: Consumptions

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "byte" } }, "text/csv": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters/search": { "post": { "tags": [ "ConsumptionMeter" ], "summary": "Search Consumption Meters", "description": "

Search Consumption Meters

Performs a search applying filtering, sorting, and pagination criteria within the consumption meters, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Consumptions

Returns: Consumptions → Meters → ConsumptionMeterRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionMeterSearchRequest" } ], "description": "Represents a search request for filtering and sorting consumption meters based on various criteria. The default sorting is ascending by entity id.\nSorting can be applied using the format: {\"orderBy\": [\"attributename1 desc\", \"attributename2 asc\"]} or {\"orderBy\": [\"attributename\"]}.\nIf the sorting order is not provided or entered anything but `desc`, fallback order is ascending.\nOrderByNextReadingDate: Sorts the meter list by the next scheduled reading date, {\"orderBy\": [\"nextreadingdate desc\"]}.\nIn case we are sorting by attributes that are related to another entity, then we use format {\"orderBy\": [\"relatedentity.sortingcolumname asc\"]}.\nOrderByPropertyAddress: Sorts the meter list by property address (first by street, then by city), {\"orderBy\": [\"meteredproperty.fullstreet asc\"]}.\nOrderByProjectName: Sorts the meter list by project name, {\"orderBy\": [\"tenant.title desc\"]}.\nOrderByMeter: Sorts the meter list first by meter type (e.g., Kaltwasserzähler/Gaszähler) and then by meter number (e.g., 'CA-123'), { \"orderBy\": [\"type.metername desc\"]}.\nOrderByLastReadingDate: Sorts the meter list by the most recent recorded reading date using {\"orderBy\": [\"readings.max(readingdate) asc\"]}.\nSince this includes a one-to-many (1:n) relationship, the sorting is applied first on the related entity (readings), followed by the main entity (meter)." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionMeterRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters/{id}": { "get": { "tags": [ "ConsumptionMeter" ], "summary": "Get Consumption Meter", "description": "

Get Consumption Meter

Provides detailed information for a single consumption meter identified by its ID, if it falls within the caller’s scope.

Module: Consumptions

Returns: Consumptions → Meters → ConsumptionMeterRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionMeterRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters/{id}/accessible-by-parties": { "get": { "tags": [ "ConsumptionMeter" ], "summary": "Get Accessor Parties", "description": "

Get Accessor Parties

Module: Consumptions

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters/{id}/accessible-by-parties/{partyId}": { "put": { "tags": [ "ConsumptionMeter" ], "summary": "Grant Access To Party", "description": "

Grant Access To Party

Module: Consumptions

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-meters/{id}/readings": { "get": { "tags": [ "ConsumptionMeter" ], "summary": "List Attribute Groups", "description": "

List Attribute Groups

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-readings": { "post": { "tags": [ "ConsumptionReading" ], "summary": "Create Consumption Reading", "description": "

Create Consumption Reading

Creates a new consumption reading from the provided data, associating it within the requester's scope.

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionReadingWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionReadingRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ConsumptionReading" ], "summary": "List Consumption Readings", "description": "

List Consumption Readings

Returns a paginated list of consumption readings filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-readings/batch": { "post": { "tags": [ "ConsumptionReading" ], "summary": "Batch List Consumption Readings", "description": "

Batch List Consumption Readings

Retrieves consumption readings matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionReadingRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConsumptionReading" ], "summary": "Update Consumption Readings", "description": "

Update Consumption Readings

Performs an partial update on multiple consumption readings identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Consumptions

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-readings/search": { "post": { "tags": [ "ConsumptionReading" ], "summary": "Search Consumption Readings", "description": "

Search Consumption Readings

Performs a search applying filtering, sorting, and pagination criteria within the consumption readings, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionReadingSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-readings/{id}": { "get": { "tags": [ "ConsumptionReading" ], "summary": "Get Consumption Reading", "description": "

Get Consumption Reading

Provides detailed information for a single consumption reading identified by its ID, if it falls within the caller’s scope.

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionReadingRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ConsumptionReading" ], "summary": "Update Consumption Reading", "description": "

Update Consumption Reading

Applies an partial update to an existing consumption reading specified by its ID, affecting only consumption readings within the caller’s permitted scope.

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionReadingRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ConsumptionReading" ], "summary": "Delete Consumption Reading", "description": "

Delete Consumption Reading

Deletes the specified consumption reading, if it falls within the caller’s scope.

Module: Consumptions

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-readings-extended": { "get": { "tags": [ "ConsumptionReadingExtended" ], "summary": "Get Consumption Readings Extended Query", "description": "

Get Consumption Readings Extended Query

Module: Consumptions

Returns: Consumptions → Consumption Readings → ConsumptionReadingExtended (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingExtended" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingExtended" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingExtended" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-readings-extended/search": { "post": { "tags": [ "ConsumptionReadingExtended" ], "summary": "Get Consumption Readings Extended Query", "description": "

Get Consumption Readings Extended Query

Module: Consumptions

Returns: Consumptions → Consumption Readings → ConsumptionReadingExtended (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionReadingSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingExtended" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-reading-dates": { "get": { "tags": [ "ConsumptionReadingDate" ], "summary": "Get Consumption Readings Extended Query", "description": "

Get Consumption Readings Extended Query

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingDate (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingDate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingDate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingDate" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-reading-dates/search": { "post": { "tags": [ "ConsumptionReadingDate" ], "summary": "Search", "description": "

Search

Module: Consumptions

Returns: Consumptions → Readings → ConsumptionReadingDate (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionReadingDateSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionReadingDate" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-types": { "get": { "tags": [ "ConsumptionType" ], "summary": "List Consumption Types", "description": "

List Consumption Types

Returns a paginated list of consumption types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Consumptions

Returns: Consumptions → Types → ConsumptionTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-types/batch": { "post": { "tags": [ "ConsumptionType" ], "summary": "Batch List Consumption Types", "description": "

Batch List Consumption Types

Retrieves consumption types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Consumptions

Returns: Consumptions → Types → ConsumptionTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-types/search": { "post": { "tags": [ "ConsumptionType" ], "summary": "Search Consumption Types", "description": "

Search Consumption Types

Performs a search applying filtering, sorting, and pagination criteria within the consumption types, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Consumptions

Returns: Consumptions → Types → ConsumptionTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConsumptionTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/consumption-types/{id}": { "get": { "tags": [ "ConsumptionType" ], "summary": "Get Consumption Type", "description": "

Get Consumption Type

Provides detailed information for a single consumption type identified by its ID, if it falls within the caller’s scope.

Module: Consumptions

Returns: Consumptions → Types → ConsumptionTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/contacttypes": { "get": { "tags": [ "ContactType" ], "summary": "List Contact Types", "description": "

List Contact Types

Returns a paginated list of contact types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Master Data → Communication → Contact Types → ContactTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfContactTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/contacttypes/batch": { "post": { "tags": [ "ContactType" ], "summary": "Batch List Contact Types", "description": "

Batch List Contact Types

Retrieves contact types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Master Data → Communication → Contact Types → ContactTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/contacttypes/{id}": { "get": { "tags": [ "ContactType" ], "summary": "Get Contact Type", "description": "

Get Contact Type

Provides detailed information for a single contact type identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Master Data → Communication → Contact Types → ContactTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/contact-details": { "post": { "tags": [ "ContactDetails" ], "summary": "Create Contact Detail", "description": "

Create Contact Detail

Creates a new contact detail from the provided data, associating it within the requester's scope.

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactDetailsWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDetailsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ContactDetails" ], "summary": "List Contact Detailses", "description": "

List Contact Detailses

Returns a paginated list of contact detailses filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfContactDetailsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/contact-details/batch": { "post": { "tags": [ "ContactDetails" ], "summary": "Batch List Contact Detailses", "description": "

Batch List Contact Detailses

Retrieves contact detailses matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetailsRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ContactDetails" ], "summary": "Update Contact Detailses", "description": "

Update Contact Detailses

Performs an partial update on multiple contact detailses identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Identity

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/contact-details/search": { "post": { "tags": [ "ContactDetails" ], "summary": "Search Contact Detailses", "description": "

Search Contact Detailses

Performs a search applying filtering, sorting, and pagination criteria within the contact detailses, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContactDetailsSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfContactDetailsRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/contact-details/{id}": { "get": { "tags": [ "ContactDetails" ], "summary": "Get Contact Detail", "description": "

Get Contact Detail

Provides detailed information for a single contact detail identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDetailsRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ContactDetails" ], "summary": "Update Contact Detail", "description": "

Update Contact Detail

Applies an partial update to an existing contact detail specified by its ID, affecting only contact detailses within the caller’s permitted scope.

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDetailsRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ContactDetails" ], "summary": "Delete Contact Detail", "description": "

Delete Contact Detail

Deletes the specified contact detail, if it falls within the caller’s scope.

Module: Identity

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/customer-apps": { "get": { "tags": [ "CustomerApp" ], "summary": "List Customer Apps", "description": "

List Customer Apps

Returns a paginated list of customer apps filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Customer Apps

Returns: Customer App → Customer Apps → CustomerAppRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfCustomerAppRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/customer-apps/batch": { "post": { "tags": [ "CustomerApp" ], "summary": "Batch List Customer Apps", "description": "

Batch List Customer Apps

Retrieves customer apps matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Customer Apps

Returns: Customer App → Customer Apps → CustomerAppRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAppRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/customer-apps/{bundleId}/customer-app-startup-configuration": { "get": { "tags": [ "CustomerApp" ], "summary": "Get Customer App Startup Configuration By Bundle Id", "description": "

Get Customer App Startup Configuration By Bundle Id

Module: Customer Apps

Returns: Customer App → Customer Apps → CustomerAppStartupConfiguration (single)

", "parameters": [ { "name": "bundleId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } } } }, "401": { "description": "Error: Unauthorized" } } } }, "/api/customer-apps/{id}": { "get": { "tags": [ "CustomerApp" ], "summary": "Get Customer App", "description": "

Get Customer App

Provides detailed information for a single customer app identified by its ID, if it falls within the caller’s scope.

Module: Customer Apps

Returns: Customer App → Customer Apps → CustomerAppRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAppRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/customer-app-custom-contents": { "get": { "tags": [ "CustomerAppCustomContent" ], "summary": "List Customer App Custom Contents", "description": "

List Customer App Custom Contents

Returns a paginated list of customer app custom contents filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Customer Apps

Returns: Customer App → Customer App Custom Contents → CustomerAppCustomContentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfCustomerAppCustomContentRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/customer-app-custom-contents/batch": { "post": { "tags": [ "CustomerAppCustomContent" ], "summary": "Batch List Customer App Custom Contents", "description": "

Batch List Customer App Custom Contents

Retrieves customer app custom contents matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Customer Apps

Returns: Customer App → Customer App Custom Contents → CustomerAppCustomContentRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAppCustomContentRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/customer-app-custom-contents/{id}": { "get": { "tags": [ "CustomerAppCustomContent" ], "summary": "Get Customer App Custom Content", "description": "

Get Customer App Custom Content

Provides detailed information for a single customer app custom content identified by its ID, if it falls within the caller’s scope.

Module: Customer Apps

Returns: Customer App → Customer App Custom Contents → CustomerAppCustomContentRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAppCustomContentRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/customer-app-ids": { "get": { "tags": [ "CustomerApp" ], "summary": "Show Customer App Ids", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Show Customer App Ids

Not used anywhere, afaik. double check with Tobias before deleting. Could be used in an automation for providing the web domain forwards.

Module: Customer Apps

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/documents": { "post": { "tags": [ "Document" ], "summary": "Create Document", "description": "

Create Document

Creates a new document from the provided data, associating it within the requester's scope.

Module: Documents

Returns: Documents → Documents → DocumentRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Document" ], "summary": "List Documents", "description": "

List Documents

Returns a paginated list of documents filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Documents

Returns: Documents → Documents → DocumentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/documents/batch": { "post": { "tags": [ "Document" ], "summary": "Batch List Documents", "description": "

Batch List Documents

Retrieves documents matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Documents

Returns: Documents → Documents → DocumentRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Document" ], "summary": "Update Documents", "description": "

Update Documents

Performs an partial update on multiple documents identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Documents

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/documents/search": { "post": { "tags": [ "Document" ], "summary": "Search Documents", "description": "

Search Documents

Performs a search applying filtering, sorting, and pagination criteria within the documents, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Documents

Returns: Documents → Documents → DocumentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/documents/{id}": { "get": { "tags": [ "Document" ], "summary": "Get Document", "description": "

Get Document

Provides detailed information for a single document identified by its ID, if it falls within the caller’s scope.

Module: Documents

Returns: Documents → Documents → DocumentRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Document" ], "summary": "Update Document", "description": "

Update Document

Applies an partial update to an existing document specified by its ID, affecting only documents within the caller’s permitted scope.

Module: Documents

Returns: Documents → Documents → DocumentRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Document" ], "summary": "Delete Document", "description": "

Delete Document

Deletes the specified document, if it falls within the caller’s scope.

Module: Documents

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/documents/{id}/shares": { "get": { "tags": [ "Document" ], "summary": "List Shares", "description": "

List Shares

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentShareRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentShareRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentShareRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Document" ], "summary": "Replace Shares", "description": "

Replace Shares

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentShareRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentShareRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentShareRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-background-jobs": { "post": { "tags": [ "DocumentBackgroundJob" ], "summary": "Create Document Background Job", "description": "

Create Document Background Job

Module: Documents

Returns: Documents → Document Background Jobs → DocumentBackgroundJobRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentBackgroundJobCreate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentBackgroundJobCreate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentBackgroundJobCreate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentBackgroundJobRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBackgroundJobRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentBackgroundJobRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "DocumentBackgroundJob" ], "summary": "List Document Background Jobs", "description": "

List Document Background Jobs

Returns a paginated list of document background jobs filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Documents

Returns: Documents → Document Background Jobs → DocumentBackgroundJobRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentBackgroundJobRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-background-jobs/batch": { "post": { "tags": [ "DocumentBackgroundJob" ], "summary": "Batch List Document Background Jobs", "description": "

Batch List Document Background Jobs

Retrieves document background jobs matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Documents

Returns: Documents → Document Background Jobs → DocumentBackgroundJobRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBackgroundJobRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-background-jobs/{id}": { "get": { "tags": [ "DocumentBackgroundJob" ], "summary": "Get Document Background Job", "description": "

Get Document Background Job

Provides detailed information for a single document background job identified by its ID, if it falls within the caller’s scope.

Module: Documents

Returns: Documents → Document Background Jobs → DocumentBackgroundJobRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBackgroundJobRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-groups": { "post": { "tags": [ "DocumentGroup" ], "summary": "Create Document Group", "description": "

Create Document Group

Creates a new document group from the provided data, associating it within the requester's scope.

Module: Documents

Returns: Documents → Document Groups → DocumentGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentGroupWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "DocumentGroup" ], "summary": "List Document Groups", "description": "

List Document Groups

Returns a paginated list of document groups filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Documents

Returns: Documents → Document Groups → DocumentGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-groups/batch": { "post": { "tags": [ "DocumentGroup" ], "summary": "Batch List Document Groups", "description": "

Batch List Document Groups

Retrieves document groups matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Documents

Returns: Documents → Document Groups → DocumentGroupRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentGroupRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "DocumentGroup" ], "summary": "Update Document Groups", "description": "

Update Document Groups

Performs an partial update on multiple document groups identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Documents

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-groups/search": { "post": { "tags": [ "DocumentGroup" ], "summary": "Search Document Groups", "description": "

Search Document Groups

Performs a search applying filtering, sorting, and pagination criteria within the document groups, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Documents

Returns: Documents → Document Groups → DocumentGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentGroupSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-groups/{id}": { "get": { "tags": [ "DocumentGroup" ], "summary": "Get Document Group", "description": "

Get Document Group

Provides detailed information for a single document group identified by its ID, if it falls within the caller’s scope.

Module: Documents

Returns: Documents → Document Groups → DocumentGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentGroupRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "DocumentGroup" ], "summary": "Update Document Group", "description": "

Update Document Group

Applies an partial update to an existing document group specified by its ID, affecting only document groups within the caller’s permitted scope.

Module: Documents

Returns: Documents → Document Groups → DocumentGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "DocumentGroup" ], "summary": "Delete Document Group", "description": "

Delete Document Group

Deletes the specified document group, if it falls within the caller’s scope.

Module: Documents

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-groups/{id}/documents": { "get": { "tags": [ "DocumentGroup" ], "summary": "Get Documents", "description": "

Get Documents

Module: Documents

Returns: Documents → Documents → DocumentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-shares": { "post": { "tags": [ "DocumentShare" ], "summary": "Create Document Share", "description": "

Create Document Share

Creates a new document share from the provided data, associating it within the requester's scope.

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentShareWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentShareRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "DocumentShare" ], "summary": "List Document Shares", "description": "

List Document Shares

Returns a paginated list of document shares filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentShareRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-shares/batch": { "post": { "tags": [ "DocumentShare" ], "summary": "Batch List Document Shares", "description": "

Batch List Document Shares

Retrieves document shares matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentShareRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "DocumentShare" ], "summary": "Update Document Shares", "description": "

Update Document Shares

Performs an partial update on multiple document shares identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Documents

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-shares/search": { "post": { "tags": [ "DocumentShare" ], "summary": "Search Document Shares", "description": "

Search Document Shares

Performs a search applying filtering, sorting, and pagination criteria within the document shares, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DocumentShareSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentShareRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/document-shares/{id}": { "get": { "tags": [ "DocumentShare" ], "summary": "Get Document Share", "description": "

Get Document Share

Provides detailed information for a single document share identified by its ID, if it falls within the caller’s scope.

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentShareRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "DocumentShare" ], "summary": "Update Document Share", "description": "

Update Document Share

Applies an partial update to an existing document share specified by its ID, affecting only document shares within the caller’s permitted scope.

Module: Documents

Returns: Documents → Documents → Shares → DocumentShareRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentShareRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "DocumentShare" ], "summary": "Delete Document Share", "description": "

Delete Document Share

Deletes the specified document share, if it falls within the caller’s scope.

Module: Documents

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/editor-text-blocks": { "post": { "tags": [ "EditorTextBlock" ], "summary": "Create Editor Text Block", "description": "

Create Editor Text Block

Creates a new editor text block from the provided data, associating it within the requester's scope.

Module: Editor Text Blocks

Returns: Editor Text Blocks → EditorTextBlockRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditorTextBlockWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditorTextBlockRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "EditorTextBlock" ], "summary": "List Editor Text Blocks", "description": "

List Editor Text Blocks

Returns a paginated list of editor text blocks filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Editor Text Blocks

Returns: Editor Text Blocks → EditorTextBlockRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEditorTextBlockRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/editor-text-blocks/batch": { "post": { "tags": [ "EditorTextBlock" ], "summary": "Batch List Editor Text Blocks", "description": "

Batch List Editor Text Blocks

Retrieves editor text blocks matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Editor Text Blocks

Returns: Editor Text Blocks → EditorTextBlockRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EditorTextBlockRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "EditorTextBlock" ], "summary": "Update Editor Text Blocks", "description": "

Update Editor Text Blocks

Performs an partial update on multiple editor text blocks identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Editor Text Blocks

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/editor-text-blocks/{id}": { "get": { "tags": [ "EditorTextBlock" ], "summary": "Get Editor Text Block", "description": "

Get Editor Text Block

Provides detailed information for a single editor text block identified by its ID, if it falls within the caller’s scope.

Module: Editor Text Blocks

Returns: Editor Text Blocks → EditorTextBlockRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditorTextBlockRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "EditorTextBlock" ], "summary": "Update Editor Text Block", "description": "

Update Editor Text Block

Applies an partial update to an existing editor text block specified by its ID, affecting only editor text blocks within the caller’s permitted scope.

Module: Editor Text Blocks

Returns: Editor Text Blocks → EditorTextBlockRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditorTextBlockRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "EditorTextBlock" ], "summary": "Delete Editor Text Block", "description": "

Delete Editor Text Block

Deletes the specified editor text block, if it falls within the caller’s scope.

Module: Editor Text Blocks

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/email-sender-settings": { "get": { "tags": [ "EMailSenderSetting" ], "summary": "List EMail Sender Settings", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

List EMail Sender Settings

Returns a paginated list of email sender settings filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: EMail Sender Settings

Returns: EMail Sender Settings → EMailSenderSettingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEMailSenderSettingRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/email-sender-settings/batch": { "post": { "tags": [ "EMailSenderSetting" ], "summary": "Batch List EMail Sender Settings", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Batch List EMail Sender Settings

Retrieves email sender settings matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: EMail Sender Settings

Returns: EMail Sender Settings → EMailSenderSettingRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EMailSenderSettingRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/email-sender-settings/search": { "post": { "tags": [ "EMailSenderSetting" ], "summary": "Search EMail Sender Settings", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Search EMail Sender Settings

Performs a search applying filtering, sorting, and pagination criteria within the email sender settings, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: EMail Sender Settings

Returns: EMail Sender Settings → EMailSenderSettingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EMailSenderSettingSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEMailSenderSettingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/email-sender-settings/{id}": { "get": { "tags": [ "EMailSenderSetting" ], "summary": "Get EMail Sender Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Get EMail Sender Setting

Provides detailed information for a single email sender setting identified by its ID, if it falls within the caller’s scope.

Module: EMail Sender Settings

Returns: EMail Sender Settings → EMailSenderSettingRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EMailSenderSettingRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/entrances": { "post": { "tags": [ "Entrance" ], "summary": "Create Entrance", "description": "

Create Entrance

Creates a new entrance from the provided data, associating it within the requester's scope.

Module: Properties

Returns: Master Data → Properties → Entrances → EntranceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntranceWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntranceRead" }, "examples": { "Nedlitzer Str., First Entrance": { "value": {"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1} }, "Nedlitzer Str., Second Entrance": { "value": {"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2} }, "Nedlitzer Str., Minimal Entrance": { "value": {"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3} }, "Nedlitzer Str., Fourth Entrance": { "value": {"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Entrance" ], "summary": "List Entrances", "description": "

List Entrances

Returns a paginated list of entrances filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Entrances → EntranceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEntranceRead" }, "example": {"items":[{"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/entrances/batch": { "post": { "tags": [ "Entrance" ], "summary": "Batch List Entrances", "description": "

Batch List Entrances

Retrieves entrances matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Entrances → EntranceRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntranceRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Entrance" ], "summary": "Update Entrances", "description": "

Update Entrances

Performs an partial update on multiple entrances identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Properties

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/entrances/search": { "post": { "tags": [ "Entrance" ], "summary": "Search Entrances", "description": "

Search Entrances

Performs a search applying filtering, sorting, and pagination criteria within the entrances, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Properties

Returns: Master Data → Properties → Entrances → EntranceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EntranceSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEntranceRead" }, "example": {"items":[{"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/entrances/{id}": { "get": { "tags": [ "Entrance" ], "summary": "Get Entrance", "description": "

Get Entrance

Provides detailed information for a single entrance identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Entrances → EntranceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntranceRead" }, "examples": { "Nedlitzer Str., First Entrance": { "value": {"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1} }, "Nedlitzer Str., Second Entrance": { "value": {"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2} }, "Nedlitzer Str., Minimal Entrance": { "value": {"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3} }, "Nedlitzer Str., Fourth Entrance": { "value": {"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4} } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Entrance" ], "summary": "Update Entrance", "description": "

Update Entrance

Applies an partial update to an existing entrance specified by its ID, affecting only entrances within the caller’s permitted scope.

Module: Properties

Returns: Master Data → Properties → Entrances → EntranceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntranceRead" }, "examples": { "Nedlitzer Str., First Entrance": { "value": {"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1} }, "Nedlitzer Str., Second Entrance": { "value": {"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2} }, "Nedlitzer Str., Minimal Entrance": { "value": {"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3} }, "Nedlitzer Str., Fourth Entrance": { "value": {"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Entrance" ], "summary": "Delete Entrance", "description": "

Delete Entrance

Deletes the specified entrance, if it falls within the caller’s scope.

Module: Properties

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/entrances/{id}/units": { "get": { "tags": [ "Entrance" ], "summary": "List Units", "description": "

List Units

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (66)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:02Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/erp-imports": { "post": { "tags": [ "ErpImport" ], "summary": "Create Erp Import", "description": "

Create Erp Import

Creates a new erp import from the provided data, associating it within the requester's scope.

Module: Integrations

Returns: Integrations → File Based Erp Import → ErpImportRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ErpImportWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpImportRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ErpImport" ], "summary": "List Erp Imports", "description": "

List Erp Imports

Returns a paginated list of erp imports filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Integrations

Returns: Integrations → File Based Erp Import → ErpImportRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfErpImportRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/erp-imports/batch": { "post": { "tags": [ "ErpImport" ], "summary": "Batch List Erp Imports", "description": "

Batch List Erp Imports

Retrieves erp imports matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Integrations

Returns: Integrations → File Based Erp Import → ErpImportRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ErpImportRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ErpImport" ], "summary": "Update Erp Imports", "description": "

Update Erp Imports

Performs an partial update on multiple erp imports identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Integrations

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/erp-imports/{id}": { "get": { "tags": [ "ErpImport" ], "summary": "Get Erp Import", "description": "

Get Erp Import

Provides detailed information for a single erp import identified by its ID, if it falls within the caller’s scope.

Module: Integrations

Returns: Integrations → File Based Erp Import → ErpImportRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpImportRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ErpImport" ], "summary": "Update Erp Import", "description": "

Update Erp Import

Applies an partial update to an existing erp import specified by its ID, affecting only erp imports within the caller’s permitted scope.

Module: Integrations

Returns: Integrations → File Based Erp Import → ErpImportRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErpImportRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ErpImport" ], "summary": "Delete Erp Import", "description": "

Delete Erp Import

Deletes the specified erp import, if it falls within the caller’s scope.

Module: Integrations

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faqs": { "get": { "tags": [ "Faq" ], "summary": "List Faqs", "description": "

List Faqs

Returns a paginated list of faqs filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Faqs

Returns: Customer App → Faqs → FaqRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faqs/batch": { "post": { "tags": [ "Faq" ], "summary": "Batch List Faqs", "description": "

Batch List Faqs

Retrieves faqs matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Faqs

Returns: Customer App → Faqs → FaqRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FaqRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faqs/search": { "post": { "tags": [ "Faq" ], "summary": "Search Faqs", "description": "

Search Faqs

Performs a search applying filtering, sorting, and pagination criteria within the faqs, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Faqs

Returns: Customer App → Faqs → FaqRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FaqSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faqs/{id}": { "get": { "tags": [ "Faq" ], "summary": "Get Faq", "description": "

Get Faq

Provides detailed information for a single faq identified by its ID, if it falls within the caller’s scope.

Module: Faqs

Returns: Customer App → Faqs → FaqRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaqRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faq-groups": { "get": { "tags": [ "FaqGroup" ], "summary": "List Faq Groups", "description": "

List Faq Groups

Returns a paginated list of faq groups filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Faqs

Returns: Customer App → Faq Groups → FaqGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faq-groups/batch": { "post": { "tags": [ "FaqGroup" ], "summary": "Batch List Faq Groups", "description": "

Batch List Faq Groups

Retrieves faq groups matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Faqs

Returns: Customer App → Faq Groups → FaqGroupRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FaqGroupRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faq-groups/search": { "post": { "tags": [ "FaqGroup" ], "summary": "Search Faq Groups", "description": "

Search Faq Groups

Performs a search applying filtering, sorting, and pagination criteria within the faq groups, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Faqs

Returns: Customer App → Faq Groups → FaqGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FaqGroupSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faq-groups/{id}": { "get": { "tags": [ "FaqGroup" ], "summary": "Get Faq Group", "description": "

Get Faq Group

Provides detailed information for a single faq group identified by its ID, if it falls within the caller’s scope.

Module: Faqs

Returns: Customer App → Faq Groups → FaqGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaqGroupRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faq-groups/{id}/faqs": { "get": { "tags": [ "FaqGroup" ], "summary": "List Faqs", "description": "

List Faqs

Module: Faqs

Returns: Customer App → Faqs → FaqRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/faq-group-visuals": { "get": { "tags": [ "FaqGroupVisual" ], "summary": "List Faq Group Visuals", "description": "

List Faq Group Visuals

Returns a paginated list of faq group visuals filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Faqs

Returns: Customer App → Faq Group Visuals → FaqGroupVisualRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqGroupVisualRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqGroupVisualRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFaqGroupVisualRead" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/faq-group-visuals/{id}": { "get": { "tags": [ "FaqGroupVisual" ], "summary": "Get Faq Group Visual", "description": "

Get Faq Group Visual

Provides detailed information for a single faq group visual identified by its ID, if it falls within the caller’s scope.

Module: Faqs

Returns: Customer App → Faq Group Visuals → FaqGroupVisualRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaqGroupVisualRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/files": { "post": { "tags": [ "File" ], "summary": "Create File", "description": "

Create File

Creates a new file from the provided data, associating it within the requester's scope.

Module: Documents

Returns: Documents → Files → FileRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "File" ], "summary": "List Files", "description": "

List Files

Returns a paginated list of files filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Documents

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/batch": { "post": { "tags": [ "File" ], "summary": "Batch List Files", "description": "

Batch List Files

Retrieves files matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Documents

Returns: Documents → Files → FileRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "File" ], "summary": "Update Files", "description": "

Update Files

Performs an partial update on multiple files identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Documents

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/search": { "post": { "tags": [ "File" ], "summary": "Search Files", "description": "

Search Files

Performs a search applying filtering, sorting, and pagination criteria within the files, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Documents

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{id}": { "get": { "tags": [ "File" ], "summary": "Get File", "description": "

Get File

Provides detailed information for a single file identified by its ID, if it falls within the caller’s scope.

Module: Documents

Returns: Documents → Files → FileRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "File" ], "summary": "Update File", "description": "

Update File

Applies an partial update to an existing file specified by its ID, affecting only files within the caller’s permitted scope.

Module: Documents

Returns: Documents → Files → FileRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "File" ], "summary": "Delete File", "description": "

Delete File

Deletes the specified file, if it falls within the caller’s scope.

Module: Documents

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{id}/archive": { "get": { "tags": [ "File" ], "summary": "Archive File", "description": "

Archive File

Module: Documents

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } }, "application/gzip": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{id}/document": { "get": { "tags": [ "File" ], "summary": "Get Document", "description": "

Get Document

Module: Documents

Returns: Documents → Documents → DocumentRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{id}/download": { "get": { "tags": [ "File" ], "summary": "Download File", "description": "

Download File

Module: Documents

Returns: Documents → Files → FileDownloadResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{id}/process-feed-entries": { "get": { "tags": [ "File" ], "summary": "Get Processes", "description": "

Get Processes

Module: Documents

Returns: Processes → Feed → ProcessFeedRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (45)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{id}/thumbnail": { "get": { "tags": [ "File" ], "summary": "Thumbnail", "description": "

Thumbnail

Module: Documents

Returns: Documents → Files → Queries → Helper → ThumbnailQueryResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThumbnailQueryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThumbnailQueryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThumbnailQueryResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{id}/type": { "get": { "tags": [ "File" ], "summary": "Show File Type", "description": "

Show File Type

Module: Documents

Returns: Documents → File Types → FileTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileTypeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileTypeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{id}/upload": { "put": { "tags": [ "File" ], "summary": "Upload File", "description": "

Upload File

Module: Documents

Returns: Documents → Files → FileUploadResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UploadFileRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UploadFileRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UploadFileRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileUploadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/files/{processFeedEntryId}/attachments/{fileId}": { "put": { "tags": [ "File" ], "summary": "Attach File", "description": "

Attach File

Module: Documents

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (23)

This will be evaluated against your used access token.

", "parameters": [ { "name": "processFeedEntryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "File" ], "summary": "Remove File", "description": "

Remove File

Module: Documents

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (23)

This will be evaluated against your used access token.

", "parameters": [ { "name": "processFeedEntryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/file-types": { "get": { "tags": [ "FileType" ], "summary": "List File Types", "description": "

List File Types

Returns a paginated list of file types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Documents

Returns: Documents → File Types → FileTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/file-types/batch": { "post": { "tags": [ "FileType" ], "summary": "Batch List File Types", "description": "

Batch List File Types

Retrieves file types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Documents

Returns: Documents → File Types → FileTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/file-types/search": { "post": { "tags": [ "FileType" ], "summary": "Search File Types", "description": "

Search File Types

Performs a search applying filtering, sorting, and pagination criteria within the file types, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Documents

Returns: Documents → File Types → FileTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileTypeSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/file-types/{id}": { "get": { "tags": [ "FileType" ], "summary": "Get File Type", "description": "

Get File Type

Provides detailed information for a single file type identified by its ID, if it falls within the caller’s scope.

Module: Documents

Returns: Documents → File Types → FileTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/generic-party-settings": { "get": { "tags": [ "GenericPartySetting" ], "summary": "List Generic Party Settings", "description": "

List Generic Party Settings

Returns a paginated list of generic party settings filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Master Data → Parties → Generic Settings → GenericPartySettingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfGenericPartySettingRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/generic-party-settings/batch": { "post": { "tags": [ "GenericPartySetting" ], "summary": "Batch List Generic Party Settings", "description": "

Batch List Generic Party Settings

Retrieves generic party settings matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Master Data → Parties → Generic Settings → GenericPartySettingRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GenericPartySettingRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/generic-party-settings/search": { "post": { "tags": [ "GenericPartySetting" ], "summary": "Search Generic Party Settings", "description": "

Search Generic Party Settings

Performs a search applying filtering, sorting, and pagination criteria within the generic party settings, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Identity

Returns: Master Data → Parties → Generic Settings → GenericPartySettingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfGenericPartySettingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/generic-party-settings/{id}": { "get": { "tags": [ "GenericPartySetting" ], "summary": "Get Generic Party Setting", "description": "

Get Generic Party Setting

Provides detailed information for a single generic party setting identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Master Data → Parties → Generic Settings → GenericPartySettingRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericPartySettingRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/health": { "get": { "tags": [ "HealthCheck" ], "summary": "Get Health", "description": "

Get Health

Module: Monitoring

Returns: Void

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/health/live": { "get": { "tags": [ "HealthCheck" ], "summary": "Get Liveness", "description": "

Get Liveness

Module: Monitoring

Returns: Void

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/health/ready": { "get": { "tags": [ "HealthCheck" ], "summary": "Get Readiness", "description": "

Get Readiness

Module: Monitoring

Returns: Void

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/inquiries": { "post": { "tags": [ "Inquiry" ], "summary": "Create Inquiry", "description": "

Create Inquiry

Creates a new inquiry from the provided data, associating it within the requester's scope.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InquiryWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Inquiry" ], "summary": "List Inquiries", "description": "

List Inquiries

Returns a paginated list of inquiries filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/batch": { "post": { "tags": [ "Inquiry" ], "summary": "Batch List Inquiries", "description": "

Batch List Inquiries

Retrieves inquiries matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Inquiry" ], "summary": "Update Inquiries", "description": "

Update Inquiries

Performs an partial update on multiple inquiries identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Inquiries

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/search": { "post": { "tags": [ "Inquiry" ], "summary": "Search Inquiries", "description": "

Search Inquiries

Performs a search applying filtering, sorting, and pagination criteria within the inquiries, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InquirySearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}": { "get": { "tags": [ "Inquiry" ], "summary": "Get Inquiry", "description": "

Get Inquiry

Provides detailed information for a single inquiry identified by its ID, if it falls within the caller’s scope.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Inquiry" ], "summary": "Update Inquiry", "description": "

Update Inquiry

Applies an partial update to an existing inquiry specified by its ID, affecting only inquiries within the caller’s permitted scope.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Inquiry" ], "summary": "Delete Inquiry", "description": "

Delete Inquiry

Deletes the specified inquiry, if it falls within the caller’s scope.

Module: Inquiries

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/accessible-by-accounts": { "get": { "tags": [ "Inquiry" ], "summary": "Get Accessor Accounts", "description": "

Get Accessor Accounts

Module: Inquiries

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/accessible-by-accounts/{accountId}": { "put": { "tags": [ "Inquiry" ], "summary": "Give Access To Account", "description": "

Give Access To Account

Module: Inquiries

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Inquiry" ], "summary": "Remove Account Access", "description": "

Remove Account Access

Module: Inquiries

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/ai-evaluation": { "post": { "tags": [ "Inquiry" ], "summary": "Regenerate Ai Evaluation Details", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Regenerate Ai Evaluation Details

Regenerates the AI-derived title, summary and labels for the inquiry, replacing any previous result. Omit the request body's feedback for a fresh generation; supply it to refine the previously generated result with a free-text instruction. Omit the fields list (or send it empty) to regenerate all fields; otherwise only the listed fields are updated and the rest are left untouched.

Module: Inquiries

Returns: Inquiries → Ai Evaluations → InquiryAiEvaluationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegenerateInquiryDetailsRequest" } ], "description": "Request body for regenerating an inquiry's AI evaluation." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegenerateInquiryDetailsRequest" } ], "description": "Request body for regenerating an inquiry's AI evaluation." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RegenerateInquiryDetailsRequest" } ], "description": "Request body for regenerating an inquiry's AI evaluation." } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Inquiry" ], "summary": "Show Ai Evaluation", "description": "

Show Ai Evaluation

Module: Inquiries

Returns: Inquiries → Ai Evaluations → InquiryAiEvaluationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/attachments": { "get": { "tags": [ "Inquiry" ], "summary": "Get Attachments", "description": "

Get Attachments

Module: Inquiries

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/attachments/{fileId}": { "put": { "tags": [ "Inquiry" ], "summary": "Attach File", "description": "

Attach File

Module: Inquiries

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Inquiry" ], "summary": "Detach File", "description": "

Detach File

Module: Inquiries

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/custom-email-reply": { "post": { "tags": [ "Inquiry" ], "summary": "Prepare Custom Email Reply", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Prepare Custom Email Reply

Prepares the custom e-mail reply to the inquiry's connected party. Nothing is sent by this request: the reply is delivered when the inquiry is closed, and it then replaces the standard system e-mail notification for the closing (the app push is still sent). Only inquiries that are not closed yet can be prepared for, and an inquiry holds exactly one custom reply — preparing again replaces the previously prepared one instead of sending a second mail. Deleting the inquiry, or DELETE on this resource, discards it and restores the standard notification. Prepared replies are short-lived by design, so make this request right before closing the inquiry, which is what triggers delivery: one that is left unreleased is discarded by garbage collection an hour after it was prepared. Address the reply with a current e-mail contact of the inquiry's connected party; search /api/contact-details filtered by that party and contact type 3 for the ones available.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryCustomEmailReplyResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PrepareInquiryCustomEmailReplyRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PrepareInquiryCustomEmailReplyRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PrepareInquiryCustomEmailReplyRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InquiryCustomEmailReplyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InquiryCustomEmailReplyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InquiryCustomEmailReplyResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Inquiry" ], "summary": "Show Custom Email Reply", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Show Custom Email Reply

Returns the custom e-mail reply currently prepared for the inquiry, as it will go out when the inquiry is closed. 404 when none is prepared — including when a previously prepared one has already been garbage collected.

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryCustomEmailReplyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InquiryCustomEmailReplyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InquiryCustomEmailReplyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InquiryCustomEmailReplyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Inquiry" ], "summary": "Delete Custom Email Reply", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Delete Custom Email Reply

Discards the custom e-mail reply prepared for the inquiry, so that closing the inquiry sends the standard system e-mail notification again. 404 when none is prepared.

Module: Inquiries

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Void" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Void" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Void" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/labels": { "get": { "tags": [ "Inquiry" ], "summary": "Get Labels", "description": "

Get Labels

Module: Inquiries

Returns: Inquiries → Label Mappings → InquiryLabelMappingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/labels/{labelId}": { "put": { "tags": [ "Inquiry" ], "summary": "Attach Label", "description": "

Attach Label

Module: Inquiries

Returns: Inquiries → Label Mappings → InquiryLabelMappingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Inquiry" ], "summary": "Detach Label", "description": "

Detach Label

Module: Inquiries

Returns: Inquiries → Label Mappings → InquiryLabelMappingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelMappingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/response-attachments": { "get": { "tags": [ "Inquiry" ], "summary": "Get Response Attachments", "description": "

Get Response Attachments

Module: Inquiries

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiries/{id}/response-attachments/{fileId}": { "put": { "tags": [ "Inquiry" ], "summary": "Attach Response File", "description": "

Attach Response File

Module: Inquiries

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Inquiry" ], "summary": "Detach Response File", "description": "

Detach Response File

Module: Inquiries

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-ai-evaluations": { "get": { "tags": [ "InquiryAiEvaluation" ], "summary": "List Inquiry Ai Evaluations", "description": "

List Inquiry Ai Evaluations

Returns a paginated list of inquiry ai evaluations filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Inquiries

Returns: Inquiries → Ai Evaluations → InquiryAiEvaluationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryAiEvaluationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-ai-evaluations/batch": { "post": { "tags": [ "InquiryAiEvaluation" ], "summary": "Batch List Inquiry Ai Evaluations", "description": "

Batch List Inquiry Ai Evaluations

Retrieves inquiry ai evaluations matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Inquiries

Returns: Inquiries → Ai Evaluations → InquiryAiEvaluationRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "InquiryAiEvaluation" ], "summary": "Update Inquiry Ai Evaluations", "description": "

Update Inquiry Ai Evaluations

Performs an partial update on multiple inquiry ai evaluations identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Inquiries

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-ai-evaluations/search": { "post": { "tags": [ "InquiryAiEvaluation" ], "summary": "Search Inquiry Ai Evaluations", "description": "

Search Inquiry Ai Evaluations

Performs a search applying filtering, sorting, and pagination criteria within the inquiry ai evaluations, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Inquiries

Returns: Inquiries → Ai Evaluations → InquiryAiEvaluationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InquiryAiEvaluationSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryAiEvaluationRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-ai-evaluations/{id}": { "get": { "tags": [ "InquiryAiEvaluation" ], "summary": "Get Inquiry Ai Evaluation", "description": "

Get Inquiry Ai Evaluation

Provides detailed information for a single inquiry ai evaluation identified by its ID, if it falls within the caller’s scope.

Module: Inquiries

Returns: Inquiries → Ai Evaluations → InquiryAiEvaluationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "InquiryAiEvaluation" ], "summary": "Update Inquiry Ai Evaluation", "description": "

Update Inquiry Ai Evaluation

Applies an partial update to an existing inquiry ai evaluation specified by its ID, affecting only inquiry ai evaluations within the caller’s permitted scope.

Module: Inquiries

Returns: Inquiries → Ai Evaluations → InquiryAiEvaluationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-categories": { "get": { "tags": [ "InquiryCategory" ], "summary": "List Inquiry Categories", "description": "

List Inquiry Categories

Returns a paginated list of inquiry categories filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Inquiries

Returns: Inquiries → Categories → InquiryCategoryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryCategoryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-categories/batch": { "post": { "tags": [ "InquiryCategory" ], "summary": "Batch List Inquiry Categories", "description": "

Batch List Inquiry Categories

Retrieves inquiry categories matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Inquiries

Returns: Inquiries → Categories → InquiryCategoryRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryCategoryRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-categories/search": { "post": { "tags": [ "InquiryCategory" ], "summary": "Search Inquiry Categories", "description": "

Search Inquiry Categories

Performs a search applying filtering, sorting, and pagination criteria within the inquiry categories, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Inquiries

Returns: Inquiries → Categories → InquiryCategoryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InquiryCategorySearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryCategoryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-categories/{id}": { "get": { "tags": [ "InquiryCategory" ], "summary": "Get Inquiry Category", "description": "

Get Inquiry Category

Provides detailed information for a single inquiry category identified by its ID, if it falls within the caller’s scope.

Module: Inquiries

Returns: Inquiries → Categories → InquiryCategoryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryCategoryRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-labels": { "get": { "tags": [ "InquiryLabel" ], "summary": "List Inquiry Labels", "description": "

List Inquiry Labels

Returns a paginated list of inquiry labels filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Inquiries

Returns: Inquiries → Labels → InquiryLabelRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-labels/batch": { "post": { "tags": [ "InquiryLabel" ], "summary": "Batch List Inquiry Labels", "description": "

Batch List Inquiry Labels

Retrieves inquiry labels matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Inquiries

Returns: Inquiries → Labels → InquiryLabelRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryLabelRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-labels/search": { "post": { "tags": [ "InquiryLabel" ], "summary": "Search Inquiry Labels", "description": "

Search Inquiry Labels

Performs a search applying filtering, sorting, and pagination criteria within the inquiry labels, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Inquiries

Returns: Inquiries → Labels → InquiryLabelRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InquiryLabelSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryLabelRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-labels/{id}": { "get": { "tags": [ "InquiryLabel" ], "summary": "Get Inquiry Label", "description": "

Get Inquiry Label

Provides detailed information for a single inquiry label identified by its ID, if it falls within the caller’s scope.

Module: Inquiries

Returns: Inquiries → Labels → InquiryLabelRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryLabelRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-sources": { "get": { "tags": [ "InquirySource" ], "summary": "List Inquiry Sources", "description": "

List Inquiry Sources

Returns a paginated list of inquiry sources filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Inquiries

Returns: Inquiries → Sources → InquirySourceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquirySourceRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-sources/batch": { "post": { "tags": [ "InquirySource" ], "summary": "Batch List Inquiry Sources", "description": "

Batch List Inquiry Sources

Retrieves inquiry sources matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Inquiries

Returns: Inquiries → Sources → InquirySourceRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InquirySourceRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/inquiry-sources/{id}": { "get": { "tags": [ "InquirySource" ], "summary": "Get Inquiry Source", "description": "

Get Inquiry Source

Provides detailed information for a single inquiry source identified by its ID, if it falls within the caller’s scope.

Module: Inquiries

Returns: Inquiries → Sources → InquirySourceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquirySourceRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/integrations/docuware/export/master-data": { "post": { "tags": [ "DocuWare" ], "summary": "Export Master Data", "description": "

Export Master Data

Module: Integrations

Returns: Void

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integrations/docuware/import": { "post": { "tags": [ "DocuWare" ], "summary": "Import Document", "description": "

Import Document

Module: Integrations

Returns: Void

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/integrations/pantaenius/glass-claims/{id}/process": { "get": { "tags": [ "Pantaenius" ], "summary": "Get Glass Claim Process", "description": "

Get Glass Claim Process

Module: Integrations

Returns: Processes → Processes → ProcessRead (single)

Authorization

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/integrations/pantaenius/liability-claims/{id}/process": { "get": { "tags": [ "Pantaenius" ], "summary": "Get Liability Claims Process", "description": "

Get Liability Claims Process

Module: Integrations

Returns: Processes → Processes → ProcessRead (single)

Authorization

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/integrations/pantaenius/residential-building-claims/{id}/process": { "get": { "tags": [ "Pantaenius" ], "summary": "Get Residential Building Claim Process", "description": "

Get Residential Building Claim Process

Module: Integrations

Returns: Processes → Processes → ProcessRead (single)

Authorization

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/invoices": { "post": { "tags": [ "Invoice" ], "summary": "Create Invoice", "description": "

Create Invoice

Creates a new invoice from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Invoices → InvoiceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InvoiceWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Invoice" ], "summary": "List Invoices", "description": "

List Invoices

Returns a paginated list of invoices filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Invoices → InvoiceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/invoices/batch": { "post": { "tags": [ "Invoice" ], "summary": "Batch List Invoices", "description": "

Batch List Invoices

Retrieves invoices matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Invoices → InvoiceRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Invoice" ], "summary": "Update Invoices", "description": "

Update Invoices

Performs an partial update on multiple invoices identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/invoices/search": { "post": { "tags": [ "Invoice" ], "summary": "Search Invoices", "description": "

Search Invoices

Performs a search applying filtering, sorting, and pagination criteria within the invoices, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Invoices → InvoiceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InvoiceSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/invoices/{id}": { "get": { "tags": [ "Invoice" ], "summary": "Get Invoice", "description": "

Get Invoice

Provides detailed information for a single invoice identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Invoices → InvoiceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Invoice" ], "summary": "Update Invoice", "description": "

Update Invoice

Applies an partial update to an existing invoice specified by its ID, affecting only invoices within the caller’s permitted scope.

Module: Processes

Returns: Processes → Invoices → InvoiceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Invoice" ], "summary": "Delete Invoice", "description": "

Delete Invoice

Deletes the specified invoice, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/invoices/{id}/attachments": { "get": { "tags": [ "Invoice" ], "summary": "List Invoice Attachments", "description": "

List Invoice Attachments

Module: Processes

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/invoices/{id}/attachments/{fileId}": { "put": { "tags": [ "Invoice" ], "summary": "Attach File To Invoice", "description": "

Attach File To Invoice

Module: Processes

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Invoice" ], "summary": "Remove Attachment From Invoice", "description": "

Remove Attachment From Invoice

Module: Processes

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mail-placeholders": { "get": { "tags": [ "MailPlaceholder" ], "summary": "List Mail Placeholders", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

List Mail Placeholders

Returns the legacy email placeholder catalog for a notification type, including editor tokens, descriptions, example replacements, and dependency metadata. This endpoint does not resolve live placeholder values for a specific inquiry or email. When notificationTypeId is omitted, the Gen1 global placeholders are returned.

Module: Integrations

Returns: Integrations → Email → MailPlaceholderRead (list)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "notificationTypeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MailPlaceholderRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mail-signatures": { "get": { "tags": [ "MailSignature" ], "summary": "List Mail Signatures", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

List Mail Signatures

Returns the current account's email signatures.

Module: Integrations

Returns: Integrations → Email → MailSignatureRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfMailSignatureRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mail-signatures/batch": { "post": { "tags": [ "MailSignature" ], "summary": "Batch List Mail Signatures", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Batch List Mail Signatures

Returns the current account's email signatures matching the provided ids.

Module: Integrations

Returns: Integrations → Email → MailSignatureRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MailSignatureRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mail-signatures/{id}": { "get": { "tags": [ "MailSignature" ], "summary": "Get Mail Signature", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Get Mail Signature

Returns one email signature owned by the current account.

Module: Integrations

Returns: Integrations → Email → MailSignatureRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailSignatureRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mail-templates/batch": { "post": { "tags": [ "MailTemplate" ], "summary": "Batch List Mail Templates", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Batch List Mail Templates

Returns the legacy email template rows for the requested notification types. Each requested type yields one standard template row from notificationtype plus all matching company-specific template rows from mailtemplates.

Module: Integrations

Returns: Integrations → Email → MailTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mandates": { "post": { "tags": [ "Mandate" ], "summary": "Create Mandate", "description": "

Create Mandate

Creates a new mandate from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Mandates → MandateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MandateWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Mandate" ], "summary": "List Mandates", "description": "

List Mandates

Returns a paginated list of mandates filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Mandates → MandateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfMandateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mandates/batch": { "post": { "tags": [ "Mandate" ], "summary": "Batch List Mandates", "description": "

Batch List Mandates

Retrieves mandates matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Mandates → MandateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MandateRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Mandate" ], "summary": "Update Mandates", "description": "

Update Mandates

Performs an partial update on multiple mandates identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mandates/search": { "post": { "tags": [ "Mandate" ], "summary": "Search Mandates", "description": "

Search Mandates

Performs a search applying filtering, sorting, and pagination criteria within the mandates, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Mandates → MandateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MandateSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfMandateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mandates/{id}": { "get": { "tags": [ "Mandate" ], "summary": "Get Mandate", "description": "

Get Mandate

Provides detailed information for a single mandate identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Mandates → MandateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Mandate" ], "summary": "Update Mandate", "description": "

Update Mandate

Applies an partial update to an existing mandate specified by its ID, affecting only mandates within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Mandates → MandateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Mandate" ], "summary": "Delete Mandate", "description": "

Delete Mandate

Deletes the specified mandate, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/mandates/{id}/predefined-votes": { "get": { "tags": [ "Mandate" ], "summary": "Get Predefined Votes", "description": "

Get Predefined Votes

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPredefinedVoteRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPredefinedVoteRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPredefinedVoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Mandate" ], "summary": "Set Predefined Votes", "description": "

Set Predefined Votes

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (list)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedVoteRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedVoteRead" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedVoteRead" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedVoteRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedVoteRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedVoteRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/nearby-places-categories": { "get": { "tags": [ "NearbyPlacesCategory" ], "summary": "List Nearby Places Categories", "description": "

List Nearby Places Categories

Returns a paginated list of nearby places categories filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Customer App → Nearby Places Categories → NearbyPlacesCategoryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNearbyPlacesCategoryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/nearby-places-categories/batch": { "post": { "tags": [ "NearbyPlacesCategory" ], "summary": "Batch List Nearby Places Categories", "description": "

Batch List Nearby Places Categories

Retrieves nearby places categories matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Customer App → Nearby Places Categories → NearbyPlacesCategoryRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NearbyPlacesCategoryRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/nearby-places-categories/{id}": { "get": { "tags": [ "NearbyPlacesCategory" ], "summary": "Get Nearby Places Category", "description": "

Get Nearby Places Category

Provides detailed information for a single nearby places category identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Customer App → Nearby Places Categories → NearbyPlacesCategoryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NearbyPlacesCategoryRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/notices": { "post": { "tags": [ "Notice" ], "summary": "Create Notice", "description": "

Create Notice

Creates a new notice from the provided data, associating it within the requester's scope.

Module: Notices

Returns: Processes → Notices → NoticeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NoticeWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoticeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Notice" ], "summary": "List Notices", "description": "

List Notices

Returns a paginated list of notices filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Notices

Returns: Processes → Notices → NoticeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNoticeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/notices/batch": { "post": { "tags": [ "Notice" ], "summary": "Batch List Notices", "description": "

Batch List Notices

Retrieves notices matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Notices

Returns: Processes → Notices → NoticeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoticeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Notice" ], "summary": "Update Notices", "description": "

Update Notices

Performs an partial update on multiple notices identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Notices

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/notices/search": { "post": { "tags": [ "Notice" ], "summary": "Search Notices", "description": "

Search Notices

Performs a search applying filtering, sorting, and pagination criteria within the notices, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Notices

Returns: Processes → Notices → NoticeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NoticeSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNoticeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/notices/{id}": { "get": { "tags": [ "Notice" ], "summary": "Get Notice", "description": "

Get Notice

Provides detailed information for a single notice identified by its ID, if it falls within the caller’s scope.

Module: Notices

Returns: Processes → Notices → NoticeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoticeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Notice" ], "summary": "Update Notice", "description": "

Update Notice

Applies an partial update to an existing notice specified by its ID, affecting only notices within the caller’s permitted scope.

Module: Notices

Returns: Processes → Notices → NoticeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoticeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Notice" ], "summary": "Delete Notice", "description": "

Delete Notice

Deletes the specified notice, if it falls within the caller’s scope.

Module: Notices

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/notices/{id}/accesses": { "get": { "tags": [ "Notice" ], "summary": "List Accesses", "description": "

List Accesses

Module: Notices

Returns: Processes → Notices → Accesses → NoticeAccessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNoticeAccessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNoticeAccessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNoticeAccessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/notices/{id}/files": { "get": { "tags": [ "Notice" ], "summary": "List Files", "description": "

List Files

Module: Notices

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/notices/{noticeId}/accesses/{unitContractId}": { "patch": { "tags": [ "Notice" ], "summary": "Update Access", "description": "

Update Access

Module: Notices

Returns: Processes → Notices → Accesses → NoticeAccessRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "noticeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "unitContractId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NoticeAccessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NoticeAccessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NoticeAccessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties": { "post": { "tags": [ "Party" ], "summary": "Create Party", "description": "

Create Party

Creates a new party from the provided data, associating it within the requester's scope.

Module: Identity

Returns: Identity → Parties → PartyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PartyWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Party" ], "summary": "List Parties", "description": "

List Parties

Returns a paginated list of parties filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/batch": { "post": { "tags": [ "Party" ], "summary": "Batch List Parties", "description": "

Batch List Parties

Retrieves parties matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Identity → Parties → PartyRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Party" ], "summary": "Update Parties", "description": "

Update Parties

Performs an partial update on multiple parties identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Identity

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/myself": { "get": { "tags": [ "Party" ], "summary": "Get Myself", "description": "

Get Myself

Returns the party of the currently used authentication token.

Module: Identity

Returns: Identity → Parties → PartyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/search": { "post": { "tags": [ "Party" ], "summary": "Search Parties", "description": "

Search Parties

Performs a search applying filtering, sorting, and pagination criteria within the parties, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Identity

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PartySearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{domain}/customer-app-startup-configuration": { "get": { "tags": [ "Party" ], "summary": "Get Customer App Startup Configuration By Domain", "description": "

Get Customer App Startup Configuration By Domain

Module: Identity

Returns: Customer App → Customer Apps → CustomerAppStartupConfiguration (single)

", "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } } } }, "401": { "description": "Error: Unauthorized" } } } }, "/api/parties/{id}": { "get": { "tags": [ "Party" ], "summary": "Get Party", "description": "

Get Party

Provides detailed information for a single party identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Identity → Parties → PartyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Party" ], "summary": "Update Party", "description": "

Update Party

Applies an partial update to an existing party specified by its ID, affecting only parties within the caller’s permitted scope.

Module: Identity

Returns: Identity → Parties → PartyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Party" ], "summary": "Delete Party", "description": "

Delete Party

Deletes the specified party, if it falls within the caller’s scope.

Module: Identity

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/account": { "get": { "tags": [ "Party" ], "summary": "Show Account", "description": "

Show Account

Module: Identity

Returns: Identity → Accounts → AccountRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/accounts": { "get": { "tags": [ "Party" ], "summary": "List Accounts", "description": "

List Accounts

Module: Identity

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/assigned-trades": { "get": { "tags": [ "Party" ], "summary": "Get Assigned Trades", "description": "

Get Assigned Trades

Module: Identity

Returns: Master Data → Parties → Trades → TradeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/constructor-of-properties": { "get": { "tags": [ "Party" ], "summary": "Get Constructor Of Properties", "description": "

Get Constructor Of Properties

Module: Identity

Returns: Master Data → Properties → Properties → PropertyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (48)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/contact-details": { "get": { "tags": [ "Party" ], "summary": "List Contact Details", "description": "

List Contact Details

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfContactDetailsRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfContactDetailsRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfContactDetailsRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Party" ], "summary": "Set Contact Details", "description": "

Set Contact Details

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetailsWrite" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetailsWrite" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetailsWrite" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetailsRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetailsRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetailsRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/customer-app-startup-configuration": { "get": { "tags": [ "Party" ], "summary": "Get Customer App Startup Configuration By Id", "description": "

Get Customer App Startup Configuration By Id

Module: Identity

Returns: Customer App → Customer Apps → CustomerAppStartupConfiguration (single)

Authorization

Required Token Scopes: Platform (0) and Change Password (2) and Multi Factor Challenge (1)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerAppStartupConfiguration" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/document-groups": { "get": { "tags": [ "Party" ], "summary": "List Document Groups", "description": "

List Document Groups

Module: Identity

Returns: Documents → Document Groups → DocumentGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (32)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/external-ids": { "get": { "tags": [ "Party" ], "summary": "List External Ids", "description": "

List External Ids

Module: Identity

Returns: System → String (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfString" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfString" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfString" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Party" ], "summary": "Replace External Ids", "description": "

Replace External Ids

Module: Identity

Returns: System → String (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/logo": { "get": { "tags": [ "Party" ], "summary": "Download Logo", "description": "

Download Logo

Module: Identity

Returns: Documents → Files → FileDownloadResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{id}/processes": { "get": { "tags": [ "Party" ], "summary": "List Processes", "description": "

List Processes

Module: Identity

Returns: Processes → Processes → ProcessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (45)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/assigned-trades/{tradeId}": { "put": { "tags": [ "Party" ], "summary": "Assign Trade To Party", "description": "

Assign Trade To Party

Module: Identity

Returns: Master Data → Parties → Trades → TradeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tradeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Party" ], "summary": "Remove Trade From Party", "description": "

Remove Trade From Party

Module: Identity

Returns: Master Data → Parties → Trades → TradeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tradeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/assigned-trades/{tradeId}/constructor-of-properties": { "get": { "tags": [ "Party" ], "summary": "Get Constructor Of Properties By Trade", "description": "

Get Constructor Of Properties By Trade

Module: Identity

Returns: Master Data → Properties → Properties → PropertyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (48)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tradeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/constructor-of-properties/{propertyId}/assigned-trades": { "get": { "tags": [ "Party" ], "summary": "Get Trade Assigned To Property", "description": "

Get Trade Assigned To Property

Module: Identity

Returns: Master Data → Parties → Trades → TradeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/documents": { "get": { "tags": [ "Party" ], "summary": "Get Documents", "description": "

Get Documents

Module: Identity

Returns: Documents → Documents → DocumentRead (paginated)

Authorization

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/document-groups/{documentGroupId}/documents": { "get": { "tags": [ "Party" ], "summary": "List Documents", "description": "

List Documents

Module: Identity

Returns: Documents → Documents → DocumentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (32)

This will be evaluated against your used access token.

", "parameters": [ { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "documentGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/entrances": { "get": { "tags": [ "Party" ], "summary": "Get Entrances", "description": "

Get Entrances

Module: Identity

Returns: Master Data → Properties → Entrances → EntranceRead (paginated)

Authorization

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEntranceRead" }, "example": {"items":[{"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEntranceRead" }, "example": {"items":[{"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEntranceRead" }, "example": {"items":[{"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/files": { "get": { "tags": [ "Party" ], "summary": "Get Files", "description": "

Get Files

Module: Identity

Returns: Documents → Files → FileRead (paginated)

Authorization

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/properties": { "get": { "tags": [ "Party" ], "summary": "Get Properties", "description": "

Get Properties

Module: Identity

Returns: Master Data → Properties → Properties → PropertyRead (paginated)

Authorization

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/units": { "get": { "tags": [ "Party" ], "summary": "Get Units", "description": "

Get Units

Module: Identity

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/parties/{partyId}/unit-contracts": { "get": { "tags": [ "Party" ], "summary": "Get Unit Contracts", "description": "

Get Unit Contracts

Module: Identity

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (paginated)

Authorization

Allowed Party Types (Account Role): Admin (1)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/party-types": { "get": { "tags": [ "PartyType" ], "summary": "List Party Types", "description": "

List Party Types

Returns a paginated list of party types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Identity → Parties → Types → PartyTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/party-types/batch": { "post": { "tags": [ "PartyType" ], "summary": "Batch List Party Types", "description": "

Batch List Party Types

Retrieves party types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Identity → Parties → Types → PartyTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PartyTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/party-types/{id}": { "get": { "tags": [ "PartyType" ], "summary": "Get Party Type", "description": "

Get Party Type

Provides detailed information for a single party type identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Identity → Parties → Types → PartyTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartyTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/platform-products": { "get": { "tags": [ "PlatformProduct" ], "summary": "List Platform Products", "description": "

List Platform Products

Returns a paginated list of platform products filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Platform

Returns: Platform → Platform Products → PlatformProductRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPlatformProductRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/platform-products/batch": { "post": { "tags": [ "PlatformProduct" ], "summary": "Batch List Platform Products", "description": "

Batch List Platform Products

Retrieves platform products matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Platform

Returns: Platform → Platform Products → PlatformProductRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformProductRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/platform-products/search": { "post": { "tags": [ "PlatformProduct" ], "summary": "Search Platform Products", "description": "

Search Platform Products

Performs a search applying filtering, sorting, and pagination criteria within the platform products, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Platform

Returns: Platform → Platform Products → PlatformProductRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PlatformProductSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPlatformProductRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/platform-products/{id}": { "get": { "tags": [ "PlatformProduct" ], "summary": "Get Platform Product", "description": "

Get Platform Product

Provides detailed information for a single platform product identified by its ID, if it falls within the caller’s scope.

Module: Platform

Returns: Platform → Platform Products → PlatformProductRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Energy Provider (10), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformProductRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/predefined-votes": { "post": { "tags": [ "PredefinedVote" ], "summary": "Create Predefined Vote", "description": "

Create Predefined Vote

Creates a new predefined vote from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PredefinedVoteWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "PredefinedVote" ], "summary": "List Predefined Votes", "description": "

List Predefined Votes

Returns a paginated list of predefined votes filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPredefinedVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/predefined-votes/batch": { "post": { "tags": [ "PredefinedVote" ], "summary": "Batch List Predefined Votes", "description": "

Batch List Predefined Votes

Retrieves predefined votes matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedVoteRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "PredefinedVote" ], "summary": "Update Predefined Votes", "description": "

Update Predefined Votes

Performs an partial update on multiple predefined votes identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/predefined-votes/search": { "post": { "tags": [ "PredefinedVote" ], "summary": "Search Predefined Votes", "description": "

Search Predefined Votes

Performs a search applying filtering, sorting, and pagination criteria within the predefined votes, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PredefinedVoteSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPredefinedVoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/predefined-votes/{id}": { "get": { "tags": [ "PredefinedVote" ], "summary": "Get Predefined Vote", "description": "

Get Predefined Vote

Provides detailed information for a single predefined vote identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedVoteRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "PredefinedVote" ], "summary": "Update Predefined Vote", "description": "

Update Predefined Vote

Applies an partial update to an existing predefined vote specified by its ID, affecting only predefined votes within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Voting → Votes → PredefinedVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PredefinedVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "PredefinedVote" ], "summary": "Delete Predefined Vote", "description": "

Delete Predefined Vote

Deletes the specified predefined vote, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes": { "post": { "tags": [ "Process" ], "summary": "Create Proces", "description": "

Create Proces

Creates a new proces from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Processes → ProcessRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessWrite" } ], "description": "Defines the data required to create or update a process." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Process" ], "summary": "List Processes", "description": "

List Processes

Returns a paginated list of processes filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Processes → ProcessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/batch": { "post": { "tags": [ "Process" ], "summary": "Batch List Processes", "description": "

Batch List Processes

Retrieves processes matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Processes → ProcessRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Process" ], "summary": "Update Processes", "description": "

Update Processes

Performs an partial update on multiple processes identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/search": { "post": { "tags": [ "Process" ], "summary": "Search Processes", "description": "

Search Processes

Performs a search applying filtering, sorting, and pagination criteria within the processes, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Processes → ProcessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}": { "get": { "tags": [ "Process" ], "summary": "Get Proces", "description": "

Get Proces

Provides detailed information for a single proces identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Processes → ProcessRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Process" ], "summary": "Update Proces", "description": "

Update Proces

Applies an partial update to an existing proces specified by its ID, affecting only processes within the caller’s permitted scope.

Module: Processes

Returns: Processes → Processes → ProcessRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Process" ], "summary": "Delete Proces", "description": "

Delete Proces

Deletes the specified proces, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/accessor-parties": { "get": { "tags": [ "Process" ], "summary": "List Accessor Parties", "description": "

List Accessor Parties

Returns the parties that can see the process. This is what the platform app shows as \"Wer sieht diesen Vorgang?\".

Module: Processes

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/accessor-parties/{partyId}": { "put": { "tags": [ "Process" ], "summary": "Add Accessor Party", "description": "

Add Accessor Party

Grants a party access to the process, so that the party and the accounts representing it can work on it. The party has to be related to the calling party.

Module: Processes

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (4)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Process" ], "summary": "Remove Accessor Party", "description": "

Remove Accessor Party

Revokes the access of a party to the process. The party that created the process cannot be removed.

Module: Processes

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (4)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/additional-linked-units": { "get": { "tags": [ "Process" ], "summary": "List Additional Linked Units", "description": "

List Additional Linked Units

Returns all units that are additionally linked to this process (can be an empty set). The main unit (Process.UnitId) is not included here.

Module: Processes

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/editor-clerks": { "get": { "tags": [ "Process" ], "summary": "List Editor Clerks", "description": "

List Editor Clerks

Module: Processes

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/editor-clerks/{accountId}": { "put": { "tags": [ "Process" ], "summary": "Add Editor Clerk", "description": "

Add Editor Clerk

Module: Processes

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (4)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/feed": { "post": { "tags": [ "Process" ], "summary": "Create Feed", "description": "

Create Feed

Module: Processes

Returns: Processes → Feed → ProcessFeedRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

Required Permissions: Permission (8)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessFeedWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessFeedWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessFeedWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Process" ], "summary": "List Feed", "description": "

List Feed

Module: Processes

Returns: Processes → Feed → ProcessFeedRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/files": { "get": { "tags": [ "Process" ], "summary": "List Files", "description": "

List Files

Module: Processes

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "FileName", "in": "query", "schema": { "type": "string" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/inquiries": { "get": { "tags": [ "Process" ], "summary": "List Inquiries", "description": "

List Inquiries

Module: Processes

Returns: Inquiries → Inquiries → InquiryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (135)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInquiryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/insurance-claims": { "get": { "tags": [ "Process" ], "summary": "List Process Insurance Claims", "description": "

List Process Insurance Claims

Module: Processes

Returns: Processes → Process Insurance Claims → ProcessInsuranceClaimRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessInsuranceClaimRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessInsuranceClaimRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessInsuranceClaimRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/process-stage": { "get": { "tags": [ "Process" ], "summary": "Show Process Stage", "description": "

Show Process Stage

Module: Processes

Returns: Processes → Stages → ProcessStageRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcessStageRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessStageRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessStageRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/property-billing-addresses": { "get": { "tags": [ "Process" ], "summary": "List Billing Addresses", "description": "

List Billing Addresses

Module: Processes

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/responsible-clerks/{accountId}": { "delete": { "tags": [ "Process" ], "summary": "Remove Clerk", "description": "

Remove Clerk

Module: Processes

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (4)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/spectator-clerks": { "get": { "tags": [ "Process" ], "summary": "List Spectator Clerks", "description": "

List Spectator Clerks

Module: Processes

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/spectator-clerks/{accountId}": { "put": { "tags": [ "Process" ], "summary": "Add Spectator Clerk", "description": "

Add Spectator Clerk

Module: Processes

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (4)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/user-tasks": { "get": { "tags": [ "Process" ], "summary": "List Process User Tasks", "description": "

List Process User Tasks

Returns the entities related to the specified resource.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/user-tasks/{userTaskId}": { "put": { "tags": [ "Process" ], "summary": "Add User Task To Process", "description": "

Add User Task To Process

Creates or updates the relation between the specified resource and an related entity. This operation modifies only the association, not the underlying entities’ data.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userTaskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Process" ], "summary": "Remove User Task From Process", "description": "

Remove User Task From Process

Removes the relation between the specified resource and an the related entity. This operation deletes only the association, leaving the underlying, referenced entity untouched.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userTaskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/processes/{id}/work-orders": { "get": { "tags": [ "Process" ], "summary": "List Work Orders", "description": "

List Work Orders

Module: Processes

Returns: Processes → Work Orders → WorkOrderRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds": { "post": { "tags": [ "ProcessFeed" ], "summary": "Create Process Feed", "description": "

Create Process Feed

Creates a new process feed from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Feed → ProcessFeedRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessFeedWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ProcessFeed" ], "summary": "List Process Feeds", "description": "

List Process Feeds

Returns a paginated list of process feeds filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Feed → ProcessFeedRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/batch": { "post": { "tags": [ "ProcessFeed" ], "summary": "Batch List Process Feeds", "description": "

Batch List Process Feeds

Retrieves process feeds matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Feed → ProcessFeedRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessFeedRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessFeed" ], "summary": "Update Process Feeds", "description": "

Update Process Feeds

Performs an partial update on multiple process feeds identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/search": { "post": { "tags": [ "ProcessFeed" ], "summary": "Search Process Feeds", "description": "

Search Process Feeds

Performs a search applying filtering, sorting, and pagination criteria within the process feeds, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Feed → ProcessFeedRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessFeedSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}": { "get": { "tags": [ "ProcessFeed" ], "summary": "Get Process Feed", "description": "

Get Process Feed

Provides detailed information for a single process feed identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Feed → ProcessFeedRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessFeed" ], "summary": "Update Process Feed", "description": "

Update Process Feed

Applies an partial update to an existing process feed specified by its ID, affecting only process feeds within the caller’s permitted scope.

Module: Processes

Returns: Processes → Feed → ProcessFeedRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessFeed" ], "summary": "Delete Process Feed", "description": "

Delete Process Feed

Deletes the specified process feed, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}/accessor-parties": { "get": { "tags": [ "ProcessFeed" ], "summary": "Get Accessor Parties", "description": "

Get Accessor Parties

Module: Processes

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}/accessor-parties/{partyId}": { "put": { "tags": [ "ProcessFeed" ], "summary": "Add Party To Process Feed", "description": "

Add Party To Process Feed

Creates or updates the relation between the specified resource and an related entity. This operation modifies only the association, not the underlying entities’ data.

Module: Processes

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessFeed" ], "summary": "Remove Party From Process Feed", "description": "

Remove Party From Process Feed

Removes the relation between the specified resource and an the related entity. This operation deletes only the association, leaving the underlying, referenced entity untouched.

Module: Processes

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}/attachments": { "get": { "tags": [ "ProcessFeed" ], "summary": "Get Attachments", "description": "

Get Attachments

Module: Processes

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}/attachments/{fileId}": { "put": { "tags": [ "ProcessFeed" ], "summary": "Attach File", "description": "

Attach File

Module: Processes

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessFeed" ], "summary": "Detach File", "description": "

Detach File

Module: Processes

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}/category": { "get": { "tags": [ "ProcessFeed" ], "summary": "Get Category", "description": "

Get Category

Module: Processes

Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Contractor (5)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessFeed" ], "summary": "Remove Category", "description": "

Remove Category

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Contractor (5)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Void" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Void" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Void" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}/category/{categoryId}": { "put": { "tags": [ "ProcessFeed" ], "summary": "Set Category", "description": "

Set Category

Module: Processes

Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Contractor (5)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}/creator-party": { "get": { "tags": [ "ProcessFeed" ], "summary": "Get Creator Party", "description": "

Get Creator Party

Returns the creator party of the given process feed.

Module: Processes

Returns: Identity → Parties → PartyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feeds/{id}/notifications": { "get": { "tags": [ "ProcessFeed" ], "summary": "Get Notifications", "description": "

Get Notifications

Module: Processes

Returns: Processes → Notifications → ProcessNotificationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessNotificationRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessNotificationRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessNotificationRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feed-categories": { "post": { "tags": [ "ProcessFeedCategory" ], "summary": "Create Process Feed Category", "description": "

Create Process Feed Category

Creates a new process feed category from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessFeedCategoryWrite" } ], "description": "Represents a category for process feed entries (Verlaufskategorien)\nthat can be defined by a party and attached to any process feed." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ProcessFeedCategory" ], "summary": "List Process Feed Categories", "description": "

List Process Feed Categories

Returns a paginated list of process feed categories filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedCategoryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feed-categories/batch": { "post": { "tags": [ "ProcessFeedCategory" ], "summary": "Batch List Process Feed Categories", "description": "

Batch List Process Feed Categories

Retrieves process feed categories matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessFeedCategory" ], "summary": "Update Process Feed Categories", "description": "

Update Process Feed Categories

Performs an partial update on multiple process feed categories identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feed-categories/search": { "post": { "tags": [ "ProcessFeedCategory" ], "summary": "Search Process Feed Categories", "description": "

Search Process Feed Categories

Performs a search applying filtering, sorting, and pagination criteria within the process feed categories, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedCategoryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feed-categories/{id}": { "get": { "tags": [ "ProcessFeedCategory" ], "summary": "Get Process Feed Category", "description": "

Get Process Feed Category

Provides detailed information for a single process feed category identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessFeedCategory" ], "summary": "Update Process Feed Category", "description": "

Update Process Feed Category

Applies an partial update to an existing process feed category specified by its ID, affecting only process feed categories within the caller’s permitted scope.

Module: Processes

Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessFeedCategory" ], "summary": "Delete Process Feed Category", "description": "

Delete Process Feed Category

Deletes the specified process feed category, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feed-types": { "get": { "tags": [ "ProcessFeedType" ], "summary": "List Process Feed Types", "description": "

List Process Feed Types

Returns a paginated list of process feed types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Feed → Types → ProcessFeedTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feed-types/batch": { "post": { "tags": [ "ProcessFeedType" ], "summary": "Batch List Process Feed Types", "description": "

Batch List Process Feed Types

Retrieves process feed types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Feed → Types → ProcessFeedTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessFeedTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feed-types/search": { "post": { "tags": [ "ProcessFeedType" ], "summary": "Search Process Feed Types", "description": "

Search Process Feed Types

Performs a search applying filtering, sorting, and pagination criteria within the process feed types, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Feed → Types → ProcessFeedTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessFeedTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-feed-types/{id}": { "get": { "tags": [ "ProcessFeedType" ], "summary": "Get Process Feed Type", "description": "

Get Process Feed Type

Provides detailed information for a single process feed type identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Feed → Types → ProcessFeedTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessFeedTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-insurance-claims": { "post": { "tags": [ "ProcessInsuranceClaim" ], "summary": "Create Process Insurance Claim", "description": "

Create Process Insurance Claim

Creates a new process insurance claim from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Process Insurance Claims → ProcessInsuranceClaimRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessInsuranceClaimWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessInsuranceClaimRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ProcessInsuranceClaim" ], "summary": "List Process Insurance Claims", "description": "

List Process Insurance Claims

Returns a paginated list of process insurance claims filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Process Insurance Claims → ProcessInsuranceClaimRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessInsuranceClaimRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-insurance-claims/batch": { "post": { "tags": [ "ProcessInsuranceClaim" ], "summary": "Batch List Process Insurance Claims", "description": "

Batch List Process Insurance Claims

Retrieves process insurance claims matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Process Insurance Claims → ProcessInsuranceClaimRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessInsuranceClaimRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessInsuranceClaim" ], "summary": "Update Process Insurance Claims", "description": "

Update Process Insurance Claims

Performs an partial update on multiple process insurance claims identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-insurance-claims/search": { "post": { "tags": [ "ProcessInsuranceClaim" ], "summary": "Search Process Insurance Claims", "description": "

Search Process Insurance Claims

Performs a search applying filtering, sorting, and pagination criteria within the process insurance claims, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Process Insurance Claims → ProcessInsuranceClaimRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessInsuranceClaimSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessInsuranceClaimRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-insurance-claims/{id}": { "get": { "tags": [ "ProcessInsuranceClaim" ], "summary": "Get Process Insurance Claim", "description": "

Get Process Insurance Claim

Provides detailed information for a single process insurance claim identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Process Insurance Claims → ProcessInsuranceClaimRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessInsuranceClaimRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessInsuranceClaim" ], "summary": "Update Process Insurance Claim", "description": "

Update Process Insurance Claim

Applies an partial update to an existing process insurance claim specified by its ID, affecting only process insurance claims within the caller’s permitted scope.

Module: Processes

Returns: Processes → Process Insurance Claims → ProcessInsuranceClaimRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Insurance Broker (13)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessInsuranceClaimRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessInsuranceClaim" ], "summary": "Delete Process Insurance Claim", "description": "

Delete Process Insurance Claim

Deletes the specified process insurance claim, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-notifications": { "post": { "tags": [ "ProcessNotification" ], "summary": "Create Process Notification", "description": "

Create Process Notification

Creates a new process notification from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Notifications → ProcessNotificationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessNotificationWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessNotificationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ProcessNotification" ], "summary": "List Process Notifications", "description": "

List Process Notifications

Returns a paginated list of process notifications filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Notifications → ProcessNotificationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessNotificationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-notifications/batch": { "post": { "tags": [ "ProcessNotification" ], "summary": "Batch List Process Notifications", "description": "

Batch List Process Notifications

Retrieves process notifications matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Notifications → ProcessNotificationRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessNotificationRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessNotification" ], "summary": "Update Process Notifications", "description": "

Update Process Notifications

Performs an partial update on multiple process notifications identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-notifications/search": { "post": { "tags": [ "ProcessNotification" ], "summary": "Search Process Notifications", "description": "

Search Process Notifications

Performs a search applying filtering, sorting, and pagination criteria within the process notifications, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Notifications → ProcessNotificationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessNotificationSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessNotificationRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-notifications/{id}": { "get": { "tags": [ "ProcessNotification" ], "summary": "Get Process Notification", "description": "

Get Process Notification

Provides detailed information for a single process notification identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Notifications → ProcessNotificationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessNotificationRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessNotification" ], "summary": "Update Process Notification", "description": "

Update Process Notification

Applies an partial update to an existing process notification specified by its ID, affecting only process notifications within the caller’s permitted scope.

Module: Processes

Returns: Processes → Notifications → ProcessNotificationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessNotificationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessNotification" ], "summary": "Delete Process Notification", "description": "

Delete Process Notification

Deletes the specified process notification, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-stages": { "post": { "tags": [ "ProcessStage" ], "summary": "Create Process Stage", "description": "

Create Process Stage

Creates a new process stage from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Stages → ProcessStageRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessStageWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessStageRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ProcessStage" ], "summary": "List Process Stages", "description": "

List Process Stages

Returns a paginated list of process stages filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Stages → ProcessStageRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessStageRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-stages/batch": { "post": { "tags": [ "ProcessStage" ], "summary": "Batch List Process Stages", "description": "

Batch List Process Stages

Retrieves process stages matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Stages → ProcessStageRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessStageRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessStage" ], "summary": "Update Process Stages", "description": "

Update Process Stages

Performs an partial update on multiple process stages identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-stages/search": { "post": { "tags": [ "ProcessStage" ], "summary": "Search Process Stages", "description": "

Search Process Stages

Performs a search applying filtering, sorting, and pagination criteria within the process stages, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Stages → ProcessStageRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProcessStageSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessStageRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-stages/{id}": { "get": { "tags": [ "ProcessStage" ], "summary": "Get Process Stage", "description": "

Get Process Stage

Provides detailed information for a single process stage identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Stages → ProcessStageRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessStageRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ProcessStage" ], "summary": "Update Process Stage", "description": "

Update Process Stage

Applies an partial update to an existing process stage specified by its ID, affecting only process stages within the caller’s permitted scope.

Module: Processes

Returns: Processes → Stages → ProcessStageRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessStageRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessStage" ], "summary": "Delete Process Stage", "description": "

Delete Process Stage

Deletes the specified process stage, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-stages/{id}/process-types": { "get": { "tags": [ "ProcessStage" ], "summary": "List Process Stages", "description": "

List Process Stages

Module: Processes

Returns: Processes → Types → ProcessTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessTypeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessTypeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-types": { "get": { "tags": [ "ProcessType" ], "summary": "List Process Types", "description": "

List Process Types

Returns a paginated list of process types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Types → ProcessTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-types/batch": { "post": { "tags": [ "ProcessType" ], "summary": "Batch List Process Types", "description": "

Batch List Process Types

Retrieves process types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Types → ProcessTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-types/search": { "post": { "tags": [ "ProcessType" ], "summary": "Search Process Types", "description": "

Search Process Types

Performs a search applying filtering, sorting, and pagination criteria within the process types, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Types → ProcessTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-types/{id}": { "get": { "tags": [ "ProcessType" ], "summary": "Get Process Type", "description": "

Get Process Type

Provides detailed information for a single process type identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Types → ProcessTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-types/{id}/process-stages": { "get": { "tags": [ "ProcessType" ], "summary": "List Process Stages", "description": "

List Process Stages

Module: Processes

Returns: Processes → Processes → ExtendedProcessStageRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfExtendedProcessStageRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfExtendedProcessStageRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfExtendedProcessStageRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/process-types/{id}/process-stages/{processStageId}": { "put": { "tags": [ "ProcessType" ], "summary": "Add Process Stage", "description": "

Add Process Stage

Module: Processes

Returns: Processes → Stages → ProcessStageProcessTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "processStageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddProcessStageRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddProcessStageRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddProcessStageRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProcessStageProcessTypeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProcessStageProcessTypeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProcessStageProcessTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ProcessType" ], "summary": "Remove Process Stage", "description": "

Remove Process Stage

Module: Processes

Returns: Processes → Stages → ProcessStageRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Energy Provider (10), Guest (11), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "processStageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessStageRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessStageRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessStageRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties": { "post": { "tags": [ "Property" ], "summary": "Create Property", "description": "

Create Property

Creates a new property from the provided data, associating it within the requester's scope.

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PropertyWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Property" ], "summary": "List Properties", "description": "

List Properties

Returns a paginated list of properties filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/batch": { "post": { "tags": [ "Property" ], "summary": "Batch List Properties", "description": "

Batch List Properties

Retrieves properties matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Property" ], "summary": "Update Properties", "description": "

Update Properties

Performs an partial update on multiple properties identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Properties

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/search": { "post": { "tags": [ "Property" ], "summary": "Search Properties", "description": "

Search Properties

Performs a search applying filtering, sorting, and pagination criteria within the properties, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PropertySearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}": { "get": { "tags": [ "Property" ], "summary": "Get Property", "description": "

Get Property

Provides detailed information for a single property identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7), Insurance Broker (13)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Property" ], "summary": "Update Property", "description": "

Update Property

Applies an partial update to an existing property specified by its ID, affecting only properties within the caller’s permitted scope.

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Property" ], "summary": "Delete Property", "description": "

Delete Property

Deletes the specified property, if it falls within the caller’s scope.

Module: Properties

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/attributes": { "get": { "tags": [ "Property" ], "summary": "Get Attributes", "description": "

Get Attributes

Module: Properties

Returns: Master Data → Properties → Attributes → AttributeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/attribute-groups": { "post": { "tags": [ "Property" ], "summary": "Create Attribute Group", "description": "

Create Attribute Group

Module: Properties

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeGroupWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeGroupWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeGroupWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Property" ], "summary": "List Attribute Groups", "description": "

List Attribute Groups

Module: Properties

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/attribute-groups/{attributeGroupId}": { "delete": { "tags": [ "Property" ], "summary": "Remove Attribute Group", "description": "

Remove Attribute Group

Module: Properties

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/attribute-values": { "get": { "tags": [ "Property" ], "summary": "List Attribute Values", "description": "

List Attribute Values

Module: Properties

Returns: Master Data → Properties → Attribute Values → AttributeValueRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeValueRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeValueRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeValueRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/bank-account": { "get": { "tags": [ "Property" ], "summary": "Get Bank Account", "description": "

Get Bank Account

Module: Properties

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/bank-account/{bankAccountId}": { "post": { "tags": [ "Property" ], "summary": "Add Bank Account", "description": "

Add Bank Account

Module: Properties

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "bankAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Property" ], "summary": "Remove Bank Account", "description": "

Remove Bank Account

Module: Properties

Returns: Master Data → Parties → Bank Accounts → BankAccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "bankAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBankAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/billing-addresses": { "post": { "tags": [ "Property" ], "summary": "Create Billing Address", "description": "

Create Billing Address

Module: Properties

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Contractor (5)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BillingAddressWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BillingAddressWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BillingAddressWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Property" ], "summary": "List Billing Addresses", "description": "

List Billing Addresses

Module: Properties

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/conferences": { "get": { "tags": [ "Property" ], "summary": "Get Conferences", "description": "

Get Conferences

Module: Properties

Returns: Conferences → Conferences → ConferenceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceRead" }, "example": {"items":[{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Innenhof Rechts beim Restaurant","additionalInfo":null,"room":"Raum 201","externalId":"10059d14-0468-47ae-9e54-00b5fbd99ffa","date":"2026-10-19T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":1},{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":null,"additionalLocation":null,"additionalInfo":null,"room":null,"externalId":null,"date":"2026-10-19T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":2},{"partyId":null,"propertyManagementCompanyId":null,"title":"Annual Owners Meeting 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Inner courtyard Behind the fountain","additionalInfo":null,"room":"Room 201","externalId":"a85cda04-974f-435e-a58c-149c0d025b74","date":"2026-11-01T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":2,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceRead" }, "example": {"items":[{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Innenhof Rechts beim Restaurant","additionalInfo":null,"room":"Raum 201","externalId":"10059d14-0468-47ae-9e54-00b5fbd99ffa","date":"2026-10-19T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":1},{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":null,"additionalLocation":null,"additionalInfo":null,"room":null,"externalId":null,"date":"2026-10-19T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":2},{"partyId":null,"propertyManagementCompanyId":null,"title":"Annual Owners Meeting 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Inner courtyard Behind the fountain","additionalInfo":null,"room":"Room 201","externalId":"a85cda04-974f-435e-a58c-149c0d025b74","date":"2026-11-01T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":2,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceRead" }, "example": {"items":[{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Innenhof Rechts beim Restaurant","additionalInfo":null,"room":"Raum 201","externalId":"10059d14-0468-47ae-9e54-00b5fbd99ffa","date":"2026-10-19T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":1},{"partyId":null,"propertyManagementCompanyId":null,"title":"Eigentümerversammlung 2026","location":null,"additionalLocation":null,"additionalInfo":null,"room":null,"externalId":null,"date":"2026-10-19T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":1,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":2},{"partyId":null,"propertyManagementCompanyId":null,"title":"Annual Owners Meeting 2026","location":"Kurfürstendamm 92, 10709 Berlin","additionalLocation":"Inner courtyard Behind the fountain","additionalInfo":null,"room":"Room 201","externalId":"a85cda04-974f-435e-a58c-149c0d025b74","date":"2026-11-01T12:14:03Z","creatorId":0,"completed":false,"interfaceId":1,"accountableUnits":null,"onlineManagerCount":null,"onlineOwnerCount":null,"onSitePresentationDescription":null,"onSitePresentationTitleBackgroundColor":null,"onSitePresentationBodyBackgroundColor":null,"onSitePresentationTitleTextColor":null,"onSitePresentationBodyTextColor":null,"onSitePresentationImageId":null,"propertyId":2,"isSharedWithOwners":true,"startedAt":null,"endedAt":null,"invitationState":0,"invitationsCreatedAt":null,"state":0,"created":null,"lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/conference-settings": { "get": { "tags": [ "Property" ], "summary": "Show Conference Settings", "description": "

Show Conference Settings

Module: Properties

Returns: Conferences → Settings → SettingsRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SettingsRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SettingsRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SettingsRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/construction-parties": { "get": { "tags": [ "Property" ], "summary": "Get Construction Parties", "description": "

Get Construction Parties

Module: Properties

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/construction-parties/{partyId}/trades": { "get": { "tags": [ "Property" ], "summary": "Get Trades Of Construction Party", "description": "

Get Trades Of Construction Party

Module: Properties

Returns: Master Data → Parties → Trades → TradeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/construction-parties/{partyId}/trades/{tradeId}": { "put": { "tags": [ "Property" ], "summary": "Assign Construction Party To Property With Trade", "description": "

Assign Construction Party To Property With Trade

Assigns a construction party to a property with a specific trade. All trades that are accessible from GET /api/trades can be assigned.

Module: Properties

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tradeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Property" ], "summary": "Remove Trade For Construction Party For Property", "description": "

Remove Trade For Construction Party For Property

Removes a trade assignment for a construction party on a property.

Module: Properties

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tradeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/document-groups": { "get": { "tags": [ "Property" ], "summary": "List Document Groups", "description": "

List Document Groups

Module: Properties

Returns: Documents → Document Groups → DocumentGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (32)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/document-groups/{documentGroupId}/documents": { "get": { "tags": [ "Property" ], "summary": "List Documents", "description": "

List Documents

Module: Properties

Returns: Documents → Documents → DocumentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (32)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "documentGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/eligible-units": { "get": { "tags": [ "Property" ], "summary": "List Eligible Units", "description": "

List Eligible Units

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Property" ], "summary": "Set Eligible Units", "description": "

Set Eligible Units

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/emergency-contacts": { "get": { "tags": [ "Property" ], "summary": "List Property Emergency Contacts", "description": "

List Property Emergency Contacts

Module: Properties

Returns: Customer App → Property Emergency Contacts → PropertyEmergencyContactRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyEmergencyContactRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyEmergencyContactRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyEmergencyContactRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/entrances": { "get": { "tags": [ "Property" ], "summary": "List Entrances", "description": "

List Entrances

Module: Properties

Returns: Master Data → Properties → Entrances → EntranceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEntranceRead" }, "example": {"items":[{"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEntranceRead" }, "example": {"items":[{"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfEntranceRead" }, "example": {"items":[{"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/facility-managers": { "get": { "tags": [ "Property" ], "summary": "Get Facility Managers", "description": "

Get Facility Managers

Returns the assigned facility manager parties for this property. Facility managers are basically parties for this property with the trade `FacilityManagementService`.

Module: Properties

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/image": { "get": { "tags": [ "Property" ], "summary": "Download Image", "description": "

Download Image

Module: Properties

Returns: Documents → Files → FileDownloadResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileDownloadResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/owners": { "get": { "tags": [ "Property" ], "summary": "Get Owners", "description": "

Get Owners

Module: Properties

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/ownership-units": { "get": { "tags": [ "Property" ], "summary": "List Ownership Units", "description": "

List Ownership Units

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/previous-resolutions-file": { "get": { "tags": [ "Property" ], "summary": "Get Previous Resolutions File", "description": "

Get Previous Resolutions File

Module: Properties

Returns: Documents → Files → FileRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Property" ], "summary": "Replace Previous Resolutions File With New File", "description": "

Replace Previous Resolutions File With New File

Module: Properties

Returns: Documents → Files → FileRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/previous-resolutions-file/{fileId}": { "put": { "tags": [ "Property" ], "summary": "Replace Previous Resolutions File With Existing File", "description": "

Replace Previous Resolutions File With Existing File

Module: Properties

Returns: Documents → Files → FileRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/processes": { "get": { "tags": [ "Property" ], "summary": "List Processes", "description": "

List Processes

Module: Properties

Returns: Processes → Processes → ProcessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (45)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/resolutions": { "get": { "tags": [ "Property" ], "summary": "Get Resolutions", "description": "

Get Resolutions

Module: Properties

Returns: Conferences → Resolutions → ResolutionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/resolution-collection-document": { "get": { "tags": [ "Property" ], "summary": "Get Resolution Collection Document", "description": "

Get Resolution Collection Document

Module: Properties

Returns: System → Object (list)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "byte" } }, "application/pdf": { "schema": { "type": "string", "format": "byte" } }, "text/csv": { "schema": { "type": "string", "format": "byte" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/responsible-staff-list": { "get": { "tags": [ "Property" ], "summary": "Get Responsible Staff", "description": "

Get Responsible Staff

Returns all Accounts of the Owner Party of the associated Tenant of the Property. To retrieve the Accounts responsible for this particular Property, use /responsible-staff-members.

Module: Properties

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/responsible-staff-members": { "get": { "tags": [ "Property" ], "summary": "Get Responsible Staff Members", "description": "

Get Responsible Staff Members

Module: Properties

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/responsible-staff-members/{accountId}/role": { "get": { "tags": [ "Property" ], "summary": "Show Role By Property And Account", "description": "

Show Role By Property And Account

Module: Properties

Returns: Master Data → Properties → Properties → Roles → PropertyRoleRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PropertyRoleRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRoleRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PropertyRoleRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/responsible-staff-members/{accountId}/roles": { "get": { "tags": [ "Property" ], "summary": "Show Roles By Property And Account", "description": "

Show Roles By Property And Account

Module: Properties

Returns: Master Data → Properties → Properties → Roles → PropertyRoleRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/role-mappings": { "post": { "tags": [ "Property" ], "summary": "Add Property Role Mapping", "description": "

Add Property Role Mapping

Module: Properties

Returns: Master Data → Properties → Properties → Roles → Mappings → PropertyRoleMapping (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PropertyRoleMapping" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PropertyRoleMapping" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PropertyRoleMapping" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Property" ], "summary": "List Property Role Mappings", "description": "

List Property Role Mappings

Module: Properties

Returns: Master Data → Properties → Properties → Roles → Mappings → PropertyRoleMapping (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/role-mappings/{accountId}": { "get": { "tags": [ "Property" ], "summary": "List Property Role Mappings For Account", "description": "

List Property Role Mappings For Account

Module: Properties

Returns: Master Data → Properties → Properties → Roles → Mappings → PropertyRoleMapping (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/role-mappings/{accountId}/{roleId}": { "delete": { "tags": [ "Property" ], "summary": "Remove Property Role Mapping", "description": "

Remove Property Role Mapping

Module: Properties

Returns: Master Data → Properties → Properties → Roles → Mappings → PropertyRoleMapping (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "roleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleMapping" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/shares-attributes": { "get": { "tags": [ "Property" ], "summary": "Get Shares Attributes", "description": "

Get Shares Attributes

Module: Properties

Returns: Master Data → Properties → Attributes → AttributeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/shares-attributes/{attributeId}": { "put": { "tags": [ "Property" ], "summary": "Connect Shares Attribute To Property", "description": "

Connect Shares Attribute To Property

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Property" ], "summary": "Remove Shares Attribute From Property", "description": "

Remove Shares Attribute From Property

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/technical-unit": { "get": { "tags": [ "Property" ], "summary": "Get Technical Unit", "description": "

Get Technical Unit

Returns the technical unit of a property if it exists.

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Property" ], "summary": "Provision Technical Unit", "description": "

Provision Technical Unit

Returns the technical unit of a property. If no technical unit exists yet, it will be created automatically. Calling this endpoint multiple times will always return the same technical unit.

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/tenant": { "get": { "tags": [ "Property" ], "summary": "Show Tenant", "description": "

Show Tenant

Module: Properties

Returns: Master Data → Properties → Tenants → TenantRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

Required Permissions: Permission (62)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/trades": { "get": { "tags": [ "Property" ], "summary": "List Trades", "description": "

List Trades

Module: Properties

Returns: Master Data → Parties → Trades → TradeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/trades/{tradeId}/construction-parties": { "get": { "tags": [ "Property" ], "summary": "Get Construction Parties For Trade", "description": "

Get Construction Parties For Trade

Returns the construction parties assigned to the specified trade for this property.

Module: Properties

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tradeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/trades/{tradeId}/parties": { "get": { "tags": [ "Property" ], "summary": "List Trade Parties", "description": "

List Trade Parties

Module: Properties

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tradeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/units": { "get": { "tags": [ "Property" ], "summary": "Get Units", "description": "

Get Units

Module: Properties

Returns: Master Data → Properties → Units → DetailedUnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

Required Permissions: Permission (66)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDetailedUnitRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDetailedUnitRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDetailedUnitRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/units/shares": { "get": { "tags": [ "Property" ], "summary": "List Unit Shares", "description": "

List Unit Shares

Module: Properties

Returns: Attributes → Responses → SharesResponse (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSharesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSharesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSharesResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/unit-contracts": { "get": { "tags": [ "Property" ], "summary": "List Unit Contracts", "description": "

List Unit Contracts

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/voting-groups": { "get": { "tags": [ "Property" ], "summary": "List Voting Groups", "description": "

List Voting Groups

Module: Properties

Returns: Conferences → Voting Groups → VotingGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/propertymanagers": { "get": { "tags": [ "PropertyManager" ], "summary": "List Property Managers", "description": "

List Property Managers

Module: Authentication

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/property-billing-addresses": { "post": { "tags": [ "PropertyBillingAddress" ], "summary": "Create Property Billing Addres", "description": "

Create Property Billing Addres

Creates a new property billing addres from the provided data, associating it within the requester's scope.

Module: Properties

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BillingAddressWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingAddressRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "PropertyBillingAddress" ], "summary": "List Property Billing Addresses", "description": "

List Property Billing Addresses

Returns a paginated list of property billing addresses filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-billing-addresses/batch": { "post": { "tags": [ "PropertyBillingAddress" ], "summary": "Batch List Property Billing Addresses", "description": "

Batch List Property Billing Addresses

Retrieves property billing addresses matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAddressRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "PropertyBillingAddress" ], "summary": "Update Property Billing Addresses", "description": "

Update Property Billing Addresses

Performs an partial update on multiple property billing addresses identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Properties

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-billing-addresses/search": { "post": { "tags": [ "PropertyBillingAddress" ], "summary": "Search Property Billing Addresses", "description": "

Search Property Billing Addresses

Performs a search applying filtering, sorting, and pagination criteria within the property billing addresses, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Properties

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BillingAddressSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfBillingAddressRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-billing-addresses/{id}": { "get": { "tags": [ "PropertyBillingAddress" ], "summary": "Get Property Billing Addres", "description": "

Get Property Billing Addres

Provides detailed information for a single property billing addres identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingAddressRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "PropertyBillingAddress" ], "summary": "Update Property Billing Addres", "description": "

Update Property Billing Addres

Applies an partial update to an existing property billing addres specified by its ID, affecting only property billing addresses within the caller’s permitted scope.

Module: Properties

Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingAddressRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "PropertyBillingAddress" ], "summary": "Delete Property Billing Addres", "description": "

Delete Property Billing Addres

Deletes the specified property billing addres, if it falls within the caller’s scope.

Module: Properties

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-emergency-contacts": { "post": { "tags": [ "PropertyEmergencyContact" ], "summary": "Create Property Emergency Contact", "description": "

Create Property Emergency Contact

Creates a new property emergency contact from the provided data, associating it within the requester's scope.

Module: Properties

Returns: Customer App → Property Emergency Contacts → PropertyEmergencyContactRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PropertyEmergencyContactWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyEmergencyContactRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "PropertyEmergencyContact" ], "summary": "List Property Emergency Contacts", "description": "

List Property Emergency Contacts

Returns a paginated list of property emergency contacts filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Customer App → Property Emergency Contacts → PropertyEmergencyContactRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyEmergencyContactRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-emergency-contacts/batch": { "post": { "tags": [ "PropertyEmergencyContact" ], "summary": "Batch List Property Emergency Contacts", "description": "

Batch List Property Emergency Contacts

Retrieves property emergency contacts matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Customer App → Property Emergency Contacts → PropertyEmergencyContactRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyEmergencyContactRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "PropertyEmergencyContact" ], "summary": "Update Property Emergency Contacts", "description": "

Update Property Emergency Contacts

Performs an partial update on multiple property emergency contacts identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Properties

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-emergency-contacts/search": { "post": { "tags": [ "PropertyEmergencyContact" ], "summary": "Search Property Emergency Contacts", "description": "

Search Property Emergency Contacts

Performs a search applying filtering, sorting, and pagination criteria within the property emergency contacts, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Properties

Returns: Customer App → Property Emergency Contacts → PropertyEmergencyContactRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PropertyEmergencyContactSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyEmergencyContactRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-emergency-contacts/{id}": { "get": { "tags": [ "PropertyEmergencyContact" ], "summary": "Get Property Emergency Contact", "description": "

Get Property Emergency Contact

Provides detailed information for a single property emergency contact identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Customer App → Property Emergency Contacts → PropertyEmergencyContactRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyEmergencyContactRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "PropertyEmergencyContact" ], "summary": "Update Property Emergency Contact", "description": "

Update Property Emergency Contact

Applies an partial update to an existing property emergency contact specified by its ID, affecting only property emergency contacts within the caller’s permitted scope.

Module: Properties

Returns: Customer App → Property Emergency Contacts → PropertyEmergencyContactRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyEmergencyContactRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "PropertyEmergencyContact" ], "summary": "Delete Property Emergency Contact", "description": "

Delete Property Emergency Contact

Deletes the specified property emergency contact, if it falls within the caller’s scope.

Module: Properties

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-management-companies": { "get": { "tags": [ "PropertyManagementCompany" ], "summary": "Get Property Management Companies", "description": "

Get Property Management Companies

Module: Identity

Returns: Identity → Parties → PartyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/property-management-companies/{id}": { "get": { "tags": [ "PropertyManagementCompany" ], "summary": "Get Property Management Company", "description": "

Get Property Management Company

Module: Identity

Returns: Identity → Parties → PartyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/property-management-companies/{id}/conference-interface": { "get": { "tags": [ "PropertyManagementCompany" ], "summary": "Show Interface", "description": "

Show Interface

Module: Identity

Returns: Conferences → Interfaces → ConferenceInterfaceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConferenceInterfaceRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceInterfaceRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConferenceInterfaceRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/property-management-companies/{id}/managers": { "get": { "tags": [ "PropertyManagementCompany" ], "summary": "Get Property Managers", "description": "

Get Property Managers

Module: Identity

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "deprecated": true, "security": [ { "Bearer": [ ] } ] } }, "/api/property-roles": { "get": { "tags": [ "PropertyRole" ], "summary": "List Property Roles", "description": "

List Property Roles

Returns a paginated list of property roles filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Properties → Roles → PropertyRoleRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-roles/batch": { "post": { "tags": [ "PropertyRole" ], "summary": "Batch List Property Roles", "description": "

Batch List Property Roles

Retrieves property roles matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Properties → Roles → PropertyRoleRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyRoleRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-roles/{id}": { "get": { "tags": [ "PropertyRole" ], "summary": "Get Property Role", "description": "

Get Property Role

Provides detailed information for a single property role identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Properties → Roles → PropertyRoleRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRoleRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-role-defaults": { "get": { "tags": [ "PropertyRoleDefault" ], "summary": "List Property Role Defaults", "description": "

List Property Role Defaults

Returns a paginated list of property role defaults filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Properties → Roles → Defaults → PropertyRoleDefaultRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRoleDefaultRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-role-defaults/batch": { "post": { "tags": [ "PropertyRoleDefault" ], "summary": "Batch List Property Role Defaults", "description": "

Batch List Property Role Defaults

Retrieves property role defaults matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Properties → Roles → Defaults → PropertyRoleDefaultRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyRoleDefaultRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/property-role-defaults/{id}": { "get": { "tags": [ "PropertyRoleDefault" ], "summary": "Get Property Role Default", "description": "

Get Property Role Default

Provides detailed information for a single property role default identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Properties → Roles → Defaults → PropertyRoleDefaultRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRoleDefaultRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions": { "post": { "tags": [ "Resolution" ], "summary": "Create Resolution", "description": "

Create Resolution

Creates a new resolution from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionRead" }, "examples": { "Simple Resolution Example": { "value": {"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Multi Option Resolution Example": { "value": {"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Dependant Resolution of an Option Example": { "value": {"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "English Resolution Example": { "value": {"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Minimal Resolution Example": { "value": {"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Resolution" ], "summary": "List Resolutions", "description": "

List Resolutions

Returns a paginated list of resolutions filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/batch": { "post": { "tags": [ "Resolution" ], "summary": "Batch List Resolutions", "description": "

Batch List Resolutions

Retrieves resolutions matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Resolution" ], "summary": "Update Resolutions", "description": "

Update Resolutions

Performs an partial update on multiple resolutions identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/search": { "post": { "tags": [ "Resolution" ], "summary": "Search Resolutions", "description": "

Search Resolutions

Performs a search applying filtering, sorting, and pagination criteria within the resolutions, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{id}": { "get": { "tags": [ "Resolution" ], "summary": "Get Resolution", "description": "

Get Resolution

Provides detailed information for a single resolution identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionRead" }, "examples": { "Simple Resolution Example": { "value": {"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Multi Option Resolution Example": { "value": {"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Dependant Resolution of an Option Example": { "value": {"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "English Resolution Example": { "value": {"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Minimal Resolution Example": { "value": {"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Resolution" ], "summary": "Update Resolution", "description": "

Update Resolution

Applies an partial update to an existing resolution specified by its ID, affecting only resolutions within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionRead" }, "examples": { "Simple Resolution Example": { "value": {"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Multi Option Resolution Example": { "value": {"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Dependant Resolution of an Option Example": { "value": {"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "English Resolution Example": { "value": {"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Minimal Resolution Example": { "value": {"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Resolution" ], "summary": "Delete Resolution", "description": "

Delete Resolution

Deletes the specified resolution, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{id}/attachments": { "get": { "tags": [ "Resolution" ], "summary": "Get Attachments", "description": "

Get Attachments

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{id}/attachment-settings": { "get": { "tags": [ "Resolution" ], "summary": "Get Attachment Relations", "description": "

Get Attachment Relations

Module: Conferences

Returns: Conferences → Resolution Attachments → ResolutionAttachmentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionAttachmentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionAttachmentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionAttachmentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{id}/dependant-resolutions": { "get": { "tags": [ "Resolution" ], "summary": "List Dependant Resolutions", "description": "

List Dependant Resolutions

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{id}/eligible-units": { "get": { "tags": [ "Resolution" ], "summary": "List Eligible Units", "description": "

List Eligible Units

Module: Conferences

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Resolution" ], "summary": "Set Eligible Units", "description": "

Set Eligible Units

Module: Conferences

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{id}/options": { "post": { "tags": [ "Resolution" ], "summary": "Create Option", "description": "

Create Option

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Resolution" ], "summary": "Get Options", "description": "

Get Options

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Resolution" ], "summary": "Set Options", "description": "

Set Options

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionWrite" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionWrite" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionWrite" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{id}/voting-groups": { "get": { "tags": [ "Resolution" ], "summary": "List Voting Groups", "description": "

List Voting Groups

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{id}/voting-sessions": { "get": { "tags": [ "Resolution" ], "summary": "Get Voting Sessions", "description": "

Get Voting Sessions

Module: Conferences

Returns: Conferences → Voting → Sessions → VotingSessionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingSessionRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingSessionRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingSessionRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolutions/{resolutionId}/attachments/{fileId}": { "get": { "tags": [ "Resolution" ], "summary": "Get Attachment", "description": "

Get Attachment

Module: Conferences

Returns: Conferences → Resolution Attachments → ResolutionAttachmentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "resolutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionAttachmentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionAttachmentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionAttachmentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Resolution" ], "summary": "Update Attachment", "description": "

Update Attachment

Module: Conferences

Returns: Conferences → Resolution Attachments → ResolutionAttachmentRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "resolutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionAttachmentWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionAttachmentWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionAttachmentWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResolutionAttachmentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionAttachmentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolutionAttachmentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Resolution" ], "summary": "Attach File", "description": "

Attach File

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "resolutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Resolution" ], "summary": "Detach File", "description": "

Detach File

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "resolutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-options": { "post": { "tags": [ "ResolutionOption" ], "summary": "Create Resolution Option", "description": "

Create Resolution Option

Creates a new resolution option from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionOptionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ResolutionOption" ], "summary": "List Resolution Options", "description": "

List Resolution Options

Returns a paginated list of resolution options filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-options/batch": { "post": { "tags": [ "ResolutionOption" ], "summary": "Batch List Resolution Options", "description": "

Batch List Resolution Options

Retrieves resolution options matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ResolutionOption" ], "summary": "Update Resolution Options", "description": "

Update Resolution Options

Performs an partial update on multiple resolution options identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-options/{id}": { "get": { "tags": [ "ResolutionOption" ], "summary": "Get Resolution Option", "description": "

Get Resolution Option

Provides detailed information for a single resolution option identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionOptionRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ResolutionOption" ], "summary": "Update Resolution Option", "description": "

Update Resolution Option

Applies an partial update to an existing resolution option specified by its ID, affecting only resolution options within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionOptionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ResolutionOption" ], "summary": "Delete Resolution Option", "description": "

Delete Resolution Option

Deletes the specified resolution option, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-options/{id}/attached-resolution": { "get": { "tags": [ "ResolutionOption" ], "summary": "Show Attached Resolution", "description": "

Show Attached Resolution

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResolutionRead" }, "examples": { "Simple Resolution Example": { "value": {"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Multi Option Resolution Example": { "value": {"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Dependant Resolution of an Option Example": { "value": {"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "English Resolution Example": { "value": {"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Minimal Resolution Example": { "value": {"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionRead" }, "examples": { "Simple Resolution Example": { "value": {"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Multi Option Resolution Example": { "value": {"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Dependant Resolution of an Option Example": { "value": {"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "English Resolution Example": { "value": {"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Minimal Resolution Example": { "value": {"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResolutionRead" }, "examples": { "Simple Resolution Example": { "value": {"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Multi Option Resolution Example": { "value": {"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Dependant Resolution of an Option Example": { "value": {"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "English Resolution Example": { "value": {"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Minimal Resolution Example": { "value": {"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-options/{id}/attachments": { "get": { "tags": [ "ResolutionOption" ], "summary": "Get Attachments", "description": "

Get Attachments

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-options/{id}/order": { "post": { "tags": [ "ResolutionOption" ], "summary": "Order Resolution Options", "description": "

Order Resolution Options

Module: Conferences

Returns: Conferences → Resolution Options → ResolutionOptionRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-options/{optionId}/attachments/{fileId}": { "put": { "tags": [ "ResolutionOption" ], "summary": "Attach File", "description": "

Attach File

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "optionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ResolutionOption" ], "summary": "Detach File", "description": "

Detach File

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "optionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-option-templates": { "post": { "tags": [ "ResolutionOptionTemplate" ], "summary": "Create Resolution Option Template", "description": "

Create Resolution Option Template

Creates a new resolution option template from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionTemplateWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionOptionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ResolutionOptionTemplate" ], "summary": "List Resolution Option Templates", "description": "

List Resolution Option Templates

Returns a paginated list of resolution option templates filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-option-templates/batch": { "post": { "tags": [ "ResolutionOptionTemplate" ], "summary": "Batch List Resolution Option Templates", "description": "

Batch List Resolution Option Templates

Retrieves resolution option templates matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionTemplateRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ResolutionOptionTemplate" ], "summary": "Update Resolution Option Templates", "description": "

Update Resolution Option Templates

Performs an partial update on multiple resolution option templates identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-option-templates/search": { "post": { "tags": [ "ResolutionOptionTemplate" ], "summary": "Search Resolution Option Templates", "description": "

Search Resolution Option Templates

Performs a search applying filtering, sorting, and pagination criteria within the resolution option templates, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionTemplateSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionTemplateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-option-templates/{id}": { "get": { "tags": [ "ResolutionOptionTemplate" ], "summary": "Get Resolution Option Template", "description": "

Get Resolution Option Template

Provides detailed information for a single resolution option template identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionOptionTemplateRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ResolutionOptionTemplate" ], "summary": "Update Resolution Option Template", "description": "

Update Resolution Option Template

Applies an partial update to an existing resolution option template specified by its ID, affecting only resolution option templates within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionOptionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ResolutionOptionTemplate" ], "summary": "Delete Resolution Option Template", "description": "

Delete Resolution Option Template

Deletes the specified resolution option template, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-templates": { "post": { "tags": [ "ResolutionTemplate" ], "summary": "Create Resolution Template", "description": "

Create Resolution Template

Creates a new resolution template from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Resolution Templates → ResolutionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionTemplateWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ResolutionTemplate" ], "summary": "List Resolution Templates", "description": "

List Resolution Templates

Returns a paginated list of resolution templates filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Resolution Templates → ResolutionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-templates/batch": { "post": { "tags": [ "ResolutionTemplate" ], "summary": "Batch List Resolution Templates", "description": "

Batch List Resolution Templates

Retrieves resolution templates matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Resolution Templates → ResolutionTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionTemplateRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ResolutionTemplate" ], "summary": "Update Resolution Templates", "description": "

Update Resolution Templates

Performs an partial update on multiple resolution templates identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-templates/search": { "post": { "tags": [ "ResolutionTemplate" ], "summary": "Search Resolution Templates", "description": "

Search Resolution Templates

Performs a search applying filtering, sorting, and pagination criteria within the resolution templates, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Resolution Templates → ResolutionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionTemplateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-templates/{id}": { "get": { "tags": [ "ResolutionTemplate" ], "summary": "Get Resolution Template", "description": "

Get Resolution Template

Provides detailed information for a single resolution template identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Resolution Templates → ResolutionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionTemplateRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ResolutionTemplate" ], "summary": "Update Resolution Template", "description": "

Update Resolution Template

Applies an partial update to an existing resolution template specified by its ID, affecting only resolution templates within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Resolution Templates → ResolutionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolutionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ResolutionTemplate" ], "summary": "Delete Resolution Template", "description": "

Delete Resolution Template

Deletes the specified resolution template, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-templates/{id}/options": { "post": { "tags": [ "ResolutionTemplate" ], "summary": "Add Option", "description": "

Add Option

Module: Conferences

Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionTemplateWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionTemplateWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResolutionOptionTemplateWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionTemplateRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionTemplateRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionTemplateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ResolutionTemplate" ], "summary": "Get Options", "description": "

Get Options

Module: Conferences

Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionTemplateRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionTemplateRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionOptionTemplateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-templates/{id}/order": { "post": { "tags": [ "ResolutionTemplate" ], "summary": "Order Resolution Templates", "description": "

Order Resolution Templates

Module: Conferences

Returns: Conferences → Resolution Templates → ResolutionTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionTemplateRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionTemplateRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionTemplateRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/services/ingestion-pipeline/full-sync": { "post": { "tags": [ "IngestionPipeline" ], "summary": "Trigger Full Sync", "description": "

Trigger Full Sync

Module: Services

Returns: Void

Authorization

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Void" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Void" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Void" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/signees": { "post": { "tags": [ "Signee" ], "summary": "Create Signee", "description": "

Create Signee

Creates a new signee from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Signees → SigneeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SigneeWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigneeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Signee" ], "summary": "List Signees", "description": "

List Signees

Returns a paginated list of signees filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Signees → SigneeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSigneeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/signees/batch": { "post": { "tags": [ "Signee" ], "summary": "Batch List Signees", "description": "

Batch List Signees

Retrieves signees matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Signees → SigneeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SigneeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Signee" ], "summary": "Update Signees", "description": "

Update Signees

Performs an partial update on multiple signees identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/signees/{id}": { "get": { "tags": [ "Signee" ], "summary": "Get Signee", "description": "

Get Signee

Provides detailed information for a single signee identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Signees → SigneeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigneeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Signee" ], "summary": "Update Signee", "description": "

Update Signee

Applies an partial update to an existing signee specified by its ID, affecting only signees within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Signees → SigneeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigneeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Signee" ], "summary": "Delete Signee", "description": "

Delete Signee

Deletes the specified signee, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-locks": { "get": { "tags": [ "SmartLock" ], "summary": "List Smart Locks", "description": "

List Smart Locks

Returns a paginated list of smart locks filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Smart Locks

Returns: Smart Locks → SmartLockRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSmartLockRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-locks/batch": { "post": { "tags": [ "SmartLock" ], "summary": "Batch List Smart Locks", "description": "

Batch List Smart Locks

Retrieves smart locks matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Smart Locks

Returns: Smart Locks → SmartLockRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartLockRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-locks/search": { "post": { "tags": [ "SmartLock" ], "summary": "Search Smart Locks", "description": "

Search Smart Locks

Performs a search applying filtering, sorting, and pagination criteria within the smart locks, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Smart Locks

Returns: Smart Locks → SmartLockRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SmartLockSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSmartLockRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-locks/{id}": { "get": { "tags": [ "SmartLock" ], "summary": "Get Smart Lock", "description": "

Get Smart Lock

Provides detailed information for a single smart lock identified by its ID, if it falls within the caller’s scope.

Module: Smart Locks

Returns: Smart Locks → SmartLockRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartLockRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-lock-activity-attempts": { "post": { "tags": [ "SmartLockActivityAttempt" ], "summary": "Create Smart Lock Activity Attempt", "description": "

Create Smart Lock Activity Attempt

Creates a new smart lock activity attempt from the provided data, associating it within the requester's scope.

Module: Smart Locks

Returns: Smart Locks → Activity Attempts → ActivityAttemptRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ActivityAttemptWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityAttemptRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "SmartLockActivityAttempt" ], "summary": "List Smart Lock Activity Attempts", "description": "

List Smart Lock Activity Attempts

Returns a paginated list of smart lock activity attempts filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Smart Locks

Returns: Smart Locks → Activity Attempts → ActivityAttemptRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfActivityAttemptRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-lock-activity-attempts/batch": { "post": { "tags": [ "SmartLockActivityAttempt" ], "summary": "Batch List Smart Lock Activity Attempts", "description": "

Batch List Smart Lock Activity Attempts

Retrieves smart lock activity attempts matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Smart Locks

Returns: Smart Locks → Activity Attempts → ActivityAttemptRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityAttemptRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "SmartLockActivityAttempt" ], "summary": "Update Smart Lock Activity Attempts", "description": "

Update Smart Lock Activity Attempts

Performs an partial update on multiple smart lock activity attempts identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Smart Locks

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-lock-activity-attempts/search": { "post": { "tags": [ "SmartLockActivityAttempt" ], "summary": "Search Smart Lock Activity Attempts", "description": "

Search Smart Lock Activity Attempts

Performs a search applying filtering, sorting, and pagination criteria within the smart lock activity attempts, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Smart Locks

Returns: Smart Locks → Activity Attempts → ActivityAttemptRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfActivityAttemptRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-lock-activity-attempts/{id}": { "get": { "tags": [ "SmartLockActivityAttempt" ], "summary": "Get Smart Lock Activity Attempt", "description": "

Get Smart Lock Activity Attempt

Provides detailed information for a single smart lock activity attempt identified by its ID, if it falls within the caller’s scope.

Module: Smart Locks

Returns: Smart Locks → Activity Attempts → ActivityAttemptRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityAttemptRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "SmartLockActivityAttempt" ], "summary": "Update Smart Lock Activity Attempt", "description": "

Update Smart Lock Activity Attempt

Applies an partial update to an existing smart lock activity attempt specified by its ID, affecting only smart lock activity attempts within the caller’s permitted scope.

Module: Smart Locks

Returns: Smart Locks → Activity Attempts → ActivityAttemptRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityAttemptRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "SmartLockActivityAttempt" ], "summary": "Delete Smart Lock Activity Attempt", "description": "

Delete Smart Lock Activity Attempt

Deletes the specified smart lock activity attempt, if it falls within the caller’s scope.

Module: Smart Locks

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-lock-types": { "get": { "tags": [ "SmartLockType" ], "summary": "List Smart Lock Types", "description": "

List Smart Lock Types

Returns a paginated list of smart lock types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Smart Locks

Returns: Smart Locks → Types → SmartLockTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSmartLockTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-lock-types/batch": { "post": { "tags": [ "SmartLockType" ], "summary": "Batch List Smart Lock Types", "description": "

Batch List Smart Lock Types

Retrieves smart lock types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Smart Locks

Returns: Smart Locks → Types → SmartLockTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartLockTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/smart-lock-types/{id}": { "get": { "tags": [ "SmartLockType" ], "summary": "Get Smart Lock Type", "description": "

Get Smart Lock Type

Provides detailed information for a single smart lock type identified by its ID, if it falls within the caller’s scope.

Module: Smart Locks

Returns: Smart Locks → Types → SmartLockTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartLockTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/sum-votes": { "get": { "tags": [ "SumVote" ], "summary": "List Sum Votes", "description": "

List Sum Votes

Returns a paginated list of sum votes filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Sum Votes → SumVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSumVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/sum-votes/batch": { "post": { "tags": [ "SumVote" ], "summary": "Batch List Sum Votes", "description": "

Batch List Sum Votes

Retrieves sum votes matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Sum Votes → SumVoteRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SumVoteRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/sum-votes/{id}": { "get": { "tags": [ "SumVote" ], "summary": "Get Sum Vote", "description": "

Get Sum Vote

Provides detailed information for a single sum vote identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Sum Votes → SumVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SumVoteRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants": { "post": { "tags": [ "Tenant" ], "summary": "Create Tenant", "description": "

Create Tenant

Creates a new tenant from the provided data, associating it within the requester's scope.

Module: Identity

Returns: Master Data → Properties → Tenants → TenantRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TenantWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Tenant" ], "summary": "List Tenants", "description": "

List Tenants

Returns a paginated list of tenants filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Identity

Returns: Master Data → Properties → Tenants → TenantRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/batch": { "post": { "tags": [ "Tenant" ], "summary": "Batch List Tenants", "description": "

Batch List Tenants

Retrieves tenants matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Identity

Returns: Master Data → Properties → Tenants → TenantRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Tenant" ], "summary": "Update Tenants", "description": "

Update Tenants

Performs an partial update on multiple tenants identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Identity

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/search": { "post": { "tags": [ "Tenant" ], "summary": "Search Tenants", "description": "

Search Tenants

Performs a search applying filtering, sorting, and pagination criteria within the tenants, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Identity

Returns: Master Data → Properties → Tenants → TenantRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TenantSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/{id}": { "get": { "tags": [ "Tenant" ], "summary": "Get Tenant", "description": "

Get Tenant

Provides detailed information for a single tenant identified by its ID, if it falls within the caller’s scope.

Module: Identity

Returns: Master Data → Properties → Tenants → TenantRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Tenant" ], "summary": "Update Tenant", "description": "

Update Tenant

Applies an partial update to an existing tenant specified by its ID, affecting only tenants within the caller’s permitted scope.

Module: Identity

Returns: Master Data → Properties → Tenants → TenantRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Tenant" ], "summary": "Delete Tenant", "description": "

Delete Tenant

Deletes the specified tenant, if it falls within the caller’s scope.

Module: Identity

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/{id}/account-accesses": { "get": { "tags": [ "Tenant" ], "summary": "List Accounts With Access", "description": "

List Accounts With Access

Module: Identity

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/{id}/party-accesses": { "post": { "tags": [ "Tenant" ], "summary": "Add Tenant Party Access", "description": "

Add Tenant Party Access

Module: Identity

Returns: Identity → Tenant Party Accesses → TenantPartyAccess (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (64)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TenantPartyAccessCreate" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TenantPartyAccessCreate" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TenantPartyAccessCreate" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Tenant" ], "summary": "Get Tenant Party Accesses", "description": "

Get Tenant Party Accesses

Module: Identity

Returns: Identity → Tenant Party Accesses → TenantPartyAccess (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/{id}/properties": { "get": { "tags": [ "Tenant" ], "summary": "List Properties", "description": "

List Properties

Module: Identity

Returns: Master Data → Properties → Properties → PropertyRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

Required Permissions: Permission (48)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfPropertyRead" }, "example": {"items":[{"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":4,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/{tenantId}/account-accesses/{accountId}": { "put": { "tags": [ "Tenant" ], "summary": "Add Account With Access", "description": "

Add Account With Access

Module: Identity

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (64)

This will be evaluated against your used access token.

", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Tenant" ], "summary": "Remove Account With Access", "description": "

Remove Account With Access

Module: Identity

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (64)

This will be evaluated against your used access token.

", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/{tenantId}/party-accesses/{partyId}": { "delete": { "tags": [ "Tenant" ], "summary": "Delete Tenant Party Access", "description": "

Delete Tenant Party Access

Module: Identity

Returns: Identity → Tenant Party Accesses → TenantPartyAccess (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (64)

This will be evaluated against your used access token.

", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "partyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTenantPartyAccess" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/tenants/{tenantId}/responsible-accounts/{responsibleId}": { "post": { "tags": [ "Tenant" ], "summary": "Add Account With Responsibility", "description": "

Add Account With Responsibility

Module: Identity

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (64)

This will be evaluated against your used access token.

", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "responsibleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Tenant" ], "summary": "Remove Account With Responsibility", "description": "

Remove Account With Responsibility

Module: Identity

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Permission (64)

This will be evaluated against your used access token.

", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "responsibleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/terms": { "get": { "tags": [ "Term" ], "summary": "Show", "description": "

Show

Returns the currently active terms pages. Should only be used to show to non-User parties. Parties with type User are usually seeing the terms provided by the respective customer app configuration of their property management company.

Module: Customer Apps

Returns: Customer App → Terms → TermRead (single)

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/topics": { "post": { "tags": [ "Topic" ], "summary": "Create Topic", "description": "

Create Topic

Creates a new topic from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Topics → TopicRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicRead" }, "examples": { "Sample Topic": { "value": {"number":1,"title":"Begrüßung und Protokoll","description":"Die Verwaltung begrüßt die Liegenschaft zur diesjährigen Versammlung und ernennt Herrn Müller als Protokollant.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Minimal Topic": { "value": {"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example": { "value": {"number":3,"title":"Amendment of the house rules for bicycle storage","description":"Ms Franke suggested renewing the parking spaces for the bicycles. We have obtained several offers from three different companies.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Topic" ], "summary": "List Topics", "description": "

List Topics

Returns a paginated list of topics filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Topics → TopicRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicRead" }, "example": {"items":[{"number":1,"title":"Begrüßung und Protokoll","description":"Die Verwaltung begrüßt die Liegenschaft zur diesjährigen Versammlung und ernennt Herrn Müller als Protokollant.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"title":"Amendment of the house rules for bicycle storage","description":"Ms Franke suggested renewing the parking spaces for the bicycles. We have obtained several offers from three different companies.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/batch": { "post": { "tags": [ "Topic" ], "summary": "Batch List Topics", "description": "

Batch List Topics

Retrieves topics matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Topics → TopicRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Topic" ], "summary": "Update Topics", "description": "

Update Topics

Performs an partial update on multiple topics identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/search": { "post": { "tags": [ "Topic" ], "summary": "Search Topics", "description": "

Search Topics

Performs a search applying filtering, sorting, and pagination criteria within the topics, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Topics → TopicRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicRead" }, "example": {"items":[{"number":1,"title":"Begrüßung und Protokoll","description":"Die Verwaltung begrüßt die Liegenschaft zur diesjährigen Versammlung und ernennt Herrn Müller als Protokollant.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"title":"Amendment of the house rules for bicycle storage","description":"Ms Franke suggested renewing the parking spaces for the bicycles. We have obtained several offers from three different companies.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/{id}": { "get": { "tags": [ "Topic" ], "summary": "Get Topic", "description": "

Get Topic

Provides detailed information for a single topic identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Topics → TopicRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicRead" }, "examples": { "Sample Topic": { "value": {"number":1,"title":"Begrüßung und Protokoll","description":"Die Verwaltung begrüßt die Liegenschaft zur diesjährigen Versammlung und ernennt Herrn Müller als Protokollant.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Minimal Topic": { "value": {"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example": { "value": {"number":3,"title":"Amendment of the house rules for bicycle storage","description":"Ms Franke suggested renewing the parking spaces for the bicycles. We have obtained several offers from three different companies.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Topic" ], "summary": "Update Topic", "description": "

Update Topic

Applies an partial update to an existing topic specified by its ID, affecting only topics within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Topics → TopicRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicRead" }, "examples": { "Sample Topic": { "value": {"number":1,"title":"Begrüßung und Protokoll","description":"Die Verwaltung begrüßt die Liegenschaft zur diesjährigen Versammlung und ernennt Herrn Müller als Protokollant.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Minimal Topic": { "value": {"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example": { "value": {"number":3,"title":"Amendment of the house rules for bicycle storage","description":"Ms Franke suggested renewing the parking spaces for the bicycles. We have obtained several offers from three different companies.","externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Topic" ], "summary": "Delete Topic", "description": "

Delete Topic

Deletes the specified topic, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/{id}/attachments": { "get": { "tags": [ "Topic" ], "summary": "Get Attachments", "description": "

Get Attachments

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/{id}/attachment-settings": { "get": { "tags": [ "Topic" ], "summary": "Get Attachment Relations", "description": "

Get Attachment Relations

Module: Conferences

Returns: Conferences → Topic Attachments → TopicAttachmentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicAttachmentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicAttachmentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicAttachmentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/{id}/notes": { "post": { "tags": [ "Topic" ], "summary": "Create Note", "description": "

Create Note

Module: Conferences

Returns: Conferences → Topic Notes → TopicNoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicNoteWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicNoteWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicNoteWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicNoteRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicNoteRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicNoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Topic" ], "summary": "Get Notes", "description": "

Get Notes

Module: Conferences

Returns: Conferences → Topic Notes → TopicNoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicNoteRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicNoteRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicNoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/{id}/resolutions": { "get": { "tags": [ "Topic" ], "summary": "Get Conference Resolutions", "description": "

Get Conference Resolutions

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionRead" }, "example": {"items":[{"number":1,"collectionNumber":null,"title":"Freigabe Jahresabrechnung 2026","description":"Der Beirat hat die Abrechnungen am 07/26/2026 12:14:03 geprüft und freigegeben.","location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Jahresabrechnung für das Jahr 2026","requiredPercentage":51,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":1,"votingMajorityId":1,"addToCollection":true,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"number":2,"collectionNumber":null,"title":"Änderung der Hausordnung (Fahrradstellplätze)","description":"Nach Anmerkung durch Frau Müller stehen zur Auswahl die Angebote der Firmen Stuke GmbH, Stöhl & Söhne und Heimling Malerarbeiten.","location":null,"date":null,"resolutionText":null,"requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":2,"wasManuallyEdited":false,"hasSimpleVoting":false,"hasOptionsVoting":true,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"number":3,"collectionNumber":null,"title":"Beauftragung Stuke Architekten","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Beauftragung der Firma Stuke Architekten zur Installation der Fahrradstellplätze i. H. v. 24,594€ auf Basis des Angebots 3245/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":1,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"number":4,"collectionNumber":null,"title":"Work Order for Stöhl & Söhne regarding Bicycle Parking Space Installation","description":null,"location":null,"date":null,"resolutionText":"The property decides to commission the company Stuke Architekten to install the bicycle parking spaces in the amount of € 23,687 based on the offer 45646/2022.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":3,"propertyId":null,"dependantOptionId":2,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"number":5,"collectionNumber":null,"title":"Freigabe Wirtschaftspläne","description":null,"location":null,"date":null,"resolutionText":"Die Liegenschaft beschließt die Freigabe der Wirtschaftspläne für das Jahr 2026.","requiredPercentage":null,"resolutionStatus":0,"note":null,"topicId":2,"propertyId":null,"dependantOptionId":null,"votingProcedureId":0,"votingMajorityId":0,"addToCollection":false,"externalId":null,"type":0,"wasManuallyEdited":false,"hasSimpleVoting":true,"hasOptionsVoting":false,"isDependant":false,"processId":null,"hasBeenSkipped":false,"selectedOptionId":null,"votedOptionId":null,"decision":null,"defaultToSumVote":null,"created":"2026-09-14T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":10,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/{topicId}/attachments/{fileId}": { "get": { "tags": [ "Topic" ], "summary": "Get Attachment", "description": "

Get Attachment

Module: Conferences

Returns: Conferences → Topic Attachments → TopicAttachmentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "topicId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicAttachmentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicAttachmentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicAttachmentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Topic" ], "summary": "Update Attachment", "description": "

Update Attachment

Module: Conferences

Returns: Conferences → Topic Attachments → TopicAttachmentRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "topicId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicAttachmentWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicAttachmentWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicAttachmentWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TopicAttachmentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TopicAttachmentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TopicAttachmentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Topic" ], "summary": "Attach File", "description": "

Attach File

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "topicId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Topic" ], "summary": "Detach File", "description": "

Detach File

Module: Conferences

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "topicId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topics/{topicId}/resolutions/{resolutionId}/order": { "post": { "tags": [ "Topic" ], "summary": "Order Topics", "description": "

Order Topics

Module: Conferences

Returns: Conferences → Resolutions → ResolutionRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "topicId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "resolutionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-notes": { "post": { "tags": [ "TopicNote" ], "summary": "Create Topic Note", "description": "

Create Topic Note

Creates a new topic note from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Topic Notes → TopicNoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicNoteWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicNoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "TopicNote" ], "summary": "List Topic Notes", "description": "

List Topic Notes

Returns a paginated list of topic notes filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Topic Notes → TopicNoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicNoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-notes/batch": { "post": { "tags": [ "TopicNote" ], "summary": "Batch List Topic Notes", "description": "

Batch List Topic Notes

Retrieves topic notes matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Topic Notes → TopicNoteRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicNoteRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "TopicNote" ], "summary": "Update Topic Notes", "description": "

Update Topic Notes

Performs an partial update on multiple topic notes identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-notes/search": { "post": { "tags": [ "TopicNote" ], "summary": "Search Topic Notes", "description": "

Search Topic Notes

Performs a search applying filtering, sorting, and pagination criteria within the topic notes, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Topic Notes → TopicNoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicNoteSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicNoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-notes/{id}": { "get": { "tags": [ "TopicNote" ], "summary": "Get Topic Note", "description": "

Get Topic Note

Provides detailed information for a single topic note identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Topic Notes → TopicNoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicNoteRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "TopicNote" ], "summary": "Update Topic Note", "description": "

Update Topic Note

Applies an partial update to an existing topic note specified by its ID, affecting only topic notes within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Topic Notes → TopicNoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicNoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "TopicNote" ], "summary": "Delete Topic Note", "description": "

Delete Topic Note

Deletes the specified topic note, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-templates": { "post": { "tags": [ "TopicTemplate" ], "summary": "Create Topic Template", "description": "

Create Topic Template

Creates a new topic template from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Topic Templates → TopicTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicTemplateWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "TopicTemplate" ], "summary": "List Topic Templates", "description": "

List Topic Templates

Returns a paginated list of topic templates filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Topic Templates → TopicTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-templates/batch": { "post": { "tags": [ "TopicTemplate" ], "summary": "Batch List Topic Templates", "description": "

Batch List Topic Templates

Retrieves topic templates matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Topic Templates → TopicTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "TopicTemplate" ], "summary": "Update Topic Templates", "description": "

Update Topic Templates

Performs an partial update on multiple topic templates identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-templates/search": { "post": { "tags": [ "TopicTemplate" ], "summary": "Search Topic Templates", "description": "

Search Topic Templates

Performs a search applying filtering, sorting, and pagination criteria within the topic templates, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Topic Templates → TopicTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicTemplateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-templates/{id}": { "get": { "tags": [ "TopicTemplate" ], "summary": "Get Topic Template", "description": "

Get Topic Template

Provides detailed information for a single topic template identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Topic Templates → TopicTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicTemplateRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "TopicTemplate" ], "summary": "Update Topic Template", "description": "

Update Topic Template

Applies an partial update to an existing topic template specified by its ID, affecting only topic templates within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Topic Templates → TopicTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "TopicTemplate" ], "summary": "Delete Topic Template", "description": "

Delete Topic Template

Deletes the specified topic template, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-templates/{id}/order": { "post": { "tags": [ "TopicTemplate" ], "summary": "Order Topic Templates", "description": "

Order Topic Templates

Module: Conferences

Returns: Conferences → Topic Templates → TopicTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-templates/{id}/resolution-templates": { "get": { "tags": [ "TopicTemplate" ], "summary": "Get Resolution Templates", "description": "

Get Resolution Templates

Module: Conferences

Returns: Conferences → Resolution Templates → ResolutionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionTemplateRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionTemplateRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfResolutionTemplateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-templates/{id}/topic-template-resolution-templates": { "get": { "tags": [ "TopicTemplate" ], "summary": "Get Topic Template Resolution Templates", "description": "

Get Topic Template Resolution Templates

Module: Conferences

Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicTemplateResolutionTemplateRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicTemplateResolutionTemplateRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicTemplateResolutionTemplateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-template-resolution-templates": { "post": { "tags": [ "TopicTemplateResolutionTemplates" ], "summary": "Create Topic Template Resolution Template", "description": "

Create Topic Template Resolution Template

Creates a new topic template resolution template from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "TopicTemplateResolutionTemplates" ], "summary": "List Topic Template Resolution Templateses", "description": "

List Topic Template Resolution Templateses

Returns a paginated list of topic template resolution templateses filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTopicTemplateResolutionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-template-resolution-templates/batch": { "post": { "tags": [ "TopicTemplateResolutionTemplates" ], "summary": "Batch List Topic Template Resolution Templateses", "description": "

Batch List Topic Template Resolution Templateses

Retrieves topic template resolution templateses matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "TopicTemplateResolutionTemplates" ], "summary": "Update Topic Template Resolution Templateses", "description": "

Update Topic Template Resolution Templateses

Performs an partial update on multiple topic template resolution templateses identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-template-resolution-templates/{id}": { "get": { "tags": [ "TopicTemplateResolutionTemplates" ], "summary": "Get Topic Template Resolution Template", "description": "

Get Topic Template Resolution Template

Provides detailed information for a single topic template resolution template identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "TopicTemplateResolutionTemplates" ], "summary": "Update Topic Template Resolution Template", "description": "

Update Topic Template Resolution Template

Applies an partial update to an existing topic template resolution template specified by its ID, affecting only topic template resolution templateses within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "TopicTemplateResolutionTemplates" ], "summary": "Delete Topic Template Resolution Template", "description": "

Delete Topic Template Resolution Template

Deletes the specified topic template resolution template, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/topic-template-resolution-templates/{id}/order": { "post": { "tags": [ "TopicTemplateResolutionTemplates" ], "summary": "Order Topic Template Resolution Templates", "description": "

Order Topic Template Resolution Templates

Module: Conferences

Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OrderRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateRead" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateRead" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateRead" } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/trades": { "post": { "tags": [ "Trade" ], "summary": "Create Trade", "description": "

Create Trade

Creates a new trade from the provided data, associating it within the requester's scope.

Module: Trades

Returns: Master Data → Parties → Trades → TradeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TradeWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TradeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Trade" ], "summary": "List Trades", "description": "

List Trades

Returns a paginated list of trades filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Trades

Returns: Master Data → Parties → Trades → TradeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/trades/batch": { "post": { "tags": [ "Trade" ], "summary": "Batch List Trades", "description": "

Batch List Trades

Retrieves trades matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Trades

Returns: Master Data → Parties → Trades → TradeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TradeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Trade" ], "summary": "Update Trades", "description": "

Update Trades

Performs an partial update on multiple trades identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Trades

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/trades/search": { "post": { "tags": [ "Trade" ], "summary": "Search Trades", "description": "

Search Trades

Performs a search applying filtering, sorting, and pagination criteria within the trades, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Trades

Returns: Master Data → Parties → Trades → TradeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TradeSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfTradeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/trades/{id}": { "get": { "tags": [ "Trade" ], "summary": "Get Trade", "description": "

Get Trade

Provides detailed information for a single trade identified by its ID, if it falls within the caller’s scope.

Module: Trades

Returns: Master Data → Parties → Trades → TradeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TradeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Trade" ], "summary": "Update Trade", "description": "

Update Trade

Applies an partial update to an existing trade specified by its ID, affecting only trades within the caller’s permitted scope.

Module: Trades

Returns: Master Data → Parties → Trades → TradeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TradeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Trade" ], "summary": "Delete Trade", "description": "

Delete Trade

Deletes the specified trade, if it falls within the caller’s scope.

Module: Trades

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units": { "post": { "tags": [ "Unit" ], "summary": "Create Unit", "description": "

Create Unit

Creates a new unit from the provided data, associating it within the requester's scope.

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnitWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Unit" ], "summary": "List Units", "description": "

List Units

Returns a paginated list of units filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/batch": { "post": { "tags": [ "Unit" ], "summary": "Batch List Units", "description": "

Batch List Units

Retrieves units matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Unit" ], "summary": "Update Units", "description": "

Update Units

Performs an partial update on multiple units identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Properties

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/search": { "post": { "tags": [ "Unit" ], "summary": "Search Units", "description": "

Search Units

Performs a search applying filtering, sorting, and pagination criteria within the units, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnitSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitRead" }, "example": {"items":[{"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1},{"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2},{"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3},{"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4},{"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5}],"pageNumber":1,"pageSize":10,"totalPages":1,"totalCount":5,"hasPreviousPage":false,"hasNextPage":false} } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}": { "get": { "tags": [ "Unit" ], "summary": "Get Unit", "description": "

Get Unit

Provides detailed information for a single unit identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "Unit" ], "summary": "Update Unit", "description": "

Update Unit

Applies an partial update to an existing unit specified by its ID, affecting only units within the caller’s permitted scope.

Module: Properties

Returns: Master Data → Properties → Units → UnitRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitRead" }, "examples": { "Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"001","position":"EG Links","entranceId":1,"hidden":true,"squareMeters":60,"roomCount":3,"rentReduction":30,"description":"rent reduction set on 2022-11-01","externalId":"950074a9-3b20-4477-919b-874a0c82a984","externalIdOld":"123-33-33","isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Another Regular Unit of Entrance": { "value": {"typeId":1,"holdingTypeId":2,"number":"002","position":"1. OG, Rechts","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"bd90ea37-85ba-4033-b648-edeeb2a781d5","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "English Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":"003","position":"Second Floor, Right Side","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":"fd59b366-8552-439f-a6bd-fc229d9ad843","externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Minimal Example of a Unit": { "value": {"typeId":1,"holdingTypeId":2,"number":null,"position":null,"entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} }, "Surrogate Unit for Roles (see Documentation)": { "value": {"typeId":1,"holdingTypeId":2,"number":"000","position":"Allgemein","entranceId":1,"hidden":null,"squareMeters":null,"roomCount":null,"rentReduction":null,"description":null,"externalId":null,"externalIdOld":null,"isArchived":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":5} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Unit" ], "summary": "Delete Unit", "description": "

Delete Unit

Deletes the specified unit, if it falls within the caller’s scope.

Module: Properties

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/attribute-groups": { "post": { "tags": [ "Unit" ], "summary": "Add Attribute Group", "description": "

Add Attribute Group

Module: Properties

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeGroupWrite" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeGroupWrite" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttributeGroupWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "Unit" ], "summary": "List Attribute Groups", "description": "

List Attribute Groups

Module: Properties

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/attribute-groups/{attributeGroupId}": { "delete": { "tags": [ "Unit" ], "summary": "Remove Attribute Group", "description": "

Remove Attribute Group

Module: Properties

Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attributeGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAttributeGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/attribute-values": { "get": { "tags": [ "Unit" ], "summary": "List Attribute Values", "description": "

List Attribute Values

Module: Properties

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/contracts": { "get": { "tags": [ "Unit" ], "summary": "List Contracts", "description": "

List Contracts

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/document-groups": { "get": { "tags": [ "Unit" ], "summary": "List Document Groups", "description": "

List Document Groups

Module: Properties

Returns: Documents → Document Groups → DocumentGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (32)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/entrance": { "get": { "tags": [ "Unit" ], "summary": "Show Entrance", "description": "

Show Entrance

Module: Properties

Returns: Master Data → Properties → Entrances → EntranceRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntranceRead" }, "examples": { "Nedlitzer Str., First Entrance": { "value": {"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Nedlitzer Str., Second Entrance": { "value": {"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Nedlitzer Str., Minimal Entrance": { "value": {"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Nedlitzer Str., Fourth Entrance": { "value": {"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntranceRead" }, "examples": { "Nedlitzer Str., First Entrance": { "value": {"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Nedlitzer Str., Second Entrance": { "value": {"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Nedlitzer Str., Minimal Entrance": { "value": {"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Nedlitzer Str., Fourth Entrance": { "value": {"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntranceRead" }, "examples": { "Nedlitzer Str., First Entrance": { "value": {"number":"WEG 047 - 71","name":"Nedlitzer Str. 71","propertyId":4,"fullStreet":"Nedlitzer Str. 71","zipCode":"14469","city":"Potsdam","description":"Marcs old home","isProperty":false,"externalId":"-8","isArchived":false,"latitude":52.425791724932374,"longitude":13.054429787721375,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Nedlitzer Str., Second Entrance": { "value": {"number":"WEG 047 - 73","name":"Nedlitzer Str. 73","propertyId":4,"fullStreet":"Nedlitzer Str. 73","zipCode":"14469","city":"Potsdam","description":"Bernds old home","isProperty":false,"externalId":"-9","isArchived":false,"latitude":52.42602357359753,"longitude":13.05443324187974,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Nedlitzer Str., Minimal Entrance": { "value": {"number":null,"name":null,"propertyId":4,"fullStreet":null,"zipCode":null,"city":null,"description":null,"isProperty":false,"externalId":null,"isArchived":false,"latitude":null,"longitude":null,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Nedlitzer Str., Fourth Entrance": { "value": {"number":"WEG 047 - 77","name":"Nedlitzer Str. 77","propertyId":4,"fullStreet":"Nedlitzer Str. 77","zipCode":"14469","city":"Potsdam","description":"Maxs old home","isProperty":true,"externalId":"-9","isArchived":false,"latitude":52.4262952174526,"longitude":13.054460599550502,"unitsCount":0,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/holding-type": { "get": { "tags": [ "Unit" ], "summary": "Show Holding Type", "description": "

Show Holding Type

Module: Properties

Returns: Master Data → Properties → Unit Contracts → Holding Types → UnitHoldingTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UnitHoldingTypeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnitHoldingTypeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnitHoldingTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/processes": { "get": { "tags": [ "Unit" ], "summary": "List Processes", "description": "

List Processes

Module: Properties

Returns: Processes → Processes → ProcessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

Required Permissions: Permission (45)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/property": { "get": { "tags": [ "Unit" ], "summary": "Show Property", "description": "

Show Property

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } }, "text/json": { "schema": { "$ref": "#/components/schemas/PropertyRead" }, "examples": { "Headquarters of facilioo": { "value": {"tenantId":1,"number":"WEG 1","name":"Ku'damm 92","fullStreet":"Kurfürstendamm 92","zipCode":"10709","city":"Berlin","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"420","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":1} }, "Headquarters for freiheit.software": { "value": {"tenantId":1,"number":"WEG 4","name":"Jägerstr. 39","fullStreet":"Jägerstraße 39","zipCode":"14467","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"4","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":2} }, "Minimal Example without Optional Fields": { "value": {"tenantId":2,"number":null,"name":null,"fullStreet":null,"zipCode":null,"city":null,"resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":null,"externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":3} }, "Property with Entrances": { "value": {"tenantId":1,"number":"WEG 047","name":"Nedlizter Str. 71-77","fullStreet":"Nedlitzer Str. 71-77","zipCode":"14469","city":"Potsdam","resolutionCollectionStartOffset":0,"imageId":null,"isArchived":false,"externalId":"-15","externalOldId":null,"latitude":null,"longitude":null,"key":null,"unitsCount":0,"parentId":0,"description":null,"eligibleUnitsSelected":false,"created":"2026-09-13T12:14:03Z","lastModified":null,"deleted":null,"id":4} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/shares": { "get": { "tags": [ "Unit" ], "summary": "Show Shares", "description": "

Show Shares

Module: Properties

Returns: Attributes → Responses → SharesResponse (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SharesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SharesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SharesResponse" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/shares-attribute-values": { "get": { "tags": [ "Unit" ], "summary": "List Shares Attribute Values", "description": "

List Shares Attribute Values

Module: Properties

Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfNestedAttributeValueRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/tenant": { "get": { "tags": [ "Unit" ], "summary": "Show Tenant", "description": "

Show Tenant

Module: Properties

Returns: Master Data → Properties → Tenants → TenantRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/type": { "get": { "tags": [ "Unit" ], "summary": "Show Type", "description": "

Show Type

Module: Properties

Returns: Master Data → Properties → Units → Types → UnitTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UnitTypeRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnitTypeRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnitTypeRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{unitId}/document-groups/{documentGroupId}/documents": { "get": { "tags": [ "Unit" ], "summary": "List Documents Of Group", "description": "

List Documents Of Group

Module: Properties

Returns: Documents → Documents → DocumentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Permission (32)

This will be evaluated against your used access token.

", "parameters": [ { "name": "unitId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "documentGroupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfDocumentRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-contracts": { "post": { "tags": [ "UnitContract" ], "summary": "Create Unit Contract", "description": "

Create Unit Contract

Creates a new unit contract from the provided data, associating it within the requester's scope.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnitContractWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitContractRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "UnitContract" ], "summary": "List Unit Contracts", "description": "

List Unit Contracts

Returns a paginated list of unit contracts filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-contracts/batch": { "post": { "tags": [ "UnitContract" ], "summary": "Batch List Unit Contracts", "description": "

Batch List Unit Contracts

Retrieves unit contracts matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitContractRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "UnitContract" ], "summary": "Update Unit Contracts", "description": "

Update Unit Contracts

Performs an partial update on multiple unit contracts identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Properties

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-contracts/search": { "post": { "tags": [ "UnitContract" ], "summary": "Search Unit Contracts", "description": "

Search Unit Contracts

Performs a search applying filtering, sorting, and pagination criteria within the unit contracts, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnitContractSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-contracts/{id}": { "get": { "tags": [ "UnitContract" ], "summary": "Get Unit Contract", "description": "

Get Unit Contract

Provides detailed information for a single unit contract identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitContractRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "UnitContract" ], "summary": "Update Unit Contract", "description": "

Update Unit Contract

Applies an partial update to an existing unit contract specified by its ID, affecting only unit contracts within the caller’s permitted scope.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitContractRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "UnitContract" ], "summary": "Delete Unit Contract", "description": "

Delete Unit Contract

Deletes the specified unit contract, if it falls within the caller’s scope.

Module: Properties

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-contracts/{id}/party": { "get": { "tags": [ "UnitContract" ], "summary": "List Contractors", "description": "

List Contractors

Module: Properties

Returns: Identity → Parties → PartyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PartyRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-contract-types": { "get": { "tags": [ "UnitContractType" ], "summary": "List Unit Contract Types", "description": "

List Unit Contract Types

Returns a paginated list of unit contract types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → Types → UnitContractTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitContractTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-contract-types/batch": { "post": { "tags": [ "UnitContractType" ], "summary": "Batch List Unit Contract Types", "description": "

Batch List Unit Contract Types

Retrieves unit contract types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → Types → UnitContractTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitContractTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-contract-types/{id}": { "get": { "tags": [ "UnitContractType" ], "summary": "Get Unit Contract Type", "description": "

Get Unit Contract Type

Provides detailed information for a single unit contract type identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Unit Contracts → Types → UnitContractTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitContractTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-types": { "get": { "tags": [ "UnitType" ], "summary": "List Unit Types", "description": "

List Unit Types

Returns a paginated list of unit types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Properties

Returns: Master Data → Properties → Units → Types → UnitTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUnitTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-types/batch": { "post": { "tags": [ "UnitType" ], "summary": "Batch List Unit Types", "description": "

Batch List Unit Types

Retrieves unit types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Properties

Returns: Master Data → Properties → Units → Types → UnitTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/unit-types/{id}": { "get": { "tags": [ "UnitType" ], "summary": "Get Unit Type", "description": "

Get Unit Type

Provides detailed information for a single unit type identified by its ID, if it falls within the caller’s scope.

Module: Properties

Returns: Master Data → Properties → Units → Types → UnitTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks": { "post": { "tags": [ "UserTask" ], "summary": "Create User Task", "description": "

Create User Task

Creates a new user task from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserTaskWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "UserTask" ], "summary": "List User Tasks", "description": "

List User Tasks

Returns a paginated list of user tasks filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/batch": { "post": { "tags": [ "UserTask" ], "summary": "Batch List User Tasks", "description": "

Batch List User Tasks

Retrieves user tasks matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "UserTask" ], "summary": "Update User Tasks", "description": "

Update User Tasks

Performs an partial update on multiple user tasks identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/search": { "post": { "tags": [ "UserTask" ], "summary": "Search User Tasks", "description": "

Search User Tasks

Performs a search applying filtering, sorting, and pagination criteria within the user tasks, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserTaskSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/{id}": { "get": { "tags": [ "UserTask" ], "summary": "Get User Task", "description": "

Get User Task

Provides detailed information for a single user task identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "UserTask" ], "summary": "Update User Task", "description": "

Update User Task

Applies an partial update to an existing user task specified by its ID, affecting only user tasks within the caller’s permitted scope.

Module: Processes

Returns: Processes → User Tasks → UserTaskRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "UserTask" ], "summary": "Delete User Task", "description": "

Delete User Task

Deletes the specified user task, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/{id}/assignees": { "get": { "tags": [ "UserTask" ], "summary": "List Assignees", "description": "

List Assignees

Module: Processes

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/{id}/attachments": { "get": { "tags": [ "UserTask" ], "summary": "List Attachments", "description": "

List Attachments

Module: Processes

Returns: Documents → Files → FileRead (paginated)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfFileRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/{id}/feed": { "get": { "tags": [ "UserTask" ], "summary": "List Feed", "description": "

List Feed

Module: Processes

Returns: Processes → User Tasks → Feed Entries → UserTaskFeedEntryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskFeedEntryRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskFeedEntryRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskFeedEntryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/{id}/notifications": { "get": { "tags": [ "UserTask" ], "summary": "List Notifications", "description": "

List Notifications

Module: Processes

Returns: Processes → User Tasks → Notifications → UserTaskNotificationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskNotificationRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskNotificationRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskNotificationRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/{id}/processes": { "get": { "tags": [ "UserTask" ], "summary": "List User Task Processes", "description": "

List User Task Processes

Returns the entities related to the specified resource.

Module: Processes

Returns: Processes → Processes → ProcessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/{userTaskId}/assignees/{accountId}": { "put": { "tags": [ "UserTask" ], "summary": "Add Assignee", "description": "

Add Assignee

Module: Processes

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "userTaskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "UserTask" ], "summary": "Remove Assignee", "description": "

Remove Assignee

Module: Processes

Returns: Identity → Accounts → AccountRead (paginated)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "userTaskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfAccountRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-tasks/{userTaskId}/processes/{processId}": { "put": { "tags": [ "UserTask" ], "summary": "Add Process To User Task", "description": "

Add Process To User Task

Creates or updates the relation between the specified resource and an related entity. This operation modifies only the association, not the underlying entities’ data.

Module: Processes

Returns: Processes → Processes → ProcessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "userTaskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "processId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "UserTask" ], "summary": "Remove Process From User Task", "description": "

Remove Process From User Task

Removes the relation between the specified resource and an the related entity. This operation deletes only the association, leaving the underlying, referenced entity untouched.

Module: Processes

Returns: Processes → Processes → ProcessRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "userTaskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "processId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfProcessRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-collections": { "post": { "tags": [ "UserTaskCollection" ], "summary": "Create User Task Collection", "description": "

Create User Task Collection

Creates a new user task collection from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → User Tasks → Collections → UserTaskCollectionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserTaskCollectionWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskCollectionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "UserTaskCollection" ], "summary": "List User Task Collections", "description": "

List User Task Collections

Returns a paginated list of user task collections filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → User Tasks → Collections → UserTaskCollectionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskCollectionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-collections/batch": { "post": { "tags": [ "UserTaskCollection" ], "summary": "Batch List User Task Collections", "description": "

Batch List User Task Collections

Retrieves user task collections matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → User Tasks → Collections → UserTaskCollectionRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskCollectionRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "UserTaskCollection" ], "summary": "Update User Task Collections", "description": "

Update User Task Collections

Performs an partial update on multiple user task collections identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-collections/{id}": { "get": { "tags": [ "UserTaskCollection" ], "summary": "Get User Task Collection", "description": "

Get User Task Collection

Provides detailed information for a single user task collection identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → User Tasks → Collections → UserTaskCollectionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskCollectionRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "UserTaskCollection" ], "summary": "Update User Task Collection", "description": "

Update User Task Collection

Applies an partial update to an existing user task collection specified by its ID, affecting only user task collections within the caller’s permitted scope.

Module: Processes

Returns: Processes → User Tasks → Collections → UserTaskCollectionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskCollectionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "UserTaskCollection" ], "summary": "Delete User Task Collection", "description": "

Delete User Task Collection

Deletes the specified user task collection, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-notifications": { "post": { "tags": [ "UserTaskNotification" ], "summary": "Create User Task Notification", "description": "

Create User Task Notification

Creates a new user task notification from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → User Tasks → Notifications → UserTaskNotificationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UserTaskNotificationWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskNotificationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "UserTaskNotification" ], "summary": "List User Task Notifications", "description": "

List User Task Notifications

Returns a paginated list of user task notifications filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → User Tasks → Notifications → UserTaskNotificationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskNotificationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-notifications/batch": { "post": { "tags": [ "UserTaskNotification" ], "summary": "Batch List User Task Notifications", "description": "

Batch List User Task Notifications

Retrieves user task notifications matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → User Tasks → Notifications → UserTaskNotificationRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskNotificationRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "UserTaskNotification" ], "summary": "Update User Task Notifications", "description": "

Update User Task Notifications

Performs an partial update on multiple user task notifications identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-notifications/{id}": { "get": { "tags": [ "UserTaskNotification" ], "summary": "Get User Task Notification", "description": "

Get User Task Notification

Provides detailed information for a single user task notification identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → User Tasks → Notifications → UserTaskNotificationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskNotificationRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "UserTaskNotification" ], "summary": "Update User Task Notification", "description": "

Update User Task Notification

Applies an partial update to an existing user task notification specified by its ID, affecting only user task notifications within the caller’s permitted scope.

Module: Processes

Returns: Processes → User Tasks → Notifications → UserTaskNotificationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskNotificationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "UserTaskNotification" ], "summary": "Delete User Task Notification", "description": "

Delete User Task Notification

Deletes the specified user task notification, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-priorities": { "get": { "tags": [ "UserTaskPriority" ], "summary": "List User Task Priorities", "description": "

List User Task Priorities

Returns a paginated list of user task priorities filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → User Tasks → Priorities → UserTaskPriorityRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfUserTaskPriorityRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-priorities/batch": { "post": { "tags": [ "UserTaskPriority" ], "summary": "Batch List User Task Priorities", "description": "

Batch List User Task Priorities

Retrieves user task priorities matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → User Tasks → Priorities → UserTaskPriorityRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskPriorityRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/user-task-priorities/{id}": { "get": { "tags": [ "UserTaskPriority" ], "summary": "Get User Task Priority", "description": "

Get User Task Priority

Provides detailed information for a single user task priority identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → User Tasks → Priorities → UserTaskPriorityRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTaskPriorityRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/view-settings": { "post": { "tags": [ "ViewSetting" ], "summary": "Create View Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Create View Setting

Creates a new view setting from the provided data, associating it within the requester's scope.

Module: View Settings

Returns: View Settings → ViewSettingRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ViewSettingWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSettingRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "ViewSetting" ], "summary": "List View Settings", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

List View Settings

Returns a paginated list of view settings filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: View Settings

Returns: View Settings → ViewSettingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfViewSettingRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/view-settings/batch": { "post": { "tags": [ "ViewSetting" ], "summary": "Batch List View Settings", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Batch List View Settings

Retrieves view settings matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: View Settings

Returns: View Settings → ViewSettingRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ViewSettingRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ViewSetting" ], "summary": "Update View Settings", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Update View Settings

Performs an partial update on multiple view settings identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: View Settings

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/view-settings/search": { "post": { "tags": [ "ViewSetting" ], "summary": "Search View Settings", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Search View Settings

Performs a search applying filtering, sorting, and pagination criteria within the view settings, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: View Settings

Returns: View Settings → ViewSettingRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ViewSettingSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfViewSettingRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/view-settings/{id}": { "get": { "tags": [ "ViewSetting" ], "summary": "Get View Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Get View Setting

Provides detailed information for a single view setting identified by its ID, if it falls within the caller’s scope.

Module: View Settings

Returns: View Settings → ViewSettingRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSettingRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "ViewSetting" ], "summary": "Update View Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Update View Setting

Applies an partial update to an existing view setting specified by its ID, affecting only view settings within the caller’s permitted scope.

Module: View Settings

Returns: View Settings → ViewSettingRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSettingRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "ViewSetting" ], "summary": "Delete View Setting", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Delete View Setting

Deletes the specified view setting, if it falls within the caller’s scope.

Module: View Settings

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/view-setting-groups": { "get": { "tags": [ "ViewSettingGroup" ], "summary": "List View Setting Groups", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

List View Setting Groups

Returns a paginated list of view setting groups filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: View Settings

Returns: View Settings → ViewSettingGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfViewSettingGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/view-setting-groups/batch": { "post": { "tags": [ "ViewSettingGroup" ], "summary": "Batch List View Setting Groups", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Batch List View Setting Groups

Retrieves view setting groups matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: View Settings

Returns: View Settings → ViewSettingGroupRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ViewSettingGroupRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/view-setting-groups/search": { "post": { "tags": [ "ViewSettingGroup" ], "summary": "Search View Setting Groups", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Search View Setting Groups

Performs a search applying filtering, sorting, and pagination criteria within the view setting groups, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: View Settings

Returns: View Settings → ViewSettingGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ViewSettingGroupSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfViewSettingGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/view-setting-groups/{id}": { "get": { "tags": [ "ViewSettingGroup" ], "summary": "Get View Setting Group", "description": "

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Get View Setting Group

Provides detailed information for a single view setting group identified by its ID, if it falls within the caller’s scope.

Module: View Settings

Returns: View Settings → ViewSettingGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewSettingGroupRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-end-reasons": { "get": { "tags": [ "VotingEndReason" ], "summary": "Get Voting End Reasons", "description": "

Get Voting End Reasons

Module: Conferences

Returns: Conferences → Voting → End Reasons → VotingEndReasonRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingEndReasonRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingEndReasonRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingEndReasonRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-groups": { "post": { "tags": [ "VotingGroup" ], "summary": "Create Voting Group", "description": "

Create Voting Group

Creates a new voting group from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "VotingGroup" ], "summary": "List Voting Groups", "description": "

List Voting Groups

Returns a paginated list of voting groups filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-groups/batch": { "post": { "tags": [ "VotingGroup" ], "summary": "Batch List Voting Groups", "description": "

Batch List Voting Groups

Retrieves voting groups matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VotingGroupRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "VotingGroup" ], "summary": "Update Voting Groups", "description": "

Update Voting Groups

Performs an partial update on multiple voting groups identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-groups/search": { "post": { "tags": [ "VotingGroup" ], "summary": "Search Voting Groups", "description": "

Search Voting Groups

Performs a search applying filtering, sorting, and pagination criteria within the voting groups, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-groups/{id}": { "get": { "tags": [ "VotingGroup" ], "summary": "Get Voting Group", "description": "

Get Voting Group

Provides detailed information for a single voting group identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingGroupRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "VotingGroup" ], "summary": "Update Voting Group", "description": "

Update Voting Group

Applies an partial update to an existing voting group specified by its ID, affecting only voting groups within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Voting Groups → VotingGroupRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingGroupRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "VotingGroup" ], "summary": "Delete Voting Group", "description": "

Delete Voting Group

Deletes the specified voting group, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-groups/{id}/votes": { "get": { "tags": [ "VotingGroup" ], "summary": "List Votes", "description": "

List Votes

Module: Conferences

Returns: Conferences → Voting → Votes → VotingGroupVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupVoteRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupVoteRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupVoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-group-votes": { "post": { "tags": [ "VotingGroupVote" ], "summary": "Create Voting Group Vote", "description": "

Create Voting Group Vote

Creates a new voting group vote from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Voting → Votes → VotingGroupVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingGroupVoteWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingGroupVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "VotingGroupVote" ], "summary": "List Voting Group Votes", "description": "

List Voting Group Votes

Returns a paginated list of voting group votes filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Voting → Votes → VotingGroupVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-group-votes/batch": { "post": { "tags": [ "VotingGroupVote" ], "summary": "Batch List Voting Group Votes", "description": "

Batch List Voting Group Votes

Retrieves voting group votes matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Voting → Votes → VotingGroupVoteRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VotingGroupVoteRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "VotingGroupVote" ], "summary": "Update Voting Group Votes", "description": "

Update Voting Group Votes

Performs an partial update on multiple voting group votes identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-group-votes/{id}": { "get": { "tags": [ "VotingGroupVote" ], "summary": "Get Voting Group Vote", "description": "

Get Voting Group Vote

Provides detailed information for a single voting group vote identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Voting → Votes → VotingGroupVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingGroupVoteRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "VotingGroupVote" ], "summary": "Update Voting Group Vote", "description": "

Update Voting Group Vote

Applies an partial update to an existing voting group vote specified by its ID, affecting only voting group votes within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Voting → Votes → VotingGroupVoteRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingGroupVoteRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "VotingGroupVote" ], "summary": "Delete Voting Group Vote", "description": "

Delete Voting Group Vote

Deletes the specified voting group vote, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-majorities": { "get": { "tags": [ "VotingMajority" ], "summary": "Get Voting Majorities", "description": "

Get Voting Majorities

Module: Conferences

Returns: Conferences → Voting → Majorities → VotingMajorityRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingMajorityRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingMajorityRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingMajorityRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-procedures": { "get": { "tags": [ "VotingProcedure" ], "summary": "Get Voting Groups", "description": "

Get Voting Groups

Module: Conferences

Returns: Conferences → Voting → Procedures → VotingProcedureRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingProcedureRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingProcedureRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingProcedureRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-sessions": { "post": { "tags": [ "VotingSession" ], "summary": "Create Voting Session", "description": "

Create Voting Session

Creates a new voting session from the provided data, associating it within the requester's scope.

Module: Conferences

Returns: Conferences → Voting → Sessions → VotingSessionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VotingSessionWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingSessionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "VotingSession" ], "summary": "List Voting Sessions", "description": "

List Voting Sessions

Returns a paginated list of voting sessions filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Conferences

Returns: Conferences → Voting → Sessions → VotingSessionRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingSessionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-sessions/batch": { "post": { "tags": [ "VotingSession" ], "summary": "Batch List Voting Sessions", "description": "

Batch List Voting Sessions

Retrieves voting sessions matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Conferences

Returns: Conferences → Voting → Sessions → VotingSessionRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VotingSessionRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "VotingSession" ], "summary": "Update Voting Sessions", "description": "

Update Voting Sessions

Performs an partial update on multiple voting sessions identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Conferences

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-sessions/{id}": { "get": { "tags": [ "VotingSession" ], "summary": "Get Voting Session", "description": "

Get Voting Session

Provides detailed information for a single voting session identified by its ID, if it falls within the caller’s scope.

Module: Conferences

Returns: Conferences → Voting → Sessions → VotingSessionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingSessionRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "VotingSession" ], "summary": "Update Voting Session", "description": "

Update Voting Session

Applies an partial update to an existing voting session specified by its ID, affecting only voting sessions within the caller’s permitted scope.

Module: Conferences

Returns: Conferences → Voting → Sessions → VotingSessionRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingSessionRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "VotingSession" ], "summary": "Delete Voting Session", "description": "

Delete Voting Session

Deletes the specified voting session, if it falls within the caller’s scope.

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-sessions/{id}/results": { "get": { "tags": [ "VotingSession" ], "summary": "Get Voting Group Votes Count", "description": "

Get Voting Group Votes Count

Module: Conferences

Returns: Conferences → Voting → Votes → ResultsCount (single)

Authorization

Required Token Scopes: Platform (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResultsCount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResultsCount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResultsCount" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-sessions/{id}/sum-votes": { "get": { "tags": [ "VotingSession" ], "summary": "Get Sum Votes", "description": "

Get Sum Votes

Module: Conferences

Returns: Conferences → Sum Votes → SumVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSumVoteRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSumVoteRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfSumVoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-sessions/{id}/votes": { "get": { "tags": [ "VotingSession" ], "summary": "Get Votes", "description": "

Get Votes

Module: Conferences

Returns: Conferences → Voting → Votes → ConferenceVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceVoteRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceVoteRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfConferenceVoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/voting-sessions/{id}/voting-group-votes": { "post": { "tags": [ "VotingSession" ], "summary": "Fill Voting Group Votes", "description": "

Fill Voting Group Votes

Module: Conferences

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FillVotingGroupVotes" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FillVotingGroupVotes" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FillVotingGroupVotes" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Void" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Void" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Void" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "VotingSession" ], "summary": "Get Voting Group Votes", "description": "

Get Voting Group Votes

Module: Conferences

Returns: Conferences → Voting → Votes → VotingGroupVoteRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupVoteRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupVoteRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfVotingGroupVoteRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhooks": { "get": { "tags": [ "Webhook" ], "summary": "List Webhooks", "description": "

List Webhooks

Returns a paginated list of webhooks filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Webhooks

Returns: Web Hooks → WebhookRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhooks/batch": { "post": { "tags": [ "Webhook" ], "summary": "Batch List Webhooks", "description": "

Batch List Webhooks

Retrieves webhooks matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Webhooks

Returns: Web Hooks → WebhookRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhooks/{id}": { "get": { "tags": [ "Webhook" ], "summary": "Get Webhook", "description": "

Get Webhook

Provides detailed information for a single webhook identified by its ID, if it falls within the caller’s scope.

Module: Webhooks

Returns: Web Hooks → WebhookRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhooks/{id}/webhook-attempts": { "get": { "tags": [ "Webhook" ], "summary": "List Webhook Attempts", "description": "

List Webhook Attempts

Returns the entities related to the specified resource.

Module: Webhooks

Returns: Web Hooks → WebhookAttemptRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookAttemptRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookAttemptRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookAttemptRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-attempts": { "get": { "tags": [ "WebhookAttempt" ], "summary": "List Webhook Attempts", "description": "

List Webhook Attempts

Returns a paginated list of webhook attempts filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Webhooks

Returns: Web Hooks → WebhookAttemptRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookAttemptRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-attempts/batch": { "post": { "tags": [ "WebhookAttempt" ], "summary": "Batch List Webhook Attempts", "description": "

Batch List Webhook Attempts

Retrieves webhook attempts matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Webhooks

Returns: Web Hooks → WebhookAttemptRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookAttemptRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-attempts/{id}": { "get": { "tags": [ "WebhookAttempt" ], "summary": "Get Webhook Attempt", "description": "

Get Webhook Attempt

Provides detailed information for a single webhook attempt identified by its ID, if it falls within the caller’s scope.

Module: Webhooks

Returns: Web Hooks → WebhookAttemptRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookAttemptRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-events": { "get": { "tags": [ "WebhookEvent" ], "summary": "List Webhook Events", "description": "

List Webhook Events

Returns a paginated list of webhook events filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Webhooks

Returns: Web Hooks → WebhookEventRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookEventRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-events/batch": { "post": { "tags": [ "WebhookEvent" ], "summary": "Batch List Webhook Events", "description": "

Batch List Webhook Events

Retrieves webhook events matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Webhooks

Returns: Web Hooks → WebhookEventRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-events/{id}": { "get": { "tags": [ "WebhookEvent" ], "summary": "Get Webhook Event", "description": "

Get Webhook Event

Provides detailed information for a single webhook event identified by its ID, if it falls within the caller’s scope.

Module: Webhooks

Returns: Web Hooks → WebhookEventRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-registrations": { "post": { "tags": [ "WebhookRegistration" ], "summary": "Create Webhook Registration", "description": "

Create Webhook Registration

Creates a new webhook registration from the provided data, associating it within the requester's scope.

Module: Webhooks

Returns: Web Hooks → WebhookRegistrationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebhookRegistrationCreate" } ], "description": "Represents the data needed to create a webhook registration, including the target, enabled events, and authorization." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRegistrationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "WebhookRegistration" ], "summary": "List Webhook Registrations", "description": "

List Webhook Registrations

Returns a paginated list of webhook registrations filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Webhooks

Returns: Web Hooks → WebhookRegistrationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookRegistrationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-registrations/batch": { "post": { "tags": [ "WebhookRegistration" ], "summary": "Batch List Webhook Registrations", "description": "

Batch List Webhook Registrations

Retrieves webhook registrations matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Webhooks

Returns: Web Hooks → WebhookRegistrationRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookRegistrationRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WebhookRegistration" ], "summary": "Update Webhook Registrations", "description": "

Update Webhook Registrations

Performs an partial update on multiple webhook registrations identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Webhooks

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-registrations/search": { "post": { "tags": [ "WebhookRegistration" ], "summary": "Search Webhook Registrations", "description": "

Search Webhook Registrations

Performs a search applying filtering, sorting, and pagination criteria within the webhook registrations, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Webhooks

Returns: Web Hooks → WebhookRegistrationRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebhookRegistrationSearchRequest" } ], "description": "Parameters for searching webhook registrations." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookRegistrationRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-registrations/{id}": { "get": { "tags": [ "WebhookRegistration" ], "summary": "Get Webhook Registration", "description": "

Get Webhook Registration

Provides detailed information for a single webhook registration identified by its ID, if it falls within the caller’s scope.

Module: Webhooks

Returns: Web Hooks → WebhookRegistrationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRegistrationRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WebhookRegistration" ], "summary": "Update Webhook Registration", "description": "

Update Webhook Registration

Applies an partial update to an existing webhook registration specified by its ID, affecting only webhook registrations within the caller’s permitted scope.

Module: Webhooks

Returns: Web Hooks → WebhookRegistrationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRegistrationRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "WebhookRegistration" ], "summary": "Delete Webhook Registration", "description": "

Delete Webhook Registration

Deletes the specified webhook registration, if it falls within the caller’s scope.

Module: Webhooks

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/webhook-registrations/{id}/webhooks": { "get": { "tags": [ "WebhookRegistration" ], "summary": "List Webhooks", "description": "

List Webhooks

Returns the entities related to the specified resource.

Module: Webhooks

Returns: Web Hooks → WebhookRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWebhookRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-orders": { "post": { "tags": [ "WorkOrder" ], "summary": "Create Work Order", "description": "

Create Work Order

Creates a new work order from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Work Orders → WorkOrderRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "WorkOrder" ], "summary": "List Work Orders", "description": "

List Work Orders

Returns a paginated list of work orders filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Work Orders → WorkOrderRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-orders/batch": { "post": { "tags": [ "WorkOrder" ], "summary": "Batch List Work Orders", "description": "

Batch List Work Orders

Retrieves work orders matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Work Orders → WorkOrderRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WorkOrder" ], "summary": "Update Work Orders", "description": "

Update Work Orders

Performs an partial update on multiple work orders identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-orders/search": { "post": { "tags": [ "WorkOrder" ], "summary": "Search Work Orders", "description": "

Search Work Orders

Performs a search applying filtering, sorting, and pagination criteria within the work orders, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Work Orders → WorkOrderRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-orders/{id}": { "get": { "tags": [ "WorkOrder" ], "summary": "Get Work Order", "description": "

Get Work Order

Provides detailed information for a single work order identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Work Orders → WorkOrderRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WorkOrder" ], "summary": "Update Work Order", "description": "

Update Work Order

Applies an partial update to an existing work order specified by its ID, affecting only work orders within the caller’s permitted scope.

Module: Processes

Returns: Processes → Work Orders → WorkOrderRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "WorkOrder" ], "summary": "Delete Work Order", "description": "

Delete Work Order

Deletes the specified work order, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-orders/{id}/appointment-requests": { "get": { "tags": [ "WorkOrder" ], "summary": "List Dates", "description": "

List Dates

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → WorkOrderAppointmentRequestRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-orders/{id}/invoices": { "get": { "tags": [ "WorkOrder" ], "summary": "List Attached Invoices", "description": "

List Attached Invoices

Module: Processes

Returns: Processes → Invoices → InvoiceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-orders/{id}/invoices/{invoiceId}": { "put": { "tags": [ "WorkOrder" ], "summary": "Attach Invoice To Work Order", "description": "

Attach Invoice To Work Order

Module: Processes

Returns: Processes → Invoices → InvoiceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "WorkOrder" ], "summary": "Remove Invoice From Work Order", "description": "

Remove Invoice From Work Order

Module: Processes

Returns: Processes → Invoices → InvoiceRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Property Management Company (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfInvoiceRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-requests": { "post": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "Create Work Order Appointment Request", "description": "

Create Work Order Appointment Request

Creates a new work order appointment request from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → WorkOrderAppointmentRequestRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderAppointmentRequestWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "List Work Order Appointment Requests", "description": "

List Work Order Appointment Requests

Returns a paginated list of work order appointment requests filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → WorkOrderAppointmentRequestRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-requests/batch": { "post": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "Batch List Work Order Appointment Requests", "description": "

Batch List Work Order Appointment Requests

Retrieves work order appointment requests matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → WorkOrderAppointmentRequestRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "Update Work Order Appointment Requests", "description": "

Update Work Order Appointment Requests

Performs an partial update on multiple work order appointment requests identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-requests/search": { "post": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "Search Work Order Appointment Requests", "description": "

Search Work Order Appointment Requests

Performs a search applying filtering, sorting, and pagination criteria within the work order appointment requests, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → WorkOrderAppointmentRequestRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-requests/{id}": { "get": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "Get Work Order Appointment Request", "description": "

Get Work Order Appointment Request

Provides detailed information for a single work order appointment request identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → WorkOrderAppointmentRequestRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "Update Work Order Appointment Request", "description": "

Update Work Order Appointment Request

Applies an partial update to an existing work order appointment request specified by its ID, affecting only work order appointment requests within the caller’s permitted scope.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → WorkOrderAppointmentRequestRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "Delete Work Order Appointment Request", "description": "

Delete Work Order Appointment Request

Deletes the specified work order appointment request, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-requests/{id}/dates": { "get": { "tags": [ "WorkOrderAppointmentRequest" ], "summary": "List Dates", "description": "

List Dates

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → Dates → WorkOrderAppointmentRequestDateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestDateRead" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestDateRead" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestDateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-request-dates": { "post": { "tags": [ "WorkOrderAppointmentRequestDate" ], "summary": "Create Work Order Appointment Request Date", "description": "

Create Work Order Appointment Request Date

Creates a new work order appointment request date from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → Dates → WorkOrderAppointmentRequestDateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "WorkOrderAppointmentRequestDate" ], "summary": "List Work Order Appointment Request Dates", "description": "

List Work Order Appointment Request Dates

Returns a paginated list of work order appointment request dates filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → Dates → WorkOrderAppointmentRequestDateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestDateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-request-dates/batch": { "post": { "tags": [ "WorkOrderAppointmentRequestDate" ], "summary": "Batch List Work Order Appointment Request Dates", "description": "

Batch List Work Order Appointment Request Dates

Retrieves work order appointment request dates matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → Dates → WorkOrderAppointmentRequestDateRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WorkOrderAppointmentRequestDate" ], "summary": "Update Work Order Appointment Request Dates", "description": "

Update Work Order Appointment Request Dates

Performs an partial update on multiple work order appointment request dates identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-request-dates/search": { "post": { "tags": [ "WorkOrderAppointmentRequestDate" ], "summary": "Search Work Order Appointment Request Dates", "description": "

Search Work Order Appointment Request Dates

Performs a search applying filtering, sorting, and pagination criteria within the work order appointment request dates, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → Dates → WorkOrderAppointmentRequestDateRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateSearchRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderAppointmentRequestDateRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-appointment-request-dates/{id}": { "get": { "tags": [ "WorkOrderAppointmentRequestDate" ], "summary": "Get Work Order Appointment Request Date", "description": "

Get Work Order Appointment Request Date

Provides detailed information for a single work order appointment request date identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → Dates → WorkOrderAppointmentRequestDateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WorkOrderAppointmentRequestDate" ], "summary": "Update Work Order Appointment Request Date", "description": "

Update Work Order Appointment Request Date

Applies an partial update to an existing work order appointment request date specified by its ID, affecting only work order appointment request dates within the caller’s permitted scope.

Module: Processes

Returns: Processes → Work Orders → Appointment Requests → Dates → WorkOrderAppointmentRequestDateRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "WorkOrderAppointmentRequestDate" ], "summary": "Delete Work Order Appointment Request Date", "description": "

Delete Work Order Appointment Request Date

Deletes the specified work order appointment request date, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-feed-entries": { "post": { "tags": [ "WorkOrderFeedEntry" ], "summary": "Create Work Order Feed Entry", "description": "

Create Work Order Feed Entry

Creates a new work order feed entry from the provided data, associating it within the requester's scope.

Module: Processes

Returns: Processes → Work Orders → Feed Entries → WorkOrderFeedEntryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderFeedEntryWrite" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderFeedEntryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "get": { "tags": [ "WorkOrderFeedEntry" ], "summary": "List Work Order Feed Entries", "description": "

List Work Order Feed Entries

Returns a paginated list of work order feed entries filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Work Orders → Feed Entries → WorkOrderFeedEntryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderFeedEntryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-feed-entries/batch": { "post": { "tags": [ "WorkOrderFeedEntry" ], "summary": "Batch List Work Order Feed Entries", "description": "

Batch List Work Order Feed Entries

Retrieves work order feed entries matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Work Orders → Feed Entries → WorkOrderFeedEntryRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderFeedEntryRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WorkOrderFeedEntry" ], "summary": "Update Work Order Feed Entries", "description": "

Update Work Order Feed Entries

Performs an partial update on multiple work order feed entries identified by a list of IDs, limited to those within the caller’s scope. This endpoint is designed to streamline modifications that need to be applied across many records, improving efficiency and consistency.

Module: Processes

Returns: System → Int32 (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUpdateDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-feed-entries/search": { "post": { "tags": [ "WorkOrderFeedEntry" ], "summary": "Search Work Order Feed Entries", "description": "

Search Work Order Feed Entries

Performs a search applying filtering, sorting, and pagination criteria within the work order feed entries, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Processes

Returns: Processes → Work Orders → Feed Entries → WorkOrderFeedEntryRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AuditableEntitySearchQueryParameters" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderFeedEntryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-feed-entries/{id}": { "get": { "tags": [ "WorkOrderFeedEntry" ], "summary": "Get Work Order Feed Entry", "description": "

Get Work Order Feed Entry

Provides detailed information for a single work order feed entry identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Work Orders → Feed Entries → WorkOrderFeedEntryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderFeedEntryRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "patch": { "tags": [ "WorkOrderFeedEntry" ], "summary": "Update Work Order Feed Entry", "description": "

Update Work Order Feed Entry

Applies an partial update to an existing work order feed entry specified by its ID, affecting only work order feed entries within the caller’s permitted scope.

Module: Processes

Returns: Processes → Work Orders → Feed Entries → WorkOrderFeedEntryRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Update (2)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderFeedEntryRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "WorkOrderFeedEntry" ], "summary": "Delete Work Order Feed Entry", "description": "

Delete Work Order Feed Entry

Deletes the specified work order feed entry, if it falls within the caller’s scope.

Module: Processes

Returns: Void

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Delete (3)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-statuses": { "get": { "tags": [ "WorkOrderStatus" ], "summary": "List Work Order Statuses", "description": "

List Work Order Statuses

Returns a paginated list of work order statuses filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Work Orders → Statuses → WorkOrderStatusRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderStatusRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-statuses/batch": { "post": { "tags": [ "WorkOrderStatus" ], "summary": "Batch List Work Order Statuses", "description": "

Batch List Work Order Statuses

Retrieves work order statuses matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Work Orders → Statuses → WorkOrderStatusRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderStatusRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-statuses/{id}": { "get": { "tags": [ "WorkOrderStatus" ], "summary": "Get Work Order Statu", "description": "

Get Work Order Statu

Provides detailed information for a single work order statu identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Work Orders → Statuses → WorkOrderStatusRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderStatusRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-types": { "get": { "tags": [ "WorkOrderType" ], "summary": "List Work Order Types", "description": "

List Work Order Types

Returns a paginated list of work order types filtered to include only those within the scope of the caller’s permissions. Supports sorting and pagination parameters to efficiently navigate through the data.

Module: Processes

Returns: Processes → Work Order Types → WorkOrderTypeRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortByAttributeName", "in": "query", "schema": { "type": "string" } }, { "name": "AscendingOrder", "in": "query", "schema": { "type": "boolean" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListOfWorkOrderTypeRead" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-types/batch": { "post": { "tags": [ "WorkOrderType" ], "summary": "Batch List Work Order Types", "description": "

Batch List Work Order Types

Retrieves work order types matching the specified list of IDs, limited to those within the caller’s permitted scope. This batch retrieval optimizes network calls by returning multiple items in one request.

Module: Processes

Returns: Processes → Work Order Types → WorkOrderTypeRead (list)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdListDtoOfInt32" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderTypeRead" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-types/{id}": { "get": { "tags": [ "WorkOrderType" ], "summary": "Get Work Order Type", "description": "

Get Work Order Type

Provides detailed information for a single work order type identified by its ID, if it falls within the caller’s scope.

Module: Processes

Returns: Processes → Work Order Types → WorkOrderTypeRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), Pool Manager (3), Contractor (5), User (7), Insurance Broker (13), Insurer (14)

This will be evaluated against your used access token.

", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept-Language", "in": "header", "description": "Language preference header. Allowed languages: German (en-DE).", "schema": { "type": "string" } }, { "name": "api-version", "in": "header", "description": "API version to use (`1` or `2`) either with trailing `.0` or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).", "schema": { "type": "string", "default": "2.0" }, "examples": { "1": { "value": "1" }, "1.0": { "value": "1.0" }, "2": { "value": "2" }, "2.0": { "value": "2.0" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrderTypeRead" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } } }, "components": { "schemas": { "AccountActivationMessageResponse": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } }, "additionalProperties": false }, "AccountContactDetailsRead": { "required": [ "accountId", "contactTypeId", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "accountId": { "type": "integer", "format": "int32" }, "contactTypeId": { "type": "integer", "format": "int32" }, "customerAppId": { "type": "integer", "format": "int32", "nullable": true }, "value": { "type": "string", "nullable": true }, "deviceName": { "type": "string", "nullable": true }, "deviceSystem": { "type": "string", "nullable": true }, "deviceVersion": { "type": "string", "nullable": true }, "deviceLanguage": { "type": "string", "nullable": true }, "deviceTimezone": { "type": "string", "nullable": true }, "deviceWidth": { "type": "integer", "format": "int32", "nullable": true }, "deviceHeight": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AccountContactDetailsWrite": { "required": [ "contactTypeId", "value" ], "type": "object", "properties": { "contactTypeId": { "type": "integer", "format": "int32" }, "value": { "maxLength": 255, "minLength": 1, "type": "string" }, "deviceName": { "maxLength": 255, "type": "string", "nullable": true }, "deviceSystem": { "maxLength": 255, "type": "string", "nullable": true }, "deviceVersion": { "maxLength": 255, "type": "string", "nullable": true }, "deviceLanguage": { "maxLength": 255, "type": "string", "nullable": true }, "deviceTimezone": { "maxLength": 255, "type": "string", "nullable": true }, "deviceWidth": { "type": "integer", "format": "int32", "nullable": true }, "deviceHeight": { "type": "integer", "format": "int32", "nullable": true }, "customerAppId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AccountGroupPermissionMappingRead": { "required": [ "accountGroupId", "permissionId" ], "type": "object", "properties": { "accountGroupId": { "type": "integer", "description": "The ID of the account group this permission is assigned to.", "format": "int32" }, "permissionId": { "type": "integer", "description": "The ID of the assigned account permission.", "format": "int32" } }, "additionalProperties": false, "description": "Represents the assignment of an `AccountPermission` to an `AccountGroup`." }, "AccountGroupRead": { "required": [ "creatorPartyId", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "creatorPartyId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccountGroupWrite": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "AccountPermissionRead": { "required": [ "id", "order", "typeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "typeId": { "type": "integer", "description": "- 1: orders (Vorgänge)\n- 2: coredata (Projekte & Objekte)\n- 4: instances (Nutzer & Zugänge)\n- 5: users (Mitarbeiter)\n- 6: inbox (Eingang)\n- 9: company (Einstellungen)\n- 10: admin (Administration)\n- 11: calendar (Termine)\n- 12: finances (Finanzen)\n- 13: companynews (Nutzer:innen informieren)\n- 14: documents (Dokumente)\n- 15: statistics (Statistik)\n- 20: todo (Aufgaben)\n- 22: timetracking (Zeiterfassung)", "format": "int32" }, "name": { "type": "string", "description": "German-facing name of this permission.", "nullable": true }, "order": { "type": "integer", "description": "Non-unique number to enable sorting.", "format": "int32" } }, "additionalProperties": false }, "AccountRead": { "required": [ "colorId", "groupId", "hasRepresentationViewForAllAccounts", "id", "isPartyAdministrator", "isSupervisor", "themeMode" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "email": { "type": "string", "description": "The unique login email address of the account.", "nullable": true }, "phoneNumber": { "type": "string", "description": "The phone number associated with the account.", "nullable": true }, "partyId": { "type": "integer", "description": "Identifier of the Party (legal entity) this account belongs to.", "format": "int32", "nullable": true }, "firstName": { "type": "string", "description": "The first name of the account holder.", "nullable": true }, "lastName": { "type": "string", "description": "The last name of the account holder.", "nullable": true }, "fullName": { "type": "string", "description": "The computed full name of the account holder.\nTypically composed of first name and last name.", "nullable": true }, "themeMode": { "allOf": [ { "$ref": "#/components/schemas/ThemeMode" } ], "description": "The preferred UI theme mode for the account.\n\nPossible values:\n- 0 = Light\n- 1 = Dark\n- 2 = System" }, "isPartyAdministrator": { "type": "boolean", "description": "Indicates whether the account has administrative privileges within its Party." }, "groupId": { "type": "integer", "description": "Identifier of the account group that defines permissions and roles.", "format": "int32" }, "colorId": { "type": "integer", "description": "Identifier of the UI color assigned to the account.", "format": "int32", "deprecated": true }, "logoId": { "type": "integer", "description": "Reference to `File` that represents the logo of the `Account`.", "format": "int32", "nullable": true }, "hasRepresentationViewForAllAccounts": { "type": "boolean", "description": "Indicates whether the account can view representations across all accounts of the Party." }, "isSupervisor": { "type": "boolean", "description": "Indicates whether the account has supervisor privileges. Only used in parties of type (`Party.AccountRole`) PoolManager (3) or Contractor (5)." }, "recoveryCodeBlockedUntilDate": { "type": "string", "description": "Defines until when login via recovery code is blocked. Used in the password reset flow.", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "description": "Optional identifier linking the account to an external system.\nHas to be unique within a Party.", "nullable": true } }, "additionalProperties": false }, "AccountRole": { "enum": [ 1, 2, 3, 5, 7, 10, 11, 13, 14, 15 ], "type": "integer", "description": "Possible values:\n- 1 = Admin\n- 2 = PropertyManagementCompany\n- 3 = PoolManager\n- 5 = Contractor\n- 7 = User\n- 10 = EnergyProvider\n- 11 = Guest\n- 13 = InsuranceBroker\n- 14 = Insurer\n- 15 = Mediator", "format": "int32" }, "AccountSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Account's FirstName, LastName, and Email.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "email": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccountWrite": { "required": [ "email", "groupId", "lastName", "partyId" ], "type": "object", "properties": { "email": { "type": "string", "description": "The unique login email address of the account.\nMust be globally unique and formatted as a valid email address." }, "partyId": { "type": "integer", "description": "Identifier of the Party (legal entity) the account belongs to.\nRequired during creation and cannot be changed afterwards.\nUser-type Parties may only contain a single account.", "format": "int32" }, "firstName": { "type": "string", "description": "The first name of the account holder.\nCurrently not changeable after account creation.", "nullable": true }, "lastName": { "type": "string", "description": "The last name of the account holder.\nRequired during creation and currently not changeable afterwards." }, "themeMode": { "allOf": [ { "$ref": "#/components/schemas/ThemeMode" } ], "description": "The preferred UI theme mode.\nDefaults to the system theme if not specified.\n\nPossible values:\n- 0 = Light\n- 1 = Dark\n- 2 = System", "default": 2, "nullable": true }, "isPartyAdministrator": { "type": "boolean", "description": "Indicates whether the account should have administrative privileges within its Party.\nCannot be initialized during account creation.\nCan only be modified by Party administrators of the same Party.", "nullable": true }, "groupId": { "type": "integer", "description": "Identifier of the account group that defines permissions and roles.\nMust reference an accessible existing account group.", "format": "int32" }, "colorId": { "type": "integer", "description": "Identifier of the UI color assigned to the account.\nIf not provided, a default color will be assigned automatically.", "format": "int32", "nullable": true, "deprecated": true }, "logoId": { "type": "integer", "description": "Reference to `File` that represents the logo of the `Account`.", "format": "int32", "nullable": true }, "hasRepresentationViewForAllAccounts": { "type": "boolean", "description": "Indicates whether the account can view representations across all accounts of the Party.\nCannot be initialized during account creation.\nCan only be modified by Party administrators of the same Party.", "nullable": true }, "isSupervisor": { "type": "boolean", "description": "Indicates whether the account should have supervisor privileges.\nCannot be initialized during account creation.\nCan only be modified by Party administrators of the same Party.\nOnly used in parties of type (`Party.AccountRole`) PoolManager (3) or Contractor (5).", "nullable": true }, "externalId": { "type": "string", "description": "Optional identifier linking the account to an external system.\nMust be unique within the same Party and limited to 50 characters.", "nullable": true } }, "additionalProperties": false }, "ActivityAttemptRead": { "required": [ "id", "initiatorAccountId", "smartLockId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "smartLockId": { "type": "integer", "format": "int32" }, "initiatorAccountId": { "type": "integer", "format": "int32" }, "initiatedWithinProcessId": { "type": "integer", "format": "int32", "nullable": true }, "initiatedWithinWorkOrderId": { "type": "integer", "format": "int32", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ActivityAttemptWrite": { "required": [ "smartLockId" ], "type": "object", "properties": { "smartLockId": { "type": "integer", "format": "int32" }, "initiatedWithinProcessId": { "type": "integer", "format": "int32", "nullable": true }, "initiatedWithinWorkOrderId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AddProcessStageRequest": { "required": [ "order" ], "type": "object", "properties": { "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AgendaCreate": { "required": [ "agendaInfoTextFont", "agendaInfoTextSize", "agendaResolutionTextFont", "agendaResolutionTextSize", "agendaResolutionTitleFont", "agendaResolutionTitleSize", "agendaTopicDescriptionFont", "agendaTopicDescriptionSize", "agendaTopicTitleFont", "agendaTopicTitleSize", "printConferenceDetailsOnAgenda", "printResolutionTextsOnAgenda", "printResolutionTitlesOnAgenda" ], "type": "object", "properties": { "agendaInfoTextFont": { "type": "string" }, "agendaInfoTextSize": { "type": "integer", "format": "int32" }, "agendaTopicTitleFont": { "type": "string" }, "agendaTopicTitleSize": { "type": "integer", "format": "int32" }, "agendaTopicDescriptionFont": { "type": "string" }, "agendaTopicDescriptionSize": { "type": "integer", "format": "int32" }, "agendaResolutionTitleFont": { "type": "string" }, "agendaResolutionTitleSize": { "type": "integer", "format": "int32" }, "agendaResolutionTextFont": { "type": "string" }, "agendaResolutionTextSize": { "type": "integer", "format": "int32" }, "printConferenceDetailsOnAgenda": { "type": "boolean" }, "printResolutionTitlesOnAgenda": { "type": "boolean" }, "printResolutionTextsOnAgenda": { "type": "boolean" } }, "additionalProperties": false }, "ApiKeyLoginRequest": { "required": [ "apiKey" ], "type": "object", "properties": { "apiKey": { "type": "string" } }, "additionalProperties": false }, "AttendanceRead": { "required": [ "conferenceId", "id", "ownerId", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "conferenceId": { "type": "integer", "format": "int32" }, "ownerId": { "type": "integer", "format": "int32" }, "type": { "allOf": [ { "$ref": "#/components/schemas/AttendanceType" } ], "description": "Possible values:\n- 1 = Online\n- 2 = Onsite\n- 3 = Represented\n- 4 = NoParticipation" } }, "additionalProperties": false }, "AttendanceType": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Possible values:\n- 1 = Online\n- 2 = Onsite\n- 3 = Represented\n- 4 = NoParticipation", "format": "int32" }, "AttendanceWrite": { "required": [ "conferenceId", "ownerId", "type" ], "type": "object", "properties": { "conferenceId": { "type": "integer", "format": "int32" }, "ownerId": { "type": "integer", "format": "int32" }, "type": { "allOf": [ { "$ref": "#/components/schemas/AttendanceType" } ], "description": "Possible values:\n- 1 = Online\n- 2 = Onsite\n- 3 = Represented\n- 4 = NoParticipation" } }, "additionalProperties": false }, "AttributeGroupRead": { "required": [ "id", "name", "type", "typeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "propertyManagementCompanyId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "type": { "type": "integer", "format": "int32", "deprecated": true }, "typeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AttributeGroupSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the AttributeGroup's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "entranceId": { "type": "integer", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttributeGroupTypeRead": { "required": [ "color", "icon", "id", "name", "order" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AttributeGroupWrite": { "required": [ "name" ], "type": "object", "properties": { "partyId": { "type": "integer", "format": "int32", "nullable": true }, "propertyManagementCompanyId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "externalId": { "maxLength": 70, "type": "string", "nullable": true }, "typeId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AttributeRead": { "required": [ "id", "isSharesProperty", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "propertyManagementCompanyId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "name": { "type": "string" }, "externalId": { "type": "string", "nullable": true }, "isSharesProperty": { "type": "boolean" } }, "additionalProperties": false }, "AttributeSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Attribute's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "externalId": { "type": "string", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "attributeGroupTypeId": { "type": "integer", "format": "int32", "nullable": true }, "onlyCommonAttributes": { "type": "boolean", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttributeValueRead": { "required": [ "attributeGroupId", "attributeId", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "attributeGroupId": { "type": "integer", "format": "int32" }, "attributeId": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttributeValueSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the AttributeValue's Value.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "attributeId": { "type": "integer", "format": "int32", "nullable": true }, "attributeGroupId": { "type": "integer", "format": "int32", "nullable": true }, "attributeExternalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttributeValueWrite": { "required": [ "attributeGroupId", "attributeId", "value" ], "type": "object", "properties": { "attributeGroupId": { "type": "integer", "format": "int32" }, "attributeId": { "type": "integer", "format": "int32" }, "value": { "maxLength": 255, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "AttributeWrite": { "required": [ "name" ], "type": "object", "properties": { "partyId": { "type": "integer", "format": "int32", "nullable": true }, "propertyManagementCompanyId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "name": { "type": "string" }, "externalId": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "AuditableEntitySearchQueryParameters": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" } }, "additionalProperties": false }, "AuthSession": { "required": [ "accountId", "expiresAt", "hasBeenRedeemed", "hasExpired", "isPasswordChangeRequired", "issuedAt", "token" ], "type": "object", "properties": { "accountId": { "type": "integer", "format": "int32" }, "token": { "type": "string" }, "issuedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "hasExpired": { "type": "boolean" }, "hasBeenRedeemed": { "type": "boolean" }, "isPasswordChangeRequired": { "type": "boolean" } }, "additionalProperties": false }, "AuthorizationType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "Possible values:\n- 0 = NoAuth\n- 1 = BasicAuth\n- 2 = PlatformSignedBearerTokenHeader\n- 3 = PlatformSignedBearerTokenBody\n- 4 = TargetApiToken", "format": "int32" }, "BankAccountRead": { "required": [ "id", "partyId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "iban": { "type": "string", "nullable": true }, "bic": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BankAccountSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the BankAccount's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "bic": { "type": "string", "nullable": true }, "iban": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BankAccountWrite": { "type": "object", "properties": { "name": { "maxLength": 255, "type": "string", "nullable": true }, "iban": { "maxLength": 45, "type": "string", "nullable": true }, "bic": { "maxLength": 11, "type": "string", "nullable": true } }, "additionalProperties": false }, "BillingAddressRead": { "required": [ "id", "propertyId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "propertyId": { "type": "integer", "format": "int32" }, "recipient": { "type": "string", "nullable": true }, "deliveryInstructions": { "type": "string", "nullable": true }, "streetWithNumber": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BillingAddressSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the BillingAddress' Recipient, DeliveryInstructions, StreetWithNumber, ZipCode, and City.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BillingAddressWrite": { "required": [ "city", "propertyId", "recipient", "streetWithNumber", "zipCode" ], "type": "object", "properties": { "propertyId": { "type": "integer", "format": "int32" }, "recipient": { "maxLength": 255, "minLength": 1, "type": "string" }, "deliveryInstructions": { "maxLength": 255, "type": "string", "nullable": true }, "streetWithNumber": { "maxLength": 255, "minLength": 1, "type": "string" }, "zipCode": { "maxLength": 255, "minLength": 1, "type": "string" }, "city": { "maxLength": 255, "minLength": 1, "type": "string" }, "externalId": { "maxLength": 255, "type": "string", "nullable": true } }, "additionalProperties": false }, "BookedPlatformProductRead": { "required": [ "id", "partyId", "platformProductId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "description": "The ID of the party that booked the platform product.\nWill usually only include the ID of the party making the request.", "format": "int32" }, "platformProductId": { "type": "integer", "description": "The ID of the booked platform product.\nSee `PlatformProduct` for more details.", "format": "int32" } }, "additionalProperties": false, "description": "Represents a currently active booking of a platform product for a specific party.\nBookings whose effective date range lies entirely in the past, or that only start in the future, are excluded." }, "BookedPlatformProductSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "partyId": { "type": "integer", "description": "Filters bookings by the ID of the `Party` that booked the product.\nIn practice this filter is rarely useful: non-admin callers only ever see\ntheir own party's bookings, so the returned list is already constrained to\n`PartyId == authContext.PartyId`.", "format": "int32", "nullable": true }, "platformProductId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filters bookings by the ID of the underlying `PlatformProduct`.", "nullable": true } }, "additionalProperties": false }, "BookingAccountItemRead": { "required": [ "bookingAccountId", "date", "id", "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "bookingAccountId": { "type": "integer", "format": "int32" }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "documentId": { "type": "integer", "format": "int32", "nullable": true }, "number": { "type": "integer", "format": "int32", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "text": { "type": "string" }, "intake": { "type": "number", "format": "double", "nullable": true }, "output": { "type": "number", "format": "double", "nullable": true }, "balance": { "type": "number", "format": "double", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookingAccountItemSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the BookingAccountItem's Text.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "bookingAccountId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "year": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BookingAccountItemWrite": { "required": [ "bookingAccountId", "date", "text" ], "type": "object", "properties": { "bookingAccountId": { "type": "integer", "format": "int32" }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "documentId": { "type": "integer", "format": "int32", "nullable": true }, "number": { "type": "integer", "format": "int32", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "text": { "type": "string" }, "intake": { "type": "number", "format": "double", "nullable": true }, "output": { "type": "number", "format": "double", "nullable": true }, "balance": { "type": "number", "format": "double", "nullable": true }, "externalId": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "BookingAccountRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "number": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookingAccountSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the BookingAccount's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookingAccountWrite": { "type": "object", "properties": { "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "number": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "externalId": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkUpdateDtoOfInt32": { "required": [ "body", "ids" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "body": { } }, "additionalProperties": false }, "CallLogRead": { "required": [ "calculatedCost", "calledNumberId", "callSummary", "directAnswers", "durationInSeconds", "hangupReason", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "calledNumberId": { "type": "integer", "description": "The ID of the voicebot phone number that was called.", "format": "int32" }, "callerNumber": { "type": "string", "description": "The phone number of the caller, if it was provided by the call.", "nullable": true }, "identifiedCallerPartyId": { "type": "integer", "description": "The ID of the party identified as the caller, if the caller could be matched.", "format": "int32", "nullable": true }, "identifiedPropertyId": { "type": "integer", "description": "The ID of the property identified during the call.", "format": "int32", "nullable": true }, "identifiedUnitId": { "type": "integer", "description": "The ID of the unit identified during the call.", "format": "int32", "nullable": true }, "identifiedProcessId": { "type": "integer", "description": "The ID of the process identified during the call.", "format": "int32", "nullable": true }, "createdInquiryId": { "type": "integer", "description": "The ID of the inquiry created from the call, if an inquiry was created.", "format": "int32", "nullable": true }, "createdProcessFeedEntryId": { "type": "integer", "description": "The ID of the process feed entry created from the call, if a feed entry was created.", "format": "int32", "nullable": true }, "audioRecordingFileId": { "type": "integer", "description": "The ID of the file containing the audio recording of the call.", "format": "int32", "nullable": true }, "hangupReason": { "allOf": [ { "$ref": "#/components/schemas/HangupReason" } ], "description": "The reason why the call ended.\n\nPossible values:\n- 0 = UserHangup\n- 1 = AgentHangup\n- 2 = CallTransfer\n- 3 = Inactivity\n- 4 = MaxCallLength\n- 5 = Timeout\n- 6 = Voicemail\n- 7 = GeneralError\n- 8 = ConcurrencyLimitReached\n- 9 = Unknown" }, "directAnswers": { "type": "integer", "description": "The number of questions that could be answered directly by the voicebot.", "format": "int32" }, "durationInSeconds": { "type": "integer", "description": "The duration of the call in seconds.", "format": "int32" }, "calculatedCost": { "type": "number", "description": "The calculated cost of the call.", "format": "double" }, "callSummary": { "type": "string", "description": "The summary of the call generated by the voicebot." }, "apiError": { "type": "string", "description": "The API error returned while processing the call, if an error occurred.", "nullable": true } }, "additionalProperties": false }, "ChangePasswordRequest": { "required": [ "newPassword" ], "type": "object", "properties": { "currentPassword": { "type": "string", "nullable": true }, "apiKey": { "type": "string", "nullable": true }, "newPassword": { "type": "string" } }, "additionalProperties": false }, "ChangePasswordWithRecoveryCodeRequest": { "required": [ "email", "password", "recoveryCode" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email of the user whose password should be changed." }, "password": { "type": "string", "description": "The new password to set for the user." }, "recoveryCode": { "type": "integer", "description": "The recovery code provided to the user for verification.", "format": "int32" } }, "additionalProperties": false }, "ChangePasswordWithRecoveryCodeResponse": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email of the user whose password was successfully changed." } }, "additionalProperties": false }, "ChatGptSettingsRead": { "required": [ "id", "partyId", "systemPrompt" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32" }, "systemPrompt": { "type": "string" } }, "additionalProperties": false }, "ChatGptSettingsWrite": { "required": [ "partyId", "systemPrompt" ], "type": "object", "properties": { "partyId": { "type": "integer", "format": "int32" }, "systemPrompt": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ChatbotConfigurationRead": { "required": [ "id", "isDefault", "name", "partyId", "systemPrompt" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "systemPrompt": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "ChatbotConfigurationWrite": { "required": [ "isDefault", "name", "partyId", "systemPrompt" ], "type": "object", "properties": { "partyId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "systemPrompt": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "ChatbotConversationRead": { "required": [ "accountId", "chatbotConfigurationId", "id", "lastMessageAt" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "chatbotConfigurationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "lastMessageAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ChatbotMessageRead": { "required": [ "accountId", "chatbotConversationId", "content", "id", "role" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "accountId": { "type": "integer", "format": "int32" }, "chatbotConversationId": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SearchQueryResultItem" }, "nullable": true }, "entityResultIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "content": { "type": "string" }, "role": { "allOf": [ { "$ref": "#/components/schemas/ChatbotMessageRole" } ], "description": "Possible values:\n- 0 = User\n- 1 = Assistant" }, "previousMessageId": { "type": "integer", "format": "int32", "nullable": true }, "subsequentMessageId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ChatbotMessageRole": { "enum": [ "User", "Assistant" ], "type": "string", "description": "Possible values:\n- 0 = User\n- 1 = Assistant" }, "ChatbotMessageWrite": { "required": [ "content" ], "type": "object", "properties": { "chatbotConversationId": { "type": "integer", "format": "int32", "nullable": true }, "content": { "type": "string" } }, "additionalProperties": false }, "ChecklistRuleOfPartyRead": { "required": [ "affectedEntities", "extraInformation", "status" ], "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleStatus" } ], "description": "Possible values:\n- 1 = Ok\n- 2 = Warning\n- 3 = Error" }, "extraInformation": { "type": "string" }, "affectedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRead" } } }, "additionalProperties": false }, "ChecklistRuleOfResolutionRead": { "required": [ "affectedEntities", "extraInformation", "status" ], "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleStatus" } ], "description": "Possible values:\n- 1 = Ok\n- 2 = Warning\n- 3 = Error" }, "extraInformation": { "type": "string" }, "affectedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionRead" } } }, "additionalProperties": false }, "ChecklistRuleOfTopicRead": { "required": [ "affectedEntities", "extraInformation", "status" ], "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleStatus" } ], "description": "Possible values:\n- 1 = Ok\n- 2 = Warning\n- 3 = Error" }, "extraInformation": { "type": "string" }, "affectedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/TopicRead" } } }, "additionalProperties": false }, "ChecklistRuleOfUnitRead": { "required": [ "affectedEntities", "extraInformation", "status" ], "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleStatus" } ], "description": "Possible values:\n- 1 = Ok\n- 2 = Warning\n- 3 = Error" }, "extraInformation": { "type": "string" }, "affectedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/UnitRead" } } }, "additionalProperties": false }, "ChecklistRuleStatus": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Possible values:\n- 1 = Ok\n- 2 = Warning\n- 3 = Error", "format": "int32" }, "CloudConnectAuditRead": { "required": [ "id", "messageId", "source", "target" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "messageId": { "type": "string", "format": "uuid" }, "source": { "type": "string" }, "target": { "type": "string" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "payload": { "type": "string", "nullable": true }, "previousBlockName": { "type": "string", "nullable": true }, "currentBlockName": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CloudConnectAuditWrite": { "required": [ "messageId", "source", "target" ], "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "source": { "type": "string" }, "target": { "type": "string" }, "accountId": { "type": "integer", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "payload": { "type": "string", "nullable": true }, "previousBlockName": { "type": "string", "nullable": true }, "currentBlockName": { "type": "string", "nullable": true }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ColorRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "background": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompleteChallengeRequest": { "required": [ "nonce", "token" ], "type": "object", "properties": { "nonce": { "type": "string" }, "token": { "type": "string" } }, "additionalProperties": false }, "ConferenceChecklist": { "required": [ "partyAccountsExistRule", "resolutionsExistRule", "resolutionsHaveConsistentVotingProcedureRule", "resolutionsHaveEligibleUnitsRule", "resolutionsInCollectionRule", "topicDescriptionsExistRule", "unitHasContractsRule", "unitSharesNotNullRule", "unitSharesNotZeroRule", "unitsNotEligibleInResolutionsRule", "unitsWithoutOwnersRule" ], "type": "object", "properties": { "topicDescriptionsExistRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfTopicRead" } ] }, "resolutionsExistRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfResolutionRead" } ] }, "resolutionsHaveConsistentVotingProcedureRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfResolutionRead" } ] }, "resolutionsHaveEligibleUnitsRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfResolutionRead" } ] }, "partyAccountsExistRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfPartyRead" } ] }, "unitSharesNotZeroRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfUnitRead" } ] }, "unitSharesNotNullRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfUnitRead" } ] }, "unitsWithoutOwnersRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfUnitRead" } ] }, "unitsNotEligibleInResolutionsRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfUnitRead" } ] }, "resolutionsInCollectionRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfResolutionRead" } ] }, "unitHasContractsRule": { "allOf": [ { "$ref": "#/components/schemas/ChecklistRuleOfUnitRead" } ] } }, "additionalProperties": false }, "ConferenceDocumentCreateFromTemplate": { "required": [ "attachmentFileIds", "documentTemplateId" ], "type": "object", "properties": { "documentTemplateId": { "type": "integer", "format": "int32" }, "attachmentFileIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "ConferenceEventRead": { "required": [ "conferenceId", "description", "eventType", "id", "timeStamp" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "conferenceId": { "type": "integer", "format": "int32" }, "eventType": { "allOf": [ { "$ref": "#/components/schemas/ConferenceEventType" } ], "description": "Possible values:\n- 0 = ConferenceStarted\n- 1 = TopicSelected\n- 2 = PollSelected\n- 3 = VotingSessionStarted\n- 4 = VotingSessionEnded\n- 5 = ParticipantJoinedOnline\n- 6 = OnlineParticipantLeft\n- 7 = ParticipantJoinedOnsite\n- 8 = OnsiteParticipantLeft\n- 9 = ConferenceEnded\n- 10 = RepresentationRecorded\n- 11 = RepresentationChanged\n- 12 = RepresentationRemoved" }, "timeStamp": { "type": "string", "format": "date-time" }, "description": { "type": "string" } }, "additionalProperties": false }, "ConferenceEventType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "description": "Possible values:\n- 0 = ConferenceStarted\n- 1 = TopicSelected\n- 2 = PollSelected\n- 3 = VotingSessionStarted\n- 4 = VotingSessionEnded\n- 5 = ParticipantJoinedOnline\n- 6 = OnlineParticipantLeft\n- 7 = ParticipantJoinedOnsite\n- 8 = OnsiteParticipantLeft\n- 9 = ConferenceEnded\n- 10 = RepresentationRecorded\n- 11 = RepresentationChanged\n- 12 = RepresentationRemoved", "format": "int32" }, "ConferenceInterfaceRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ConferenceInvitationState": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Possible values:\n- 0 = NotYetCreated\n- 1 = Created\n- 2 = Failed", "format": "int32" }, "ConferenceRead": { "required": [ "completed", "creatorId", "date", "id", "interfaceId", "invitationState", "isSharedWithOwners", "propertyId", "state", "title" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "propertyManagementCompanyId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "title": { "type": "string" }, "location": { "type": "string", "nullable": true }, "additionalLocation": { "type": "string", "nullable": true }, "additionalInfo": { "type": "string", "nullable": true }, "room": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "creatorId": { "type": "integer", "format": "int32" }, "completed": { "type": "boolean" }, "interfaceId": { "type": "integer", "format": "int32" }, "accountableUnits": { "type": "integer", "format": "int32", "nullable": true }, "onlineManagerCount": { "type": "integer", "format": "int32", "nullable": true }, "onlineOwnerCount": { "type": "integer", "format": "int32", "nullable": true }, "onSitePresentationDescription": { "type": "string", "nullable": true }, "onSitePresentationTitleBackgroundColor": { "type": "string", "nullable": true }, "onSitePresentationBodyBackgroundColor": { "type": "string", "nullable": true }, "onSitePresentationTitleTextColor": { "type": "string", "nullable": true }, "onSitePresentationBodyTextColor": { "type": "string", "nullable": true }, "onSitePresentationImageId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32" }, "isSharedWithOwners": { "type": "boolean" }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "endedAt": { "type": "string", "format": "date-time", "nullable": true }, "invitationState": { "allOf": [ { "$ref": "#/components/schemas/ConferenceInvitationState" } ], "description": "Possible values:\n- 0 = NotYetCreated\n- 1 = Created\n- 2 = Failed" }, "invitationsCreatedAt": { "type": "string", "format": "date-time", "nullable": true }, "state": { "allOf": [ { "$ref": "#/components/schemas/ConferenceState" } ], "description": "Possible values:\n- 0 = InPreparation\n- 1 = InProgress\n- 2 = InReview\n- 3 = Completed\n- 4 = Errored" } }, "additionalProperties": false }, "ConferenceRole": { "required": [ "accountId", "conferenceId", "role" ], "type": "object", "properties": { "conferenceId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "role": { "allOf": [ { "$ref": "#/components/schemas/ConferenceRoleType" } ], "description": "Possible values:\n- 1 = Host\n- 2 = ProtocolWriter\n- 3 = Assistant\n- 4 = Observer" } }, "additionalProperties": false }, "ConferenceRoleType": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Possible values:\n- 1 = Host\n- 2 = ProtocolWriter\n- 3 = Assistant\n- 4 = Observer", "format": "int32" }, "ConferenceSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "completed": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ConferenceState": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "Possible values:\n- 0 = InPreparation\n- 1 = InProgress\n- 2 = InReview\n- 3 = Completed\n- 4 = Errored", "format": "int32" }, "ConferenceVoteRead": { "required": [ "decision", "id", "isOptionVote", "isRegularVote", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/VoteType" } ], "description": "Possible values:\n- 1 = MandateVote\n- 2 = ConferenceVote" }, "votingSessionId": { "type": "integer", "format": "int32", "nullable": true }, "votingGroupId": { "type": "integer", "format": "int32", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent" }, "isOptionVote": { "type": "boolean" }, "isRegularVote": { "type": "boolean" }, "ownerId": { "type": "integer", "format": "int32", "nullable": true }, "votedById": { "type": "integer", "format": "int32", "nullable": true }, "resolutionOptionId": { "type": "integer", "format": "int32", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConferenceVoteWrite": { "required": [ "decision", "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/VoteType" } ], "description": "Possible values:\n- 1 = MandateVote\n- 2 = ConferenceVote" }, "votingSessionId": { "type": "integer", "format": "int32", "nullable": true }, "votingGroupId": { "type": "integer", "format": "int32", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent" }, "ownerId": { "type": "integer", "format": "int32", "nullable": true }, "votedById": { "type": "integer", "format": "int32", "nullable": true }, "resolutionOptionId": { "type": "integer", "format": "int32", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConferenceWrite": { "required": [ "completed", "creatorId", "date", "interfaceId", "invitationState", "isSharedWithOwners", "propertyId", "state", "title" ], "type": "object", "properties": { "creatorId": { "type": "integer", "format": "int32" }, "interfaceId": { "type": "integer", "format": "int32" }, "propertyId": { "type": "integer", "format": "int32" }, "title": { "maxLength": 255, "type": "string" }, "date": { "type": "string", "format": "date-time" }, "location": { "maxLength": 255, "type": "string", "nullable": true }, "additionalLocation": { "type": "string", "nullable": true }, "additionalInfo": { "type": "string", "nullable": true }, "room": { "maxLength": 255, "type": "string", "nullable": true }, "accountableUnits": { "type": "integer", "format": "int32", "nullable": true }, "onSitePresentationDescription": { "type": "string", "nullable": true }, "onSitePresentationTitleBackgroundColor": { "type": "string", "nullable": true }, "onSitePresentationBodyBackgroundColor": { "type": "string", "nullable": true }, "onSitePresentationTitleTextColor": { "type": "string", "nullable": true }, "onSitePresentationBodyTextColor": { "type": "string", "nullable": true }, "onSitePresentationImageId": { "type": "integer", "format": "int32", "nullable": true }, "isSharedWithOwners": { "type": "boolean" }, "invitationState": { "allOf": [ { "$ref": "#/components/schemas/ConferenceInvitationState" } ], "description": "Possible values:\n- 0 = NotYetCreated\n- 1 = Created\n- 2 = Failed" }, "state": { "allOf": [ { "$ref": "#/components/schemas/ConferenceState" } ], "description": "Possible values:\n- 0 = InPreparation\n- 1 = InProgress\n- 2 = InReview\n- 3 = Completed\n- 4 = Errored" }, "completed": { "type": "boolean" }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "endedAt": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConnectRead": { "required": [ "debugMode", "erpSystemId", "id", "initialSync", "partyId", "shouldExport", "shouldImport" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "erpSystemId": { "type": "integer", "format": "int32" }, "partyId": { "type": "integer", "format": "int32" }, "version": { "type": "string", "nullable": true }, "lastMasterDataWereSyncedAt": { "type": "string", "format": "date-time", "nullable": true }, "shouldSyncMasterData": { "type": "boolean", "nullable": true }, "shouldImportProcesses": { "type": "boolean", "nullable": true }, "shouldExportProcesses": { "type": "boolean", "nullable": true }, "shouldSyncDocuments": { "type": "boolean", "nullable": true }, "immediateSync": { "type": "boolean", "nullable": true }, "environment": { "type": "string", "nullable": true }, "externalApiToken": { "type": "string", "nullable": true }, "externalInitialAccount": { "type": "string", "nullable": true }, "externalHost": { "type": "string", "nullable": true }, "externalUsername": { "type": "string", "nullable": true }, "externalPassword": { "type": "string", "nullable": true }, "shouldImport": { "type": "boolean" }, "shouldExport": { "type": "boolean" }, "configuration": { "type": "string", "nullable": true }, "debugMode": { "type": "boolean" }, "serverAccessDescription": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "initialSync": { "type": "boolean" } }, "additionalProperties": false }, "ConnectSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "erpSystemId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ConnectWrite": { "type": "object", "properties": { "lastMasterDataWereSyncedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ConsumptionBrandRead": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" } }, "additionalProperties": false }, "ConsumptionMeterAccessibleRequest": { "type": "object", "properties": { "consumptionMeterIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "List of ConsumptionMeter IDs to get meter assigned reader parties for.", "nullable": true }, "partyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "List of Party IDs to get reader assigned consumption meters for.", "nullable": true } }, "additionalProperties": false }, "ConsumptionMeterAssignedReaderParty": { "required": [ "consumptionMeterId", "partyId" ], "type": "object", "properties": { "consumptionMeterId": { "type": "integer", "description": "The ID of the consumption meter.", "format": "int32" }, "partyId": { "type": "integer", "description": "The assigned reader party ID of the consumption meter.", "format": "int32" } }, "additionalProperties": false }, "ConsumptionMeterLevelType": { "enum": [ 1, 2 ], "type": "integer", "description": "Possible values:\n- 1 = Property\n- 2 = Unit", "format": "int32" }, "ConsumptionMeterRead": { "required": [ "creatorPartyId", "excludeExport", "id", "tenantId", "typeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "creatorPartyId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "meteredPropertyId": { "type": "integer", "format": "int32", "nullable": true }, "meteredUnitId": { "type": "integer", "format": "int32", "nullable": true }, "brandId": { "type": "integer", "format": "int32", "nullable": true }, "providerPartyId": { "type": "integer", "format": "int32", "nullable": true }, "officialMeteringPointId": { "type": "string", "nullable": true }, "excludeExport": { "type": "boolean" }, "unitOfMeasure": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "initialValue": { "type": "string", "nullable": true }, "nextReadingDate": { "type": "string", "format": "date-time", "nullable": true }, "notificationDate": { "type": "string", "format": "date-time", "nullable": true }, "deviceId": { "type": "string", "nullable": true }, "edited": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsumptionMeterSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the ConsumptionMeter's OfficialMeteringPointId, Number, Location, and DeviceId.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "tenantId": { "type": "integer", "description": "Filters meters by the tenant, use this to retrieve meters associated with a specific tenant.\nExample: `11`.", "format": "int32", "nullable": true }, "meteredPropertyId": { "type": "integer", "description": "Filters meters by the property, use this to retrieve meters linked to a specific property.\nExample: `10`.", "format": "int32", "nullable": true }, "meteredUnitId": { "type": "integer", "description": "Filters meters by the unit, use this to retrieve meters associated with a specific unit.\nExample: `111`.", "format": "int32", "nullable": true }, "typeId": { "type": "integer", "description": "Filters meters by the meter type, such as Kaltwasserzähler or Gaszähler.\nThe Consumption name comes from the `ConsumpType` entity.", "format": "int32", "nullable": true }, "providerPartyId": { "type": "integer", "description": "Filters meters by the ID of the provider.\nExample: `111`.", "format": "int32", "nullable": true }, "accessibleByPartyId": { "type": "integer", "description": "Filters meters that are accessible by a certain party.\nExample: `32`.", "format": "int32", "nullable": true }, "isAccessibleByPartyEmpty": { "type": "boolean", "description": "Filters meters based on whether there are accessible parties at all. Set to `true` to retrieve meters with no accessible parties, and to `false` to retrieve meters with at least one accessible party set.\nExample: `false`.", "nullable": true }, "nextReadingDateBefore": { "type": "string", "description": "Filters meters with the next reading date on or before the specified date. Format: YYYY-MM-DD.\nExample: `2025-12-31`.", "format": "date-time", "nullable": true }, "nextReadingDateAfter": { "type": "string", "description": "Filters meters with the next reading date on or after the specified date. Format: YYYY-MM-DD.\nExample: `2025-12-31`.", "format": "date-time", "nullable": true }, "isNextReadingDateEmpty": { "type": "boolean", "description": "Filters meters based on whether the next reading date is empty. Set to `true` to retrieve meters with no next reading date, and to `false` to retrieve meters with a next reading date set.\nExample: `false`.", "nullable": true }, "isNextReadingDateInFutureOrEmpty": { "type": "boolean", "description": "Filters meters based on whether the next reading date is empty or reading date is in the future.\nExample: `false`.", "nullable": true, "deprecated": true }, "hasReadings": { "type": "boolean", "description": "Filters meters which do have readings.\nExample: `true`.", "nullable": true }, "notificationDateBefore": { "type": "string", "description": "Filters meters with the notification date on or before the specified date. Format: YYYY-MM-DD.\nExample: `2025-12-31`.", "format": "date-time", "nullable": true }, "notificationDateAfter": { "type": "string", "description": "Filters meters with the notification date on or after the specified date. Format: YYYY-MM-DD.\nExample: `2025-12-31`.", "format": "date-time", "nullable": true }, "isNotificationDateEmpty": { "type": "boolean", "description": "Filters meters based on whether the notification date is empty. Set to `true` to retrieve meters with no notification date, and to `false` to retrieve meters with a notification date set.\nExample: `false`.", "nullable": true }, "consumptionMeterLevel": { "allOf": [ { "$ref": "#/components/schemas/ConsumptionMeterLevelType" } ], "description": "Filters list of meters associated with properties or units since a meter is connected to either a property or a unit.\nExample: Use `1` for all property meters or `2` for all unit meters. If the attribute is not passed in search request, all the meters will be returned.\n\nPossible values:\n- 1 = Property\n- 2 = Unit", "nullable": true }, "isArchived": { "type": "boolean", "description": "Filters meters by their property / unit archived status.\nPossible values: `null` (all), `true` (only archived), or `false` (only non-archived).", "nullable": true } }, "additionalProperties": false, "description": "Represents a search request for filtering and sorting consumption meters based on various criteria. The default sorting is ascending by entity id.\nSorting can be applied using the format: {\"orderBy\": [\"attributename1 desc\", \"attributename2 asc\"]} or {\"orderBy\": [\"attributename\"]}.\nIf the sorting order is not provided or entered anything but `desc`, fallback order is ascending.\nOrderByNextReadingDate: Sorts the meter list by the next scheduled reading date, {\"orderBy\": [\"nextreadingdate desc\"]}.\nIn case we are sorting by attributes that are related to another entity, then we use format {\"orderBy\": [\"relatedentity.sortingcolumname asc\"]}.\nOrderByPropertyAddress: Sorts the meter list by property address (first by street, then by city), {\"orderBy\": [\"meteredproperty.fullstreet asc\"]}.\nOrderByProjectName: Sorts the meter list by project name, {\"orderBy\": [\"tenant.title desc\"]}.\nOrderByMeter: Sorts the meter list first by meter type (e.g., Kaltwasserzähler/Gaszähler) and then by meter number (e.g., 'CA-123'), { \"orderBy\": [\"type.metername desc\"]}.\nOrderByLastReadingDate: Sorts the meter list by the most recent recorded reading date using {\"orderBy\": [\"readings.max(readingdate) asc\"]}.\nSince this includes a one-to-many (1:n) relationship, the sorting is applied first on the related entity (readings), followed by the main entity (meter)." }, "ConsumptionReadingDate": { "required": [ "month", "numberOfReadings", "year" ], "type": "object", "properties": { "month": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "numberOfReadings": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ConsumptionReadingDateSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "onlyForMeteredUnits": { "type": "boolean", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ConsumptionReadingExtended": { "required": [ "consumptionMeterId", "id", "readerAccountId", "readingDate", "wasChecked", "wasDelivered" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "consumptionMeterId": { "type": "integer", "format": "int32" }, "consumerPartyId": { "type": "integer", "format": "int32", "nullable": true }, "readerAccountId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32", "nullable": true }, "currentValue": { "type": "number", "format": "double", "nullable": true }, "averageReferenceValue": { "type": "number", "format": "double", "nullable": true }, "currentValueInDifferentUnitOfMeasure": { "type": "number", "format": "double", "nullable": true }, "averageReferenceValueInDifferentUnitOfMeasure": { "type": "number", "format": "double", "nullable": true }, "readingDate": { "type": "string", "format": "date-time" }, "isEstimated": { "type": "boolean", "nullable": true }, "wasChecked": { "type": "boolean" }, "checkedByAccountId": { "type": "integer", "format": "int32", "nullable": true }, "checkDate": { "type": "string", "format": "date-time", "nullable": true }, "wasDelivered": { "type": "boolean" }, "scheduledDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "executedDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "costs": { "type": "number", "format": "double", "nullable": true }, "edited": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "valuePercentageDifferenceToLastYear": { "type": "number", "format": "double", "nullable": true }, "costPercentageDifferenceToLastYear": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ConsumptionReadingRead": { "required": [ "consumptionMeterId", "id", "readerAccountId", "readingDate", "wasChecked", "wasDelivered" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "consumptionMeterId": { "type": "integer", "format": "int32" }, "consumerPartyId": { "type": "integer", "format": "int32", "nullable": true }, "readerAccountId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32", "nullable": true }, "currentValue": { "type": "number", "format": "double", "nullable": true }, "averageReferenceValue": { "type": "number", "format": "double", "nullable": true }, "currentValueInDifferentUnitOfMeasure": { "type": "number", "format": "double", "nullable": true }, "averageReferenceValueInDifferentUnitOfMeasure": { "type": "number", "format": "double", "nullable": true }, "readingDate": { "type": "string", "format": "date-time" }, "isEstimated": { "type": "boolean", "nullable": true }, "wasChecked": { "type": "boolean" }, "checkedByAccountId": { "type": "integer", "format": "int32", "nullable": true }, "checkDate": { "type": "string", "format": "date-time", "nullable": true }, "wasDelivered": { "type": "boolean" }, "scheduledDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "executedDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "costs": { "type": "number", "format": "double", "nullable": true }, "edited": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConsumptionReadingSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "dates": { "type": "array", "items": { "type": "string" }, "description": "Filters based on the reading dates year and month.\nDates can be provided in this format `2026-08`, or just `2026`.\nThis is not an interval filter, it will explicitly check each given month/year.", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "consumptionMeterId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ConsumptionReadingWrite": { "required": [ "consumptionMeterId", "currentValue", "fileId" ], "type": "object", "properties": { "consumptionMeterId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32" }, "currentValue": { "minimum": 0, "exclusiveMinimum": true, "type": "number", "format": "double" } }, "additionalProperties": false }, "ConsumptionTypeRead": { "required": [ "id", "style", "utilityName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "meterName": { "type": "string", "nullable": true }, "utilityName": { "type": "string" }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "style": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactDetailsRead": { "required": [ "areBillingDetails", "contactTypeId", "id", "partyId", "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32" }, "contactTypeId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "areBillingDetails": { "type": "boolean" }, "snapshotForWorkOrderId": { "type": "integer", "format": "int32", "nullable": true }, "snapshotForProcessId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ContactDetailsSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the ContactDetails's Value (ignoring white spaces).", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "partyId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filters contact details by the owning party.\nWhen set, only contact details belonging to the specified parties are returned.\nAccepts a list of ids (matched with OR) as well as a single id.", "nullable": true }, "contactTypeId": { "type": "integer", "description": "Filters contact details by contact type.\nCorresponds to `ContactTypeId` on the contact details entity.", "format": "int32", "nullable": true }, "includeSnapshots": { "type": "boolean", "description": "Determines whether snapshot entries should be included in the result.\n`true`: Includes snapshot contact details (e.g. linked to processes or work orders).\n`false` or `null`: Only current (non-snapshot) contact details are returned.", "nullable": true }, "areBillingDetails": { "type": "boolean", "description": "Filters contact details by billing relevance.\nWhen set, only contact details matching the given billing flag are returned.", "nullable": true } }, "additionalProperties": false }, "ContactDetailsWrite": { "required": [ "areBillingDetails", "contactTypeId", "partyId", "value" ], "type": "object", "properties": { "partyId": { "type": "integer", "format": "int32" }, "contactTypeId": { "type": "integer", "format": "int32" }, "value": { "maxLength": 255, "minLength": 1, "type": "string" }, "areBillingDetails": { "type": "boolean" } }, "additionalProperties": false }, "ContactTypeRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CreateChalllengeRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "additionalProperties": false }, "CustomerAppCustomContentRead": { "required": [ "id", "propertyManagementCompanyId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "propertyManagementCompanyId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CustomerAppDocumentSortOption": { "enum": [ 0, 1 ], "type": "integer", "description": "Possible values:\n- 0 = ByDate\n- 1 = ByName", "format": "int32" }, "CustomerAppRead": { "required": [ "documentSortOption", "id", "isCustomerForbiddenToAddCustomers", "isCustomerForbiddenToInviteCustomers", "isDocumentNameInDocumentDescription", "isIosAppSetupForDeployment", "isPropertyRoleContactInformationHidden", "isUsingOwnTerms" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "isUsingOwnTerms": { "type": "boolean" }, "termsText": { "type": "string", "nullable": true }, "termsUrl": { "type": "string", "nullable": true }, "privacyUrl": { "type": "string", "nullable": true }, "imprintUrl": { "type": "string", "nullable": true }, "isDocumentNameInDocumentDescription": { "type": "boolean" }, "isPropertyRoleContactInformationHidden": { "type": "boolean" }, "documentSortOption": { "allOf": [ { "$ref": "#/components/schemas/CustomerAppDocumentSortOption" } ], "description": "Possible values:\n- 0 = ByDate\n- 1 = ByName" }, "isCustomerForbiddenToAddCustomers": { "type": "boolean" }, "isCustomerForbiddenToInviteCustomers": { "type": "boolean" }, "primaryColor": { "type": "string", "nullable": true }, "secondaryColor": { "type": "string", "nullable": true }, "tertiaryColor": { "type": "string", "nullable": true }, "appleIssuerId": { "type": "string", "nullable": true }, "iosBundleId": { "type": "string", "nullable": true }, "iosAppId": { "type": "string", "nullable": true }, "iosTeamId": { "type": "string", "nullable": true }, "iosPushKeyFile": { "type": "string", "nullable": true }, "iosPushKeyId": { "type": "string", "nullable": true }, "iosVersion": { "type": "string", "nullable": true }, "iosExpirationDate": { "type": "string", "format": "date-time", "nullable": true }, "isIosAppSetupForDeployment": { "type": "boolean" }, "androidVersion": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomerAppStartupConfiguration": { "required": [ "allowAllCustomers", "documentSortOption", "id", "isAndroidDownloadable", "isCustomerForbiddenToAddCustomers", "isCustomerForbiddenToInviteCustomers", "isDocumentNameInDocumentDescription", "isEnvironmentModeActive", "isPropertyRoleContactInformationHidden", "isUsingOwnTerms", "propertyManagementCompanyId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "appName": { "type": "string", "nullable": true }, "propertyManagementCompanyName": { "type": "string", "nullable": true }, "propertyManagementCompanyId": { "type": "integer", "format": "int32" }, "propertyManagementCompanyLogoId": { "type": "integer", "format": "int32", "nullable": true }, "isUsingOwnTerms": { "type": "boolean" }, "termsText": { "type": "string", "nullable": true }, "termsUrl": { "type": "string", "nullable": true }, "privacyUrl": { "type": "string", "nullable": true }, "imprintUrl": { "type": "string", "nullable": true }, "isEnvironmentModeActive": { "type": "boolean" }, "isDocumentNameInDocumentDescription": { "type": "boolean" }, "isPropertyRoleContactInformationHidden": { "type": "boolean" }, "documentSortOption": { "allOf": [ { "$ref": "#/components/schemas/CustomerAppDocumentSortOption" } ], "description": "Possible values:\n- 0 = ByDate\n- 1 = ByName" }, "isCustomerForbiddenToAddCustomers": { "type": "boolean" }, "isCustomerForbiddenToInviteCustomers": { "type": "boolean" }, "primaryColor": { "type": "string", "nullable": true }, "secondaryColor": { "type": "string", "nullable": true }, "tertiaryColor": { "type": "string", "nullable": true }, "iosVersion": { "type": "string", "nullable": true }, "iosBundleId": { "type": "string", "nullable": true }, "iosAppId": { "type": "string", "nullable": true }, "androidVersion": { "type": "string", "nullable": true }, "androidBundleId": { "type": "string", "nullable": true }, "isAndroidDownloadable": { "type": "boolean" }, "androidApkFileDownloadUrl": { "type": "string", "nullable": true }, "allowAllCustomers": { "type": "boolean" }, "logoDownloadUrl": { "type": "string", "nullable": true }, "splashScreenDownloadUrl": { "type": "string", "nullable": true }, "hideConsumptionReadingsCosts": { "type": "boolean", "nullable": true }, "domain": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DecisionTypeOfVote": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent", "format": "int32" }, "DecisionTypeOfVotingSession": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Possible values:\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option", "format": "int32" }, "DetailedUnitRead": { "required": [ "entranceId", "hasOwners", "hasTenants", "holdingTypeId", "id", "typeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "holdingTypeId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true }, "entranceId": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean", "nullable": true }, "squareMeters": { "type": "number", "format": "double", "nullable": true }, "roomCount": { "type": "number", "format": "double", "nullable": true }, "rentReduction": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "externalIdOld": { "type": "string", "nullable": true }, "hasOwners": { "type": "boolean" }, "hasTenants": { "type": "boolean" } }, "additionalProperties": false }, "DocumentBackgroundJobCreate": { "required": [ "conferenceId", "documentTemplateId" ], "type": "object", "properties": { "conferenceId": { "type": "integer", "format": "int32" }, "documentTemplateId": { "type": "integer", "format": "int32" }, "previewFileId": { "type": "integer", "format": "int32", "nullable": true }, "votingGroupId": { "type": "integer", "format": "int32", "nullable": true }, "preview": { "type": "boolean", "nullable": true }, "attachmentFileIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "DocumentBackgroundJobRead": { "required": [ "conferenceId", "creationState", "documentTemplateId", "id", "preview" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "conferenceId": { "type": "integer", "format": "int32" }, "createdByAccountId": { "type": "integer", "format": "int32", "nullable": true }, "previewFileId": { "type": "integer", "format": "int32", "nullable": true }, "votingGroupId": { "type": "integer", "format": "int32", "nullable": true }, "documentTemplateId": { "type": "integer", "format": "int32" }, "preview": { "type": "boolean" }, "creationState": { "allOf": [ { "$ref": "#/components/schemas/DocumentCreationState" } ], "description": "Possible values:\n- 0 = Ready\n- 1 = Scheduled\n- 2 = Creating\n- 3 = Created\n- 4 = Errored" }, "creationStartedAt": { "type": "string", "format": "date-time", "nullable": true }, "documentCreatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DocumentCreationState": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "Possible values:\n- 0 = Ready\n- 1 = Scheduled\n- 2 = Creating\n- 3 = Created\n- 4 = Errored", "format": "int32" }, "DocumentGroupRead": { "required": [ "id", "isHidden", "isSharedWithBoard", "isSharedWithOwners", "isSharedWithTenants", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "isSharedWithTenants": { "type": "boolean" }, "isSharedWithOwners": { "type": "boolean" }, "isSharedWithBoard": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DocumentGroupSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the DocumentGroup's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "isRoot": { "type": "boolean", "description": "Has no parent document group.", "nullable": true }, "parentId": { "type": "integer", "description": "Retrieve all direct children of this group id.", "format": "int32", "nullable": true }, "anyParentId": { "type": "integer", "description": "Retrieve all descendants of this group id.", "format": "int32", "nullable": true }, "childId": { "type": "integer", "description": "Retrieve all direct parents of this group id.", "format": "int32", "nullable": true }, "anyChildId": { "type": "integer", "description": "Retrieve all ancestor this group id.", "format": "int32", "nullable": true }, "wasRead": { "type": "boolean", "description": "Based on contained documents and requesters read state.", "nullable": true }, "propertyId": { "type": "integer", "description": "Based on contained documents.", "format": "int32", "nullable": true }, "entranceId": { "type": "integer", "description": "Based on contained documents.", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "description": "Based on contained documents.", "format": "int32", "nullable": true }, "contractId": { "type": "integer", "description": "Based on contained documents.", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "description": "Based on contained documents.", "format": "int32", "nullable": true }, "isSharedForParty": { "type": "boolean", "description": "Filters for document groups that have documents directly attached to a party (it doesn't have to be the requesters party).", "nullable": true }, "fileTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "dateAfter": { "type": "string", "format": "date-time", "nullable": true }, "dateBefore": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentGroupWrite": { "required": [ "isHidden", "isSharedWithBoard", "isSharedWithOwners", "isSharedWithTenants", "name" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "isSharedWithTenants": { "type": "boolean" }, "isSharedWithOwners": { "type": "boolean" }, "isSharedWithBoard": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true }, "parentId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DocumentRead": { "required": [ "createdByAccountId", "fileId", "id", "isSharedForContract", "isSharedForParty", "isSharedForProperty", "isSharedForUnit" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "title": { "type": "string", "description": "The title of the document.", "nullable": true }, "description": { "type": "string", "description": "Optional description providing additional context or explanation for the document.", "nullable": true }, "groupId": { "type": "integer", "description": "Identifier of the document group used for categorization.\nIf the value is `null`, documents are considered as placed at root-level.", "format": "int32", "nullable": true }, "date": { "type": "string", "description": "Business-related date of the document (e.g. issue date or effective date).", "format": "date-time", "nullable": true }, "propertyId": { "type": "integer", "description": "Identifier of the property this document is associated with.\nAt least one assignment target must be specified.", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "description": "Identifier of the unit this document is associated with.\nAt least one assignment target must be specified.", "format": "int32", "nullable": true }, "contractId": { "type": "integer", "description": "Identifier of the contract this document is associated with.\nAt least one assignment target must be specified.", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "description": "Identifier of the party this document is associated with.\nThis doesn't imply immediate access to the document for this party.\nAt least one assignment target must be specified.", "format": "int32", "nullable": true }, "fileId": { "type": "integer", "description": "Identifier of the file entity containing the document content.", "format": "int32" }, "isSharedForProperty": { "type": "boolean", "deprecated": true }, "isSharedForUnit": { "type": "boolean", "deprecated": true }, "isSharedForContract": { "type": "boolean", "deprecated": true }, "isSharedForParty": { "type": "boolean", "deprecated": true }, "createdByPartyId": { "type": "integer", "description": "Identifier of the party that created the document.", "format": "int32", "nullable": true }, "createdByPropertyManagementCompanyId": { "type": "integer", "description": "Deprecated alias for `CreatedByPartyId`.", "format": "int32", "nullable": true, "deprecated": true }, "createdByAccountId": { "type": "integer", "description": "Identifier of the account that created the document.", "format": "int32" }, "externalId": { "type": "string", "description": "Optional identifier linking the document to an external system.", "nullable": true } }, "additionalProperties": false }, "DocumentSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Document's Title and Description.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "documentGroupId": { "type": "integer", "description": "Is direct child of this document group.", "format": "int32", "nullable": true }, "anyParentDocumentGroupId": { "type": "integer", "description": "Is descendant of this document group.", "format": "int32", "nullable": true }, "wasRead": { "type": "boolean", "description": "Based requesters read state.", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "entranceId": { "type": "integer", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "contractId": { "type": "integer", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "isSharedForParty": { "type": "boolean", "description": "Filters for documents directly attached to a party (it doesn't have to be the requesters party).", "nullable": true }, "fileTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "dateAfter": { "type": "string", "format": "date-time", "nullable": true }, "dateBefore": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DocumentSettingsRead": { "required": [ "id", "interfaceId", "printResolutionsOnMandates", "printResolutionTextsOnAgenda", "printResolutionTitlesOnAgenda", "printTopicDescriptionsOnProtocol", "printTopicTitlesOnProtocol", "protocolResultTextSize", "usePlannedStartTime" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "interfaceId": { "type": "integer", "format": "int32" }, "protocolTopicTitleFont": { "type": "string", "nullable": true }, "protocolTopicTitleSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolTopicDescriptionFont": { "type": "string", "nullable": true }, "protocolTopicDescriptionSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolResolutionTitleFont": { "type": "string", "nullable": true }, "protocolResolutionTitleSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolResolutionTextFont": { "type": "string", "nullable": true }, "protocolResolutionTextSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolInfoTextFont": { "type": "string", "nullable": true }, "protocolInfoTextSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolResultTextFont": { "type": "string", "nullable": true }, "protocolResultTextSize": { "type": "integer", "format": "int32" }, "printConferenceDetailsOnProtocol": { "type": "boolean", "nullable": true }, "printConferenceResultsOnProtocol": { "type": "boolean", "nullable": true }, "printTopicTitlesOnProtocol": { "type": "boolean" }, "printTopicDescriptionsOnProtocol": { "type": "boolean" }, "usePlannedStartTime": { "type": "boolean" }, "agendaTopicTitleFont": { "type": "string", "nullable": true }, "agendaTopicTitleSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaTopicDescriptionFont": { "type": "string", "nullable": true }, "agendaTopicDescriptionSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaResolutionTitleFont": { "type": "string", "nullable": true }, "agendaResolutionTitleSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaResolutionTextFont": { "type": "string", "nullable": true }, "agendaResolutionTextSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaInfoTextFont": { "type": "string", "nullable": true }, "agendaInfoTextSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaResultTextFont": { "type": "string", "nullable": true }, "agendaResultTextSize": { "type": "integer", "format": "int32", "nullable": true }, "printConferenceDetailsOnAgenda": { "type": "boolean", "nullable": true }, "printResolutionTitlesOnAgenda": { "type": "boolean" }, "printResolutionTextsOnAgenda": { "type": "boolean" }, "printResolutionsOnMandates": { "type": "boolean" } }, "additionalProperties": false }, "DocumentSettingsWrite": { "required": [ "interfaceId", "printResolutionsOnMandates", "printResolutionTextsOnAgenda", "printResolutionTitlesOnAgenda", "printTopicDescriptionsOnProtocol", "printTopicTitlesOnProtocol", "protocolResultTextSize", "usePlannedStartTime" ], "type": "object", "properties": { "interfaceId": { "type": "integer", "format": "int32" }, "protocolTopicTitleFont": { "type": "string", "nullable": true }, "protocolTopicTitleSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolTopicDescriptionFont": { "type": "string", "nullable": true }, "protocolTopicDescriptionSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolResolutionTitleFont": { "type": "string", "nullable": true }, "protocolResolutionTitleSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolResolutionTextFont": { "type": "string", "nullable": true }, "protocolResolutionTextSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolInfoTextFont": { "type": "string", "nullable": true }, "protocolInfoTextSize": { "type": "integer", "format": "int32", "nullable": true }, "protocolResultTextFont": { "type": "string", "nullable": true }, "protocolResultTextSize": { "type": "integer", "format": "int32" }, "printConferenceDetailsOnProtocol": { "type": "boolean", "nullable": true }, "printConferenceResultsOnProtocol": { "type": "boolean", "nullable": true }, "printTopicTitlesOnProtocol": { "type": "boolean" }, "printTopicDescriptionsOnProtocol": { "type": "boolean" }, "usePlannedStartTime": { "type": "boolean" }, "agendaTopicTitleFont": { "type": "string", "nullable": true }, "agendaTopicTitleSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaTopicDescriptionFont": { "type": "string", "nullable": true }, "agendaTopicDescriptionSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaResolutionTitleFont": { "type": "string", "nullable": true }, "agendaResolutionTitleSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaResolutionTextFont": { "type": "string", "nullable": true }, "agendaResolutionTextSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaInfoTextFont": { "type": "string", "nullable": true }, "agendaInfoTextSize": { "type": "integer", "format": "int32", "nullable": true }, "agendaResultTextFont": { "type": "string", "nullable": true }, "agendaResultTextSize": { "type": "integer", "format": "int32", "nullable": true }, "printConferenceDetailsOnAgenda": { "type": "boolean", "nullable": true }, "printResolutionTitlesOnAgenda": { "type": "boolean" }, "printResolutionTextsOnAgenda": { "type": "boolean" }, "printResolutionsOnMandates": { "type": "boolean" } }, "additionalProperties": false }, "DocumentShareRead": { "required": [ "documentId", "id", "partyId", "wasRead", "wasSent" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "documentId": { "type": "integer", "description": "Identifier of the shared document.", "format": "int32" }, "partyId": { "type": "integer", "description": "Identifier of the party receiving access to the document.", "format": "int32" }, "wasRead": { "type": "boolean", "description": "Indicates whether the receiving party has read or acknowledged the document." }, "readAt": { "type": "string", "description": "Timestamp when the document was read by the party.\nNull if the document has not yet been read.", "format": "date-time", "nullable": true }, "wasSent": { "type": "boolean", "description": "Indicates whether a notification about the document share has been sent\n(e.g., email, push notification, or letter)." }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DocumentShareSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "wasRead": { "type": "boolean", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "documentId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DocumentShareWrite": { "required": [ "documentId", "partyId", "wasRead", "wasSent" ], "type": "object", "properties": { "documentId": { "type": "integer", "description": "Identifier of the shared document.\nCan only be set during creation.\nA document can only be shared once per party.", "format": "int32" }, "partyId": { "type": "integer", "description": "Identifier of the party receiving access to the document.\nCan only be set during creation.\nA document can only be shared once per party.", "format": "int32" }, "wasRead": { "type": "boolean", "description": "Indicates whether the receiving party has read or acknowledged the document." }, "wasSent": { "type": "boolean", "description": "Indicates whether a notification about the document share has been sent\n(e.g. email, push notification or letter)." } }, "additionalProperties": false }, "DocumentTemplateRead": { "required": [ "documentGroupId", "hasAttachments", "id", "interfaceId", "name", "recipientMode", "template", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "interfaceId": { "type": "integer", "description": "The Id of the associated ConferenceInterface.", "format": "int32" }, "type": { "allOf": [ { "$ref": "#/components/schemas/DocumentTemplateType" } ], "description": "Describes for which type of document this entity is a template for..\n\nPossible values:\n- 0 = Mandate\n- 1 = CoverLetter\n- 2 = Agenda\n- 3 = Protocol" }, "recipientMode": { "allOf": [ { "$ref": "#/components/schemas/DocumentTemplateRecipientMode" } ], "description": "Describes whether the Document will be created per Party or per VotingGroup, if applicable for the type.\n\nPossible values:\n- 0 = VotingGroup\n- 1 = Party" }, "documentGroupId": { "type": "integer", "description": "The Id of the associated DocumentGroup.", "format": "int32" }, "template": { "type": "string", "description": "The html content of the template." }, "hasAttachments": { "type": "boolean", "description": "Describes whether the template gives the possibility to add attachments." }, "previewFileId": { "type": "integer", "description": "The Id of the associated File, which is the last generated preview.", "format": "int32", "nullable": true }, "name": { "type": "string", "description": "The name of the template." }, "fileName": { "type": "string", "description": "The name of the file that is generated from this template. It may contain placeholders.", "nullable": true } }, "additionalProperties": false }, "DocumentTemplateRecipientMode": { "enum": [ 0, 1 ], "type": "integer", "description": "Possible values:\n- 0 = VotingGroup\n- 1 = Party", "format": "int32" }, "DocumentTemplateSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "type": { "allOf": [ { "$ref": "#/components/schemas/DocumentTemplateType" } ], "description": "Possible values:\n- 0 = Mandate\n- 1 = CoverLetter\n- 2 = Agenda\n- 3 = Protocol", "nullable": true } }, "additionalProperties": false }, "DocumentTemplateType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Possible values:\n- 0 = Mandate\n- 1 = CoverLetter\n- 2 = Agenda\n- 3 = Protocol", "format": "int32" }, "DocumentTemplateWrite": { "required": [ "documentGroupId", "interfaceId", "name", "recipientMode", "template", "type" ], "type": "object", "properties": { "interfaceId": { "type": "integer", "description": "The Id of the associated ConferenceInterface.", "format": "int32" }, "type": { "allOf": [ { "$ref": "#/components/schemas/DocumentTemplateType" } ], "description": "Describes for which type of document this entity is a template for..\n\nPossible values:\n- 0 = Mandate\n- 1 = CoverLetter\n- 2 = Agenda\n- 3 = Protocol" }, "documentGroupId": { "type": "integer", "description": "The Id of the associated DocumentGroup.", "format": "int32" }, "template": { "minLength": 1, "type": "string", "description": "The html content of the template." }, "recipientMode": { "allOf": [ { "$ref": "#/components/schemas/DocumentTemplateRecipientMode" } ], "description": "Describes whether the Document will be created per Party or per VotingGroup, if applicable for the type.\n\nPossible values:\n- 0 = VotingGroup\n- 1 = Party" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The name of the template." }, "fileName": { "maxLength": 255, "type": "string", "description": "The name of the file that is generated from this template. It may contain placeholders.", "nullable": true } }, "additionalProperties": false }, "DocumentWrite": { "required": [ "fileId", "title" ], "type": "object", "properties": { "title": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Title of the document." }, "description": { "type": "string", "description": "Optional description providing additional information about the document.", "nullable": true }, "groupId": { "type": "integer", "description": "Identifier of the document group used for categorization.\nDocuments can also be placed at root-level, when leaving this field `null`.", "format": "int32", "nullable": true }, "date": { "type": "string", "description": "Business-related date of the document (e.g. issue date or effective date).", "format": "date-time", "nullable": true }, "propertyId": { "type": "integer", "description": "Identifier of the property this document is assigned to.\nAt least one of PropertyId, UnitId, ContractId or PartyId must be provided.", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "description": "Identifier of the unit this document is assigned to.\nAt least one of PropertyId, UnitId, ContractId or PartyId must be provided.", "format": "int32", "nullable": true }, "contractId": { "type": "integer", "description": "Identifier of the contract this document is assigned to.\nAt least one of PropertyId, UnitId, ContractId or PartyId must be provided.", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "description": "Identifier of the party this document is assigned to.\nThis doesn't imply immediate access to the document for this party.\nAt least one of PropertyId, UnitId, ContractId or PartyId must be provided.", "format": "int32", "nullable": true }, "fileId": { "type": "integer", "description": "Identifier of the file entity containing the document content.", "format": "int32" }, "externalId": { "type": "string", "description": "Optional identifier linking the document to an external system.", "nullable": true } }, "additionalProperties": false }, "EMailSenderSettingRead": { "required": [ "eMailSenderSettingTypeId", "id", "isHealthy", "isPartyAccount", "isPrimary" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "eMailSenderSettingTypeId": { "type": "integer", "description": "How the mailbox is connected. The type entity itself is not exposed, so the ids are:\n \n- `1` — Exchange (on-premise, via EWS)\n- `2` — IMAP\n- `3` — Office 365 (via Microsoft Graph)\n- `4` — POP3\n- `5` — sent through facilioo: no own mailbox is connected, facilioo's relay delivers. Legacy, it\ncannot be newly selected, but existing mailboxes still carry it\n- `6` — Googlemail (via the Gmail API)\n- `7` — SMTP: outbound only, for a mailbox facilioo must not read from\n \nNew types are still being added, so do not treat this list as complete.", "format": "int32" }, "partyId": { "type": "integer", "description": "Owning party. Set on every mailbox created through facilioo — both party-wide and personal ones are\ncreated against the acting party — so expect a value in practice.\n \n\nNullable only because the underlying column is: it has no NOT NULL constraint, so a mailbox\nimported or repaired outside the normal path can carry null. Treat null as \"ownership unknown\", not as a\nmeaningful state.", "format": "int32", "nullable": true, "example": 1234 }, "accountId": { "type": "integer", "description": "The account a personal mailbox belongs to. Only meaningful when `IsPartyAccount` is false:\nthat is the case where it decides who may use the mailbox. For a party-wide mailbox it is ignored — every\naccount of the party may use it regardless of what this says — and it usually still holds whoever set the\nmailbox up.\n \n\nNullable for the same reason as `PartyId`. It is not independent of it: a mailbox with\nan account but no party would be an inconsistent row, since an account always belongs to a party. If you\nsee one, treat it as unowned rather than as an account-only mailbox.", "format": "int32", "nullable": true, "example": 5678 }, "isPartyAccount": { "type": "boolean", "description": "True = party-wide mailbox (usable by any account of the party); false = personal to\n`AccountId`." }, "from": { "type": "string", "description": "The bare sender address, never a composed header: address and display name are stored separately and\nonly joined when the mail is handed to the mail server, so this holds\n`hausverwaltung@example.com` and not `Hausverwaltung Beispiel `.\n \n\nNot validated on write and nullable, so a half-configured mailbox can carry null, an empty string\nor a malformed address.", "nullable": true, "example": "hausverwaltung@example.com" }, "name": { "type": "string", "description": "Display name shown next to `From` in the recipient's client. Free text, may be null.", "nullable": true, "example": "Hausverwaltung Beispiel" }, "isPrimary": { "type": "boolean", "description": "True = this is the owner's primary/default outbound mailbox (\"Primäradresse\").\nOnly one mailbox per owner party is primary at a time." }, "isHealthy": { "type": "boolean", "description": "True = the mailbox's last connection check to the mail server succeeded; false = it is failing\nand is excluded from inbound import. Only flips to false after repeated consecutive failures." } }, "additionalProperties": false }, "EMailSenderSettingSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the mailbox From-address and display Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "partyId": { "type": "integer", "description": "Filters mailboxes by the owning party.", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "description": "Filters mailboxes by the owning account.", "format": "int32", "nullable": true }, "eMailSenderSettingTypeId": { "type": "integer", "description": "Filters mailboxes by mail-account type (IMAP/SMTP/Exchange/…).", "format": "int32", "nullable": true }, "isPartyAccount": { "type": "boolean", "description": "When set, restricts to company-wide (`true`) or personal (`false`) mailboxes.", "nullable": true }, "isPrimary": { "type": "boolean", "description": "When set, restricts to primary/default (`true`) or non-primary (`false`) mailboxes.", "nullable": true }, "isHealthy": { "type": "boolean", "description": "When set, restricts to healthy (`true`) or failing (`false`) mailboxes.", "nullable": true } }, "additionalProperties": false }, "EditorTextBlockRead": { "required": [ "creatorAccountId", "creatorPartyId", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "creatorAccountId": { "type": "integer", "format": "int32" }, "creatorPartyId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EditorTextBlockWrite": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntranceRead": { "required": [ "id", "isArchived", "isProperty", "propertyId", "unitsCount" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "number": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "propertyId": { "type": "integer", "format": "int32" }, "fullStreet": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isProperty": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean" }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "unitsCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EntranceSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Entrance's Name, Number, FullStreet, and City.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "externalId": { "type": "string", "nullable": true }, "unitIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "EntranceWrite": { "required": [ "name", "number", "propertyId" ], "type": "object", "properties": { "number": { "maxLength": 45, "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "propertyId": { "type": "integer", "format": "int32" }, "fullStreet": { "maxLength": 255, "type": "string", "nullable": true }, "zipCode": { "maxLength": 255, "type": "string", "nullable": true }, "city": { "maxLength": 255, "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "latitude": { "maximum": 90, "minimum": -90, "type": "number", "format": "double", "nullable": true }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ErpImportRead": { "required": [ "creatorAccountId", "erpImportSystemId", "fileId", "hasEmailCommunicationEnabledDefault", "hasMailCommunicationEnabledDefault", "hasMobileAppCommunicationEnabledDefault", "id", "wasProcessed" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "erpImportSystemId": { "type": "integer", "format": "int32" }, "creatorAccountId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32" }, "hasMailCommunicationEnabledDefault": { "type": "boolean" }, "hasMobileAppCommunicationEnabledDefault": { "type": "boolean" }, "hasEmailCommunicationEnabledDefault": { "type": "boolean" }, "wasProcessed": { "type": "boolean" }, "importStartedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ErpImportWrite": { "required": [ "erpImportSystemId", "fileId", "hasEmailCommunicationEnabledDefault", "hasMailCommunicationEnabledDefault", "hasMobileAppCommunicationEnabledDefault", "wasProcessed" ], "type": "object", "properties": { "erpImportSystemId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32" }, "hasMailCommunicationEnabledDefault": { "type": "boolean" }, "hasMobileAppCommunicationEnabledDefault": { "type": "boolean" }, "hasEmailCommunicationEnabledDefault": { "type": "boolean" }, "wasProcessed": { "type": "boolean" }, "importStartedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" } }, "additionalProperties": false }, "ExtendedProcessStageRead": { "required": [ "id", "order" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FaqGroupRead": { "required": [ "attachedVisualId", "id", "number" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "attachedVisualId": { "type": "integer", "description": "@deprecated will be removed in future version. Use `Icon` property directly.", "format": "int32", "deprecated": true }, "creatorId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "number": { "type": "integer", "format": "int32" }, "icon": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FaqGroupSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the FaqGroup's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "number": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FaqGroupVisualRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "icon": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FaqRead": { "required": [ "groupId", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "creatorId": { "type": "integer", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "format": "int32" }, "attachedFileId": { "type": "integer", "format": "int32", "nullable": true }, "question": { "type": "string", "nullable": true }, "answer": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FaqSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Faq's Question and Answer.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "groupId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FileAttachmentRead": { "required": [ "attachedToResolutions", "attachedToTopics", "id", "number", "typeId", "uploadedByAccountId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "uploadedByAccountId": { "type": "integer", "format": "int32" }, "uploadedByPartyId": { "type": "integer", "format": "int32", "nullable": true }, "uploadedByPropertyManagementCompanyId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "pageCount": { "type": "integer", "description": "Will be generated for supported file types automatically, asynchronously.", "format": "int32", "nullable": true }, "originalFilename": { "type": "string", "nullable": true }, "internalFilename": { "type": "string", "nullable": true }, "filesize": { "type": "number", "description": "File size in Kilobytes.\nWill be generated automatically, asynchronously.", "format": "double", "nullable": true }, "checksum": { "type": "string", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true }, "attachedToTopics": { "type": "array", "items": { "$ref": "#/components/schemas/Topic" } }, "attachedToResolutions": { "type": "array", "items": { "$ref": "#/components/schemas/Resolution" } }, "number": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FileDownloadResponse": { "type": "object", "properties": { "downloadUrl": { "type": "string", "description": "Gets the URL to download the file.", "nullable": true } }, "additionalProperties": false }, "FileRead": { "required": [ "id", "typeId", "uploadedByAccountId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "uploadedByAccountId": { "type": "integer", "format": "int32" }, "uploadedByPartyId": { "type": "integer", "format": "int32", "nullable": true }, "uploadedByPropertyManagementCompanyId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "pageCount": { "type": "integer", "description": "Will be generated for supported file types automatically, asynchronously.", "format": "int32", "nullable": true }, "originalFilename": { "type": "string", "nullable": true }, "internalFilename": { "type": "string", "nullable": true }, "filesize": { "type": "number", "description": "File size in Kilobytes.\nWill be generated automatically, asynchronously.", "format": "double", "nullable": true }, "checksum": { "type": "string", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the File's OriginalFilename.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "processId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileTypeRead": { "required": [ "description", "fileExtension", "id", "isImage", "isReadableByAndroid", "isReadableByIos", "mimeType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "fileExtension": { "type": "string" }, "description": { "type": "string" }, "mimeType": { "type": "string" }, "isImage": { "type": "boolean" }, "isReadableByIos": { "type": "boolean" }, "isReadableByAndroid": { "type": "boolean" } }, "additionalProperties": false }, "FileTypeSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "fileExtension": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "mimeType": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileUploadResponse": { "required": [ "uploadUrl" ], "type": "object", "properties": { "uploadUrl": { "type": "string", "description": "Gets the URL to upload the file." } }, "additionalProperties": false }, "FileWrite": { "required": [ "originalFilename", "typeId" ], "type": "object", "properties": { "originalFilename": { "maxLength": 255, "type": "string" }, "filesize": { "type": "number", "description": "File size in Kilobytes.\nWill be generated for supported file types automatically, asynchronously.", "format": "double", "nullable": true }, "pageCount": { "type": "integer", "description": "Will be generated for supported file types automatically, asynchronously.", "format": "int32", "nullable": true }, "checksum": { "type": "string", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FillVotingGroupVotes": { "required": [ "decision" ], "type": "object", "properties": { "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent" }, "resolutionOptionId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GenerateDocumentStackRequest": { "required": [ "documentTemplateId" ], "type": "object", "properties": { "documentTemplateId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GenericPartySettingRead": { "required": [ "id", "partyId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32" }, "key": { "type": "string", "nullable": true }, "integerValue": { "type": "integer", "format": "int32", "nullable": true }, "stringValue": { "type": "string", "nullable": true }, "textValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HangupReason": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "description": "Possible values:\n- 0 = UserHangup\n- 1 = AgentHangup\n- 2 = CallTransfer\n- 3 = Inactivity\n- 4 = MaxCallLength\n- 5 = Timeout\n- 6 = Voicemail\n- 7 = GeneralError\n- 8 = ConcurrencyLimitReached\n- 9 = Unknown", "format": "int32" }, "IdListDtoOfInt32": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "InquiryAiEvaluationDetailField": { "enum": [ "Subject", "Summary", "Labels" ], "type": "string", "description": "The AI-derived detail fields of an inquiry evaluation that can be selectively regenerated.\nSerialized as strings so the API contract reads by name rather than by ordinal.\n\nPossible values:\n- 0 = Subject\n- 1 = Summary\n- 2 = Labels" }, "InquiryAiEvaluationRead": { "required": [ "id", "inquiryId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "inquiryId": { "type": "integer", "format": "int32" }, "summary": { "type": "string", "description": "Short summary of the inquiry report.", "nullable": true }, "answer": { "type": "string", "description": "Suggested answer to the inquiry.", "nullable": true }, "priority": { "type": "integer", "description": "Is between 0-9. 0 = lowest; 9 = highest priority.", "format": "int32", "nullable": true }, "action": { "type": "integer", "description": "1. Answer directly\n2. Create a todo\n3. Create a Process", "format": "int32", "nullable": true }, "todo": { "type": "string", "description": "Suggested todo text.", "nullable": true }, "deadline": { "type": "string", "description": "Legacy API name for the entity's `DueDate`. Kept for backward compatibility;\na future API version may rename this to `DueDate`.", "format": "date-time", "nullable": true }, "processTypeId": { "type": "integer", "description": "Suggested process type.", "format": "int32", "nullable": true }, "subject": { "type": "string", "description": "Title derived from the inquiry report.", "nullable": true }, "connectedUnitId": { "type": "integer", "description": "Unit connected to the inquiry.", "format": "int32", "nullable": true }, "connectedPartyId": { "type": "integer", "description": "Party connected to the inquiry.", "format": "int32", "nullable": true }, "connectedPropertyId": { "type": "integer", "description": "Property connected to the inquiry.", "format": "int32", "nullable": true }, "associatedProcessId": { "type": "integer", "description": "Process associated with the inquiry.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "The AI-derived evaluation of an inquiry. Every field below is generated from the inquiry report." }, "InquiryAiEvaluationSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the InquiryAiEvaluation's Response, Summary, Answer and Todo.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" } }, "additionalProperties": false }, "InquiryCategoryRead": { "required": [ "creatorPartyId", "id", "isStandard" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "creatorPartyId": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "isStandard": { "type": "boolean" } }, "additionalProperties": false }, "InquiryCategorySearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the InquiryCategory's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "isRoot": { "type": "boolean", "description": "Has no parent document group.", "nullable": true }, "parentId": { "type": "integer", "description": "Retrieve all direct children of this group id.", "format": "int32", "nullable": true }, "isStandard": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "InquiryCustomEmailReplyRead": { "required": [ "attachmentFileIds", "body", "eMailSenderSettingId", "inquiryId", "notificationId", "receiverContactId", "subject" ], "type": "object", "properties": { "inquiryId": { "type": "integer", "description": "Gets the inquiry the reply is prepared for.", "format": "int32" }, "notificationId": { "type": "integer", "description": "Gets the id of the notification-queue row holding the reply.", "format": "int32" }, "eMailSenderSettingId": { "type": "integer", "description": "Gets the mailbox the reply will be sent from.", "format": "int32" }, "receiverContactId": { "type": "integer", "description": "Gets the e-mail contact of the connected party the reply is addressed to.", "format": "int32" }, "subject": { "type": "string", "description": "Gets the mail subject." }, "body": { "type": "string", "description": "Gets the mail body (HTML)." }, "cc": { "type": "string", "description": "Gets the additional visible recipients as a comma-separated address list.", "nullable": true }, "bcc": { "type": "string", "description": "Gets the additional hidden recipients as a comma-separated address list.", "nullable": true }, "attachmentFileIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Gets the attached files, in the order they will be attached." }, "preparedAt": { "type": "string", "description": "Gets when the reply was prepared. Prepared replies are short-lived and are cleaned up an hour after\nthis timestamp, so a reply is meant to be prepared right before the inquiry is closed.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "InquiryCustomEmailReplyResponse": { "required": [ "createdNotificationId", "inquiryId" ], "type": "object", "properties": { "inquiryId": { "type": "integer", "description": "Gets the inquiry the reply was prepared for.", "format": "int32" }, "createdNotificationId": { "type": "integer", "description": "Id of the prepared reply as notification.", "format": "int32" } }, "additionalProperties": false }, "InquiryLabelMappingRead": { "required": [ "id", "inquiryId", "isAiEvaluation", "labelId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "inquiryId": { "type": "integer", "format": "int32" }, "labelId": { "type": "integer", "format": "int32" }, "isAiEvaluation": { "type": "boolean" } }, "additionalProperties": false }, "InquiryLabelRead": { "required": [ "id", "key", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "key": { "type": "string", "description": "Immutable, unique ASCII slug (umlaut/ß expanded). Stable, cross-system handle." }, "name": { "type": "string", "description": "German display name." } }, "additionalProperties": false }, "InquiryLabelSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the InquiryLabel's Name and Key.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" } }, "additionalProperties": false }, "InquiryPriority": { "enum": [ 0, 10, 20, 30 ], "type": "integer", "description": "Possible values:\n- 0 = Unknown\n- 10 = Low\n- 20 = Middle\n- 30 = High", "format": "int32" }, "InquiryRead": { "required": [ "id", "readStatus", "receiverPartyId", "sourceId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "sourceId": { "type": "integer", "description": "The ID of the source of the inquiry. For example can be Customer App, E-Mail, Phone, etc.", "format": "int32" }, "categoryId": { "type": "integer", "description": "The ID of the category of the inquiry.", "format": "int32", "nullable": true }, "report": { "type": "string", "description": "The main report or description of the inquiry.", "nullable": true }, "subject": { "type": "string", "description": "The generated subject of the inquiry.", "nullable": true }, "rejectionResponse": { "type": "string", "description": "The response provided when the inquiry is rejected.", "nullable": true }, "completionResponse": { "type": "string", "description": "The response provided when the inquiry is completed.", "nullable": true }, "connectedPartyId": { "type": "integer", "description": "The ID of the party connected to the inquiry. Reporter of the inquiry, e.g. tenant/owner/contractor.", "format": "int32", "nullable": true }, "creatorAccountId": { "type": "integer", "description": "The ID of the account that created the inquiry.", "format": "int32", "nullable": true }, "creatorAccountRole": { "allOf": [ { "$ref": "#/components/schemas/AccountRole" } ], "description": "The role of the account that created the inquiry. E.g. PoolManager, PropertyManager, etc.\n\nPossible values:\n- 1 = Admin\n- 2 = PropertyManagementCompany\n- 3 = PoolManager\n- 5 = Contractor\n- 7 = User\n- 10 = EnergyProvider\n- 11 = Guest\n- 13 = InsuranceBroker\n- 14 = Insurer\n- 15 = Mediator", "nullable": true }, "receiverPartyId": { "type": "integer", "description": "The ID of the party that receives the inquiry. Usually the PropertyManager.", "format": "int32" }, "connectedPropertyId": { "type": "integer", "description": "The ID of the property connected to the inquiry.", "format": "int32", "nullable": true }, "connectedUnitId": { "type": "integer", "description": "The ID of the unit connected to the inquiry, has to be a unit of the given connected property.", "format": "int32", "nullable": true }, "associatedProcessId": { "type": "integer", "description": "The ID of the process associated with the inquiry.", "format": "int32", "nullable": true }, "associatedProcessFeedEntryId": { "type": "integer", "description": "The ID of the process feed associated with the inquiry.", "format": "int32", "nullable": true }, "associatedTodoId": { "type": "integer", "description": "The ID of the UserTask associated with the inquiry.\nNote: Will be renamed to `AssociatedUserTaskId` in future API-Versions.", "format": "int32", "nullable": true }, "priority": { "allOf": [ { "$ref": "#/components/schemas/InquiryPriority" } ], "description": "The priority of the inquiry.\n\nPossible values:\n- 0 = Unknown\n- 10 = Low\n- 20 = Middle\n- 30 = High", "nullable": true }, "readStatus": { "allOf": [ { "$ref": "#/components/schemas/InquiryReadStatus" } ], "description": "The read status of the inquiry.\n\nPossible values:\n- 0 = Unread\n- 1 = Accepted\n- 2 = Rejected\n- 3 = Open\n- 4 = InProgress\n- 5 = WaitingForAnswer" }, "readByAccountId": { "type": "integer", "description": "The ID of the account that read the inquiry and marked the inquiry as accepted/rejected.", "format": "int32", "nullable": true }, "dueDate": { "type": "string", "description": "The optional due date of the inquiry.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "InquiryReadStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "Possible values:\n- 0 = Unread\n- 1 = Accepted\n- 2 = Rejected\n- 3 = Open\n- 4 = InProgress\n- 5 = WaitingForAnswer", "format": "int32" }, "InquirySearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Inquiry's ID, Report, RejectionResponse, CompletionResponse, AI Subject Recommendation, and AI Summary.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "processId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the associated process.", "nullable": true }, "userTaskId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the associated user task (currently named `AssociatedTodoID`).", "nullable": true }, "creatorAccountId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the creator account.", "nullable": true }, "creatorPartyId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the creator party.", "nullable": true }, "receiverPartyId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the receiver party.", "nullable": true }, "connectedPartyId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the connected party.", "nullable": true }, "unitId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the connected unit.", "nullable": true }, "propertyId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the connected property.", "nullable": true }, "tenantId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the tenant of the connected property.", "nullable": true }, "sourceId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the `InquirySource`. For example can be Customer App, E-Mail, Phone, etc.", "nullable": true }, "categoryId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of the `InquiryCategory`.", "nullable": true }, "accessibleByAccountId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of an account (of your own Party) that can access the inquiry.", "nullable": true }, "priority": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryPriority" }, "description": "Filter by the priority of the inquiry.", "nullable": true }, "labelId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter by the ID of an associated label.", "nullable": true }, "readStatus": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryReadStatus" }, "description": "Filter by the read status of the inquiry.", "nullable": true }, "createdInYear": { "type": "integer", "description": "Filter by the year the inquiry was created.", "format": "int32", "nullable": true }, "createdInMonth": { "type": "integer", "description": "Filter by the month the inquiry was created.", "format": "int32", "nullable": true }, "createdInDay": { "type": "integer", "description": "Filter by the day the inquiry was created.", "format": "int32", "nullable": true }, "hasDueDate": { "type": "boolean", "description": "When `true`, only returns inquiries that have a due date set.\nWhen `false`, only returns inquiries without a due date.", "nullable": true }, "dueDateFrom": { "type": "string", "description": "Filter inquiries with a due date from this date onwards.", "format": "date-time", "nullable": true }, "dueDateUntil": { "type": "string", "description": "Filter inquiries with a due date until this date.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "InquirySourceRead": { "required": [ "icon", "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string" } }, "additionalProperties": false }, "InquiryWrite": { "required": [ "connectedPartyId", "receiverPartyId", "report", "sourceId" ], "type": "object", "properties": { "sourceId": { "type": "integer", "description": "The ID of the source of the inquiry (`InquirySource`).", "format": "int32" }, "categoryId": { "type": "integer", "description": "The ID of the category of the inquiry.\nIf the category id is omitted, the default category will be used automatically, if defined (see `InquiryCategory.IsStandard`).", "format": "int32", "nullable": true }, "subject": { "type": "string", "description": "The subject of the inquiry.", "nullable": true }, "report": { "type": "string", "description": "The main report or description of the inquiry." }, "rejectionResponse": { "type": "string", "description": "The response provided when the inquiry is rejected.", "nullable": true }, "completionResponse": { "type": "string", "description": "The response provided when the inquiry is completed.", "nullable": true }, "priority": { "allOf": [ { "$ref": "#/components/schemas/InquiryPriority" } ], "description": "The priority of the inquiry.\n\nPossible values:\n- 0 = Unknown\n- 10 = Low\n- 20 = Middle\n- 30 = High", "nullable": true }, "connectedPartyId": { "type": "integer", "description": "The ID of the party connected to the inquiry. Reporter of the inquiry, e.g. tenant/owner/contractor.", "format": "int32" }, "receiverPartyId": { "type": "integer", "description": "The ID of the party that receives the inquiry. Usually the PropertyManager.", "format": "int32" }, "connectedPropertyId": { "type": "integer", "description": "The ID of the property connected to the inquiry.", "format": "int32", "nullable": true }, "connectedUnitId": { "type": "integer", "description": "The ID of the unit connected to the inquiry, has to be a unit of the given connected property.", "format": "int32", "nullable": true }, "associatedProcessId": { "type": "integer", "description": "The ID of the process associated with the inquiry.", "format": "int32", "nullable": true }, "associatedTodoId": { "type": "integer", "description": "The ID of the UserTask associated with the inquiry.\nNote: Will be renamed to `AssociatedUserTaskId` in future API-Versions.", "format": "int32", "nullable": true }, "readStatus": { "allOf": [ { "$ref": "#/components/schemas/InquiryReadStatus" } ], "description": "The read status of the inquiry.\n\nPossible values:\n- 0 = Unread\n- 1 = Accepted\n- 2 = Rejected\n- 3 = Open\n- 4 = InProgress\n- 5 = WaitingForAnswer", "default": 0, "nullable": true }, "readByAccountId": { "type": "integer", "description": "The ID of the account that read the inquiry and marked the inquiry as accepted/rejected.", "format": "int32", "nullable": true }, "dueDate": { "type": "string", "description": "The optional due date of the inquiry.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "InvoiceRead": { "required": [ "billerAccountId", "id", "isExporting", "receiverPartyId", "wasCanceled", "wasExported", "wasInvoiced" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "receiverPartyId": { "type": "integer", "format": "int32" }, "billerAccountId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time", "nullable": true }, "number": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "tax": { "type": "integer", "format": "int32", "nullable": true }, "comment": { "type": "string", "nullable": true }, "fileId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "relatedOfferId": { "type": "integer", "format": "int32", "nullable": true }, "wasCanceled": { "type": "boolean" }, "wasInvoiced": { "type": "boolean" }, "invoicedDate": { "type": "string", "format": "date-time", "nullable": true }, "isExporting": { "type": "boolean" }, "wasExported": { "type": "boolean" }, "exportDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "InvoiceSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Invoice's Comment.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "processId": { "type": "integer", "format": "int32", "nullable": true }, "processFeedId": { "type": "integer", "format": "int32", "nullable": true }, "workOrderId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "InvoiceWrite": { "required": [ "billerAccountId", "isExporting", "receiverPartyId", "wasCanceled", "wasExported", "wasInvoiced" ], "type": "object", "properties": { "receiverPartyId": { "type": "integer", "format": "int32" }, "billerAccountId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time", "nullable": true }, "number": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "tax": { "type": "integer", "format": "int32", "nullable": true }, "comment": { "type": "string", "nullable": true }, "fileId": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "relatedOfferId": { "type": "integer", "format": "int32", "nullable": true }, "wasCanceled": { "type": "boolean" }, "wasInvoiced": { "type": "boolean" }, "invoicedDate": { "type": "string", "format": "date-time", "nullable": true }, "isExporting": { "type": "boolean" }, "wasExported": { "type": "boolean" }, "exportDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "LegacyUnitContractType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer", "description": "Possible values:\n- 1 = BoardChairman\n- 2 = BoardMember\n- 3 = Owner\n- 4 = Tenant\n- 5 = Subtenant\n- 6 = Resident\n- 7 = SpecialOwner\n- 8 = PropertyOwner\n- 9 = AuthorizedOwnerRecipient\n- 10 = AuthorizedTenantRecipient\n- 11 = AuthorizedPropertyOwnerRecipient", "format": "int32" }, "LoginCommandResponse": { "required": [ "accessToken", "account", "refreshToken" ], "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "allOf": [ { "$ref": "#/components/schemas/AuthSession" } ] }, "account": { "allOf": [ { "$ref": "#/components/schemas/AccountRead" } ] }, "party": { "allOf": [ { "$ref": "#/components/schemas/PartyRead" } ], "nullable": true } }, "additionalProperties": false }, "LoginRequest": { "required": [ "email", "password", "skipMultiFactorAuthentication" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "skipMultiFactorAuthentication": { "type": "boolean", "default": false, "deprecated": true } }, "additionalProperties": false }, "LoginWithApiKeyCommandResponse": { "required": [ "accessToken", "account", "refreshToken" ], "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "allOf": [ { "$ref": "#/components/schemas/AuthSession" } ] }, "account": { "allOf": [ { "$ref": "#/components/schemas/AccountRead" } ] }, "party": { "allOf": [ { "$ref": "#/components/schemas/PartyRead" } ], "nullable": true } }, "additionalProperties": false }, "LogoutRequest": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" }, "logoutEverywhere": { "type": "boolean", "default": false, "nullable": true } }, "additionalProperties": false }, "MailPlaceholderDependencyRead": { "required": [ "id", "parentPlaceholderId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Legacy placeholder id from notificationtypestrings.ntsid.", "format": "int32" }, "key": { "type": "string", "description": "Placeholder key shown in the editor, for example \"Ansprechpartner:Name\".", "nullable": true }, "replacement": { "type": "string", "description": "Example replacement text shown in Gen1.", "nullable": true }, "description": { "type": "string", "description": "Human-readable placeholder description shown in Gen1.", "nullable": true }, "token": { "type": "string", "description": "Token format used inside the Gen1 editor, for example [[#Ansprechpartner:Name]].", "nullable": true }, "parentPlaceholderId": { "type": "integer", "description": "Legacy parent placeholder id from notificationtypestringsdependence.ntsdntsid1.", "format": "int32" } }, "additionalProperties": false }, "MailPlaceholderRead": { "required": [ "dependenceId", "dependencePosition", "dependencies", "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Legacy placeholder id from notificationtypestrings.ntsid.", "format": "int32" }, "key": { "type": "string", "description": "Placeholder key shown in the editor, for example \"Ansprechpartner:Name\".", "nullable": true }, "replacement": { "type": "string", "description": "Example replacement text shown in Gen1.", "nullable": true }, "description": { "type": "string", "description": "Human-readable placeholder description shown in Gen1.", "nullable": true }, "token": { "type": "string", "description": "Token format used inside the Gen1 editor, for example [[#Ansprechpartner:Name]].", "nullable": true }, "dependenceId": { "type": "integer", "description": "Legacy grouping field used by Gen1 for loop-style placeholder wrappers.", "format": "int32" }, "dependencePosition": { "type": "integer", "description": "Legacy ordering field used together with facilioo.Application.Crud.Dtos.Integrations.Email.MailPlaceholderReadDto.DependenceId.", "format": "int32" }, "dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/MailPlaceholderDependencyRead" }, "description": "Child placeholders that are only valid inside this parent placeholder's dependency scope." } }, "additionalProperties": false }, "MailSignatureRead": { "required": [ "accountId", "id", "isMail", "isMailDefault", "partyId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "description": "Party that owns the signature.", "format": "int32" }, "accountId": { "type": "integer", "description": "Account that owns the signature.", "format": "int32" }, "name": { "type": "string", "description": "Display name of the signature.", "nullable": true }, "signature": { "type": "string", "description": "HTML/text body of the signature.", "nullable": true }, "isMail": { "type": "boolean", "description": "Whether the signature can be used for email communication." }, "isMailDefault": { "type": "boolean", "description": "Whether this is the default email signature for the owning account." } }, "additionalProperties": false }, "MailTemplateRead": { "required": [ "custom", "mailTemplateActive", "notificationTypeId" ], "type": "object", "properties": { "notificationTypeId": { "type": "integer", "description": "Notification type id (e.g. 103 = \"Eingang - erledigt\").", "format": "int32" }, "notificationTypeName": { "type": "string", "description": "Notification type name.", "nullable": true }, "notificationTypeDescription": { "type": "string", "description": "Notification type description shown in the Gen1 template settings.", "nullable": true }, "mailTemplateId": { "type": "integer", "description": "Id of the company-specific `mailtemplates` row. Null for the built-in default row.", "format": "int32", "nullable": true }, "mailTemplateName": { "type": "string", "description": "Display name of the company-specific template. Null for the built-in default row.", "nullable": true }, "mailTemplateSubject": { "type": "string", "description": "Subject line for the template.", "nullable": true }, "mailTemplate": { "type": "string", "description": "Raw body of the template.", "nullable": true }, "mailTemplateActive": { "type": "boolean", "description": "Whether this company-specific template is marked active in Gen1. Always false for the default row." }, "custom": { "type": "boolean", "description": "True if this row is a company-specific override; false if it's the built-in default." } }, "additionalProperties": false, "description": "One candidate mail template row for a legacy notification type: either the built-in\ndefault (from `notificationtype`) or a company-specific override (from `mailtemplates`).\nA batch request for N notification types returns one default row plus every custom\noverride row per type - not just the currently active one." }, "MandateRead": { "required": [ "conferenceId", "id", "propertyOwnerId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "conferenceId": { "type": "integer", "format": "int32" }, "propertyOwnerId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MandateSearchRequest": { "required": [ "conferenceId" ], "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "conferenceId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MandateWrite": { "required": [ "conferenceId", "propertyOwnerId" ], "type": "object", "properties": { "conferenceId": { "type": "integer", "format": "int32" }, "propertyOwnerId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MultiFactorChallenge": { "required": [ "accessToken", "maskedProvider", "nonce", "providerTypeId" ], "type": "object", "properties": { "nonce": { "type": "string" }, "accessToken": { "type": "string" }, "maskedProvider": { "type": "string" }, "providerTypeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "NearbyPlacesCategoryRead": { "required": [ "forPartyId", "id", "imageFileId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "forPartyId": { "type": "integer", "format": "int32" }, "forPropertyId": { "type": "integer", "format": "int32", "nullable": true }, "imageFileId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "externalName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NestedAttributeValueRead": { "required": [ "attributeGroupId", "attributeId", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "attributeGroupId": { "type": "integer", "format": "int32" }, "attributeId": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true }, "attribute": { "allOf": [ { "$ref": "#/components/schemas/AttributeRead" } ], "nullable": true } }, "additionalProperties": false }, "NoticeAccessRead": { "required": [ "id", "noticeId", "unitContractId", "wasRead" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "noticeId": { "type": "integer", "format": "int32" }, "unitContractId": { "type": "integer", "format": "int32" }, "wasRead": { "type": "boolean" } }, "additionalProperties": false }, "NoticeRead": { "required": [ "creatorAccountId", "creatorPartyId", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "subject": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "creatorAccountId": { "type": "integer", "format": "int32" }, "creatorPartyId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "NoticeSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Notice's Subject, and Content.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "wasRead": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "NoticeWrite": { "required": [ "content", "subject" ], "type": "object", "properties": { "subject": { "minLength": 1, "type": "string" }, "content": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OneSitePresentationImageMode": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Possible values:\n- 1 = Property\n- 2 = Static\n- 3 = Custom", "format": "int32" }, "OptionsResultCount": { "required": [ "count", "optionId", "optionName" ], "type": "object", "properties": { "optionId": { "type": "integer", "format": "int32" }, "optionName": { "type": "string" }, "count": { "type": "number", "format": "double" }, "dependentResolutionAcceptedCount": { "type": "number", "format": "double", "nullable": true }, "dependentResolutionDeclinedCount": { "type": "number", "format": "double", "nullable": true }, "dependentResolutionAbstentionCount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "OrderRequest": { "required": [ "newOrder" ], "type": "object", "properties": { "newOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OrderTopicsRequest": { "required": [ "newOrder" ], "type": "object", "properties": { "newOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaginatedListOfAccountContactDetailsRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountContactDetailsRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAccountGroupPermissionMappingRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountGroupPermissionMappingRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAccountGroupRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountGroupRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAccountPermissionRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountPermissionRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAccountRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfActivityAttemptRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityAttemptRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAttendanceRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AttendanceRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAttributeGroupRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeGroupRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAttributeGroupTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeGroupTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAttributeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfAttributeValueRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeValueRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfBankAccountRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccountRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfBillingAddressRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BillingAddressRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfBookedPlatformProductRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BookedPlatformProductRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfBookingAccountItemRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BookingAccountItemRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfBookingAccountRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BookingAccountRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfCallLogRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CallLogRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfChatGptSettingsRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatGptSettingsRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfChatbotConfigurationRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotConfigurationRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfChatbotConversationRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotConversationRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfChatbotMessageRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotMessageRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfCloudConnectAuditRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CloudConnectAuditRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfColorRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ColorRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConferenceEventRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceEventRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConferenceRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConferenceRole": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRole" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConferenceVoteRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceVoteRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConnectRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConsumptionBrandRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionBrandRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConsumptionMeterAssignedReaderParty": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionMeterAssignedReaderParty" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConsumptionMeterRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionMeterRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConsumptionReadingDate": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionReadingDate" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConsumptionReadingExtended": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionReadingExtended" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConsumptionReadingRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionReadingRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfConsumptionTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumptionTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfContactDetailsRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetailsRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfContactTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfCustomerAppCustomContentRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAppCustomContentRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfCustomerAppRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAppRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfDetailedUnitRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DetailedUnitRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfDocumentBackgroundJobRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBackgroundJobRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfDocumentGroupRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentGroupRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfDocumentRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfDocumentSettingsRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSettingsRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfDocumentShareRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentShareRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfDocumentTemplateRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentTemplateRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfEMailSenderSettingRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EMailSenderSettingRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfEditorTextBlockRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EditorTextBlockRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfEntranceRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntranceRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfErpImportRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ErpImportRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfExtendedProcessStageRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedProcessStageRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfFaqGroupRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FaqGroupRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfFaqGroupVisualRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FaqGroupVisualRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfFaqRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FaqRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfFileAttachmentRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileAttachmentRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfFileRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfFileTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfGenericPartySettingRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GenericPartySettingRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfInquiryAiEvaluationRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryAiEvaluationRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfInquiryCategoryRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryCategoryRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfInquiryLabelMappingRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryLabelMappingRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfInquiryLabelRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryLabelRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfInquiryRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfInquirySourceRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InquirySourceRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfInvoiceRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfMailSignatureRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MailSignatureRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfMandateRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MandateRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfNearbyPlacesCategoryRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NearbyPlacesCategoryRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfNestedAttributeValueRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NestedAttributeValueRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfNoticeAccessRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NoticeAccessRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfNoticeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NoticeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPartyRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPartyTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PartyTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPlatformProductRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformProductRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPredefinedVoteRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedVoteRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfProcessFeedCategoryRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessFeedCategoryRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfProcessFeedRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessFeedRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfProcessFeedTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessFeedTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfProcessInsuranceClaimRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessInsuranceClaimRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfProcessNotificationRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessNotificationRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfProcessRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfProcessStageRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessStageRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfProcessTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPropertyEmergencyContactRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyEmergencyContactRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPropertyRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPropertyRoleDefaultRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyRoleDefaultRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPropertyRoleMapping": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyRoleMapping" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfPropertyRoleRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyRoleRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfResolutionAttachmentRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionAttachmentRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfResolutionOptionRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfResolutionOptionTemplateRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionOptionTemplateRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfResolutionRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfResolutionTemplateRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ResolutionTemplateRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfSettingsRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SettingsRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfSharesResponse": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SharesResponse" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfSigneeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SigneeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfSmartLockRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SmartLockRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfSmartLockTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SmartLockTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfString": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfSumVoteRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SumVoteRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfTenantPartyAccess": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TenantPartyAccess" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfTenantRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TenantRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfTopicAttachmentRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopicAttachmentRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfTopicNoteRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopicNoteRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfTopicRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopicRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfTopicTemplateRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfTopicTemplateResolutionTemplateRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TopicTemplateResolutionTemplateRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfTradeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TradeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUnitContractRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UnitContractRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUnitContractTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UnitContractTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUnitRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UnitRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUnitTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UnitTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUserTaskCollectionRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskCollectionRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUserTaskFeedEntryRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskFeedEntryRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUserTaskNotificationRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskNotificationRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUserTaskPriorityRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskPriorityRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfUserTaskRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserTaskRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfViewSettingGroupRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ViewSettingGroupRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfViewSettingRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ViewSettingRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfVotingEndReasonRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VotingEndReasonRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfVotingGroupRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VotingGroupRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfVotingGroupShares": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VotingGroupShares" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfVotingGroupVoteRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VotingGroupVoteRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfVotingMajorityRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VotingMajorityRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfVotingProcedureRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VotingProcedureRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfVotingSessionRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VotingSessionRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWebhookAttemptRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookAttemptRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWebhookEventRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWebhookRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWebhookRegistrationRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookRegistrationRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWorkOrderAppointmentRequestDateRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWorkOrderAppointmentRequestRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderAppointmentRequestRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWorkOrderFeedEntryRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderFeedEntryRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWorkOrderRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWorkOrderStatusRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderStatusRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaginatedListOfWorkOrderTypeRead": { "required": [ "hasNextPage", "hasPreviousPage", "items", "pageNumber", "pageSize", "totalCount", "totalPages" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorkOrderTypeRead" } }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "totalCount": { "type": "integer", "format": "int32", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PartyRead": { "required": [ "hasEmailCommunicationEnabled", "hasMailCommunicationEnabled", "hasMobileAppCommunicationEnabled", "id", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "number": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountRole" } ], "description": "Referring to `PartyType`.\n\nPossible values:\n- 1 = Admin\n- 2 = PropertyManagementCompany\n- 3 = PoolManager\n- 5 = Contractor\n- 7 = User\n- 10 = EnergyProvider\n- 11 = Guest\n- 13 = InsuranceBroker\n- 14 = Insurer\n- 15 = Mediator" }, "primaryName": { "type": "string", "description": "Usually the first name (including secondary names) for natural persons, and empty for legal entities.", "nullable": true }, "secondaryName": { "type": "string", "description": "Usually the last name for natural persons, and the full name for legal entities.", "nullable": true }, "ternaryName": { "type": "string", "description": "This can contain another natural person / legal entity (in addition to `PrimaryName` and `Secondary`.\nIt contains the full name of the additional person as `Max Mustermann`.", "nullable": true }, "quaternaryName": { "type": "string", "description": "Same as `TernaryName`, just an additional one.", "nullable": true }, "fullName": { "type": "string", "description": "Usually a computed concatenation of `PrimaryName` and `SecondaryName`, separated with a space.", "nullable": true }, "fullStreet": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "qrCode": { "type": "string", "nullable": true }, "isConfigured": { "type": "boolean", "nullable": true }, "isAppAvailable": { "type": "boolean", "description": "Denormalized, persisted value based on party's preference (`HasMobileAppCommunicationEnabled`) and the availability of the party's accounts containing contact details from type `ContactType.iPhone` or `ContactType.Android` (logged in via a native app and having push notifications enabled in the OS for the App).", "nullable": true }, "isMailAvailable": { "type": "boolean", "description": "Denormalized, persisted value based on party's preference (`HasEmailCommunicationEnabled`) and on the availability of the party's contact details containing an entry from type `ContactType.Email`.", "nullable": true }, "logoId": { "type": "integer", "description": "Reference to `File` that represents the logo of the `Party`.", "format": "int32", "nullable": true }, "hasEmailCommunicationEnabled": { "type": "boolean", "description": "Personal preference set by the party itself whether they want to be contacted via email." }, "hasMobileAppCommunicationEnabled": { "type": "boolean", "description": "Personal preference set by the party itself whether they want to be contacted via push notifications. Can't be enabled exclusively, as either email or mail must be enabled too." }, "hasMailCommunicationEnabled": { "type": "boolean", "description": "Personal preference set by the party itself whether they want to be contacted via physical mail." }, "website": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartySearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Party's PrimaryName, SecondaryName, TernaryName, and QuaternaryName.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "externalId": { "type": "string", "nullable": true }, "ownerOfTenantId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountRole" } ], "description": "Filters based on the `PartyType`.\n\nPossible values:\n- 1 = Admin\n- 2 = PropertyManagementCompany\n- 3 = PoolManager\n- 5 = Contractor\n- 7 = User\n- 10 = EnergyProvider\n- 11 = Guest\n- 13 = InsuranceBroker\n- 14 = Insurer\n- 15 = Mediator", "nullable": true } }, "additionalProperties": false }, "PartyTypeRead": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Sometimes also referred to as `AccountRole`." }, "PartyWrite": { "required": [ "hasEmailCommunicationEnabled", "hasMailCommunicationEnabled", "hasMobileAppCommunicationEnabled", "type" ], "type": "object", "properties": { "number": { "maxLength": 45, "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccountRole" } ], "description": "Referring to `PartyType`.\n\nPossible values:\n- 1 = Admin\n- 2 = PropertyManagementCompany\n- 3 = PoolManager\n- 5 = Contractor\n- 7 = User\n- 10 = EnergyProvider\n- 11 = Guest\n- 13 = InsuranceBroker\n- 14 = Insurer\n- 15 = Mediator" }, "primaryName": { "maxLength": 255, "type": "string", "description": "Should be the first name (including additional first names) for natural persons, and empty for legal entities.\nEither `PrimaryName` or `SecondaryName` has to be set.", "nullable": true }, "secondaryName": { "maxLength": 255, "type": "string", "description": "Should be the last name for natural persons, and the full name for legal entities.\nEither `PrimaryName` or `SecondaryName` has to be set.", "nullable": true }, "ternaryName": { "maxLength": 255, "type": "string", "description": "This can be used, if the party contains more than one natural person / legal entity (in addition to `PrimaryName` and `Secondary`).\nIt should contain the full name of the additional person as `Max Mustermann`.", "nullable": true }, "quaternaryName": { "maxLength": 255, "type": "string", "description": "Same as `TernaryName`, just an additional one.", "nullable": true }, "fullStreet": { "maxLength": 255, "type": "string", "nullable": true }, "zipCode": { "maxLength": 10, "type": "string", "nullable": true }, "city": { "maxLength": 80, "type": "string", "nullable": true }, "country": { "maxLength": 80, "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "qrCode": { "type": "string", "nullable": true }, "logoId": { "type": "integer", "description": "Reference to `File` that represents the logo of the `Party`.", "format": "int32", "nullable": true }, "hasEmailCommunicationEnabled": { "type": "boolean", "description": "Personal preference set by the party itself whether they want to be contacted via email." }, "hasMobileAppCommunicationEnabled": { "type": "boolean", "description": "Personal preference set by the party itself whether they want to be contacted via push notifications. Can't be enabled exclusively, as either email or mail must be enabled too." }, "hasMailCommunicationEnabled": { "type": "boolean", "description": "Personal preference set by the party itself whether they want to be contacted via physical mail." }, "website": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PasswordRecoveryRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } }, "additionalProperties": false }, "PasswordRecoveryResponse": { "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string", "description": "A message indicating the result of the password recovery request." } }, "additionalProperties": false }, "PlatformProductRead": { "required": [ "id", "name", "orderingNumber" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "description": "The display name of the platform product." }, "orderingNumber": { "type": "integer", "description": "Controls the display order of this product relative to others. Lower values appear first.", "format": "int32" } }, "additionalProperties": false, "description": "Represents a platform product — a purchasable feature module of the facilioo platform\n(e.g. Inbox, Connect, Voicebot). Products are predefined by facilioo and cannot be\ncreated or modified by API callers." }, "PlatformProductSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the PlatformProduct's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" } }, "additionalProperties": false }, "PredefinedVoteRead": { "required": [ "id", "isOptionVote", "isRegularVote" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "mandateId": { "type": "integer", "format": "int32", "nullable": true }, "resolutionId": { "type": "integer", "format": "int32", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent", "nullable": true }, "resolutionOptionId": { "type": "integer", "format": "int32", "nullable": true }, "isOptionVote": { "type": "boolean" }, "isRegularVote": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PredefinedVoteSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "mandateIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "PredefinedVoteWrite": { "required": [ "decision", "mandateId", "resolutionId" ], "type": "object", "properties": { "mandateId": { "type": "integer", "format": "int32" }, "resolutionId": { "type": "integer", "format": "int32" }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent" }, "resolutionOptionId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PrepareInquiryCustomEmailReplyRequest": { "required": [ "body", "eMailSenderSettingId", "receiverContactId", "subject" ], "type": "object", "properties": { "subject": { "type": "string", "description": "Mail subject.", "example": "Ihre Anfrage zum defekten Aufzug" }, "body": { "type": "string", "description": "Mail body (HTML), sent verbatim.", "example": "

Guten Tag, der Aufzug wurde repariert.

" }, "cc": { "type": "string", "description": "Additional visible recipients as a comma-separated address list.", "nullable": true, "example": "hausmeister@example.com, technik@example.com" }, "bcc": { "type": "string", "description": "Additional hidden recipients as a comma-separated address list.", "nullable": true, "example": "archiv@example.com, backup@example.com" }, "eMailSenderSettingId": { "type": "integer", "description": "The mailbox to send from. Must be one the caller may use — a mailbox of their own party, or a personal\none of their own account.", "format": "int32", "example": 42 }, "attachmentFileIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Files to attach, in the given order. Each has to be accessible to the caller.\n \n\nAttachment size is not validated here, and two limits outside this API apply. The mail server\nbehind the chosen `EMailSenderSettingId` imposes its own maximum message size, which is\nunder the sender's control; and the recipient's mail provider imposes one too, which is not. A reply\nthat exceeds either is rejected at delivery time, long after this request succeeded, so keep the total\nattachment size modest and link to large files instead.", "nullable": true, "example": [ 101, 102 ] }, "receiverContactId": { "type": "integer", "description": "The e-mail contact of the inquiry's connected party to send to. Search\n`/api/contact-details` filtered by that party and contact type 3 (e-mail) for the available ones.", "format": "int32", "example": 7 } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProcessFeedCategoryRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "description": "Category display name (e.g., \"Kontakt\", \"Rückruf\").", "nullable": true }, "icon": { "type": "string", "description": "Icon (Fontawesome) identifier for UI representation (e.g., \"fa fa-phone\", \"fa fa-fax\").", "nullable": true } }, "additionalProperties": false, "description": "Represents a category for process feed entries (Verlaufskategorien)\nthat can be defined by a party and attached to any process feed." }, "ProcessFeedCategoryWrite": { "required": [ "icon", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Category display name (e.g., \"Kontakt\", \"Rückruf\")." }, "icon": { "minLength": 1, "type": "string", "description": "Icon (Fontawesome) identifier for UI representation (e.g., \"fa fa-phone\", \"fa fa-fax\")." } }, "additionalProperties": false, "description": "Represents a category for process feed entries (Verlaufskategorien)\nthat can be defined by a party and attached to any process feed." }, "ProcessFeedRead": { "required": [ "id", "processId", "sourceId", "typeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "processId": { "type": "integer", "description": "Identifier of the process this feed entry belongs to.\nA process represents the main workflow entity (e.g. a work order or issue).\nEach feed entry documents an event, message, or system action within that process.", "format": "int32" }, "typeId": { "type": "integer", "description": "Type of the process feed entry.\nReferences a ProcessFeedType which defines the semantics of the entry\n(for example message, status change, system event, etc.).\nSome feed types may not support custom text.", "format": "int32" }, "sourceId": { "type": "integer", "description": "Source of the feed entry.\nReferences a `ContactType` that indicates where the entry originated from,\nfor example Web, Email, iPhone App, Android App, etc.", "format": "int32" }, "creatorId": { "type": "integer", "description": "Account that created the feed entry.\nThis refers to the account responsible for creating the entry.\nMay be null in legacy or system-generated entries.", "format": "int32", "nullable": true }, "text": { "type": "string", "description": "Text content of the feed entry.\nThe returned text is already processed depending on the requesting party.\nFor example, tenants and property managers may see different versions\nof the same feed entry text.", "nullable": true }, "externalId": { "type": "string", "description": "External identifier used by integrations.\nCan be used to map this feed entry to an external system.", "nullable": true } }, "additionalProperties": false }, "ProcessFeedSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the ProcessFeed's Text.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "processId": { "type": "integer", "format": "int32", "nullable": true }, "fileId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessFeedTypeRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessFeedWrite": { "required": [ "processId", "sourceId", "text", "typeId" ], "type": "object", "properties": { "processId": { "type": "integer", "description": "Identifier of the process this feed entry should be added to.", "format": "int32" }, "typeId": { "type": "integer", "description": "Type of the process feed entry.\nDefines how the entry is interpreted by the system.\nSome feed types may ignore or override the provided text.", "format": "int32" }, "sourceId": { "type": "integer", "description": "Source of the feed entry.\nReferences a `ContactType` that indicates where the entry originated from,\nfor example Web, Email, iPhone App, Android App, etc.", "format": "int32" }, "text": { "type": "string", "description": "Raw text content of the feed entry.\nThe text is stored as provided and later processed dynamically\ndepending on the requesting party when retrieved." }, "externalId": { "type": "string", "description": "External identifier used by integrations.\nCan be used to map this feed entry to an external system.", "nullable": true } }, "additionalProperties": false }, "ProcessInsuranceClaimRead": { "required": [ "id", "processId", "subTypeId", "typeId", "wasPolicePresent" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "processId": { "type": "integer", "format": "int32" }, "attributeGroupId": { "type": "integer", "format": "int32", "nullable": true }, "number": { "type": "string", "nullable": true }, "brokerNumber": { "type": "string", "nullable": true }, "damageDate": { "type": "string", "format": "date-time", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "subTypeId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "costEstimate": { "type": "number", "format": "double", "nullable": true }, "location": { "type": "string", "nullable": true }, "isThirdPartyDamage": { "type": "boolean", "nullable": true }, "thirdPartyName": { "type": "string", "nullable": true }, "thirdPartyAddress": { "type": "string", "nullable": true }, "isEligibleForInputTax": { "type": "boolean", "nullable": true }, "isHouseholdContentInsured": { "type": "boolean", "nullable": true }, "householdContentInsurer": { "type": "string", "nullable": true }, "householdContentInsuranceNumber": { "type": "string", "nullable": true }, "commissionedMeasures": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "iban": { "type": "string", "nullable": true }, "bic": { "type": "string", "nullable": true }, "wasPolicePresent": { "type": "boolean" }, "policeDepartment": { "type": "string", "nullable": true }, "policeReportNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessInsuranceClaimSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the ProcessInsuranceClaim's Description.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "processId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ProcessInsuranceClaimWrite": { "required": [ "processId", "subTypeId", "typeId", "wasPolicePresent" ], "type": "object", "properties": { "processId": { "type": "integer", "format": "int32" }, "attributeGroupId": { "type": "integer", "format": "int32", "nullable": true }, "number": { "maxLength": 45, "type": "string", "nullable": true }, "brokerNumber": { "maxLength": 45, "type": "string", "nullable": true }, "damageDate": { "type": "string", "format": "date-time", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "subTypeId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "costEstimate": { "type": "number", "format": "double", "nullable": true }, "location": { "maxLength": 255, "type": "string", "nullable": true }, "isThirdPartyDamage": { "type": "boolean", "nullable": true }, "thirdPartyName": { "type": "string", "nullable": true }, "thirdPartyAddress": { "type": "string", "nullable": true }, "isEligibleForInputTax": { "type": "boolean", "nullable": true }, "isHouseholdContentInsured": { "type": "boolean", "nullable": true }, "householdContentInsurer": { "maxLength": 100, "type": "string", "nullable": true }, "householdContentInsuranceNumber": { "maxLength": 100, "type": "string", "nullable": true }, "commissionedMeasures": { "type": "string", "nullable": true }, "bankName": { "maxLength": 255, "type": "string", "nullable": true }, "iban": { "maxLength": 45, "type": "string", "nullable": true }, "bic": { "maxLength": 11, "type": "string", "nullable": true }, "wasPolicePresent": { "type": "boolean" }, "policeDepartment": { "maxLength": 100, "type": "string", "nullable": true }, "policeReportNumber": { "maxLength": 100, "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessNotificationRead": { "required": [ "hasBeenRead", "id", "initiatorId", "processFeedId", "processId", "recipientId", "typeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "processId": { "type": "integer", "format": "int32" }, "processFeedId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "initiatorId": { "type": "integer", "format": "int32" }, "recipientId": { "type": "integer", "format": "int32" }, "hasBeenRead": { "type": "boolean" }, "hasBeenReadByAccountId": { "type": "integer", "format": "int32", "nullable": true }, "hasBeenReadAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ProcessNotificationSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "processIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "processFeedIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "hasBeenRead": { "type": "boolean", "nullable": true }, "hasBeenReadByMe": { "type": "boolean", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ProcessNotificationWrite": { "required": [ "hasBeenRead", "initiatorId", "processFeedId", "processId", "recipientId", "typeId" ], "type": "object", "properties": { "processId": { "type": "integer", "format": "int32" }, "processFeedId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "initiatorId": { "type": "integer", "format": "int32" }, "recipientId": { "type": "integer", "format": "int32" }, "hasBeenRead": { "type": "boolean" } }, "additionalProperties": false }, "ProcessRead": { "required": [ "accountId", "contactId", "createdByPartyId", "fullyQualifiedNumber", "id", "isFinished", "typeId", "unitId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "number": { "type": "integer", "description": "A creator-party–specific number for this process.\nThis number is unique only within the scope of `CreatedByPartyId`\nand is assigned incrementally by the system.", "format": "int32", "nullable": true }, "fullyQualifiedNumber": { "type": "string", "description": "A globally unique identifier composed of the `Number`\nand the `CreatedByPartyId`.\nAllows unambiguous identification of a `Process` across the system." }, "subject": { "type": "string", "description": "A short, descriptive title summarizing the `Process` context.\n\nVisibility of the subject may depend on party-specific settings.\nFor example, property management companies can configure whether\nthe subject is shown or hidden in the user interface.", "nullable": true }, "report": { "type": "string", "description": "A rich-text (HTML-enabled) description providing detailed information\nabout the `Process` context and background.", "nullable": true }, "accountId": { "type": "integer", "description": "The ID of the `Account` that created the `Process`.\nUsually an `Account` belonging to the `Party` identified by `CreatedByPartyId`.\nThis value is set automatically when the `Process` is created.", "format": "int32" }, "contactId": { "type": "integer", "description": "The `Party` acting as the primary contact for this `Process`.\nThis may be a tenant, owner, contractor, or the property management\ncompany itself for internal processes.\nIt is set by the `Process` creator.", "format": "int32" }, "createdByPartyId": { "type": "integer", "description": "The `Party` that created the `Process`.\nThis value is set automatically on creation.", "format": "int32" }, "typeId": { "type": "integer", "description": "The ID of the `ProcessType` defining the overall classification\nand behavior of the process.", "format": "int32" }, "stageId": { "type": "integer", "description": "The ID of the current `ProcessStage` within the `Process` lifecycle.\nMay be `null` if no stage has been assigned yet.", "format": "int32", "nullable": true }, "isFinished": { "type": "boolean", "description": "Indicates whether the `Process` is currently finished.\nFinished processes may be reopened." }, "finishDate": { "type": "string", "description": "The date and time when the `Process` was marked as finished.\nThis date is only present, if `IsFinished` is `true`.", "format": "date-time", "nullable": true }, "unitId": { "type": "integer", "description": "The `Unit` this `Process` is associated with.", "format": "int32" }, "externalId": { "type": "string", "description": "An external identifier used when the `Process` is synchronized\nwith a third-party system.\nEnables API consumers to correlate external processes with facilioo\nprocesses without maintaining a separate ID mapping.", "nullable": true } }, "additionalProperties": false, "description": "Represents a business process within the system.\nA process models a long-running workflow such as a maintenance case,\nservice request or internal operational task." }, "ProcessSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Process' Number, Subject, and Report.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "fullyQualifiedNumber": { "type": "string", "description": "Filters by the fully qualified process number in the format \"{Number}/{CreatedByPartyId}\".", "nullable": true }, "shortNumber": { "type": "integer", "description": "Filters by the process number without the creator prefix.", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "description": "Filters processes assigned to units belonging to the specified property.", "format": "int32", "nullable": true }, "entranceId": { "type": "integer", "description": "Filters processes assigned to units within the specified entrance.", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "description": "Filters processes assigned to the specified unit.\nSearches the main unit of the process `Process.UnitId`, but also all additional linked units.", "format": "int32", "nullable": true }, "partyId": { "type": "integer", "description": "Returns processes that are accessible by the specified party.", "format": "int32", "nullable": true }, "contactId": { "type": "integer", "description": "Returns processes where the specified party is set as contact.", "format": "int32", "nullable": true }, "createdByPartyId": { "type": "integer", "description": "Returns processes that are created by the specified party.", "format": "int32", "nullable": true }, "isFinished": { "type": "boolean", "description": "Filters processes by their completion status.", "nullable": true }, "createdInYear": { "type": "integer", "description": "Filters processes created in the specified year.", "format": "int32", "nullable": true }, "createdInMonth": { "type": "integer", "description": "Filters processes created in the specified month.", "format": "int32", "nullable": true }, "createdInDay": { "type": "integer", "description": "Filters processes created on the specified day of the month.", "format": "int32", "nullable": true }, "externalId": { "type": "string", "description": "Filters processes by their external identifier.", "nullable": true }, "haveNotificationsBeenReadByMe": { "type": "boolean", "description": "Filters processes based on whether notifications for the current authenticated user have been marked as read or not.", "nullable": true }, "typeId": { "type": "integer", "description": "Filters processes by their type.", "format": "int32", "nullable": true }, "stageId": { "type": "integer", "description": "Filters processes by their current stage.", "format": "int32", "nullable": true }, "userTaskId": { "type": "integer", "description": "Returns processes that contain the specified user task.", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ProcessStageProcessTypeRead": { "required": [ "order", "processStageId", "processTypeId" ], "type": "object", "properties": { "processTypeId": { "type": "integer", "format": "int32" }, "processStageId": { "type": "integer", "format": "int32" }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProcessStageRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessStageSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the ProcessStage's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "name": { "type": "string", "description": "Matches for equality (case-sensitive). To search based on a substring, use the `SearchTerm` parameter.", "nullable": true } }, "additionalProperties": false }, "ProcessStageWrite": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false }, "ProcessTypeRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "partyTypeId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProcessWrite": { "required": [ "contactId", "report", "typeId", "unitId" ], "type": "object", "properties": { "accountId": { "type": "integer", "description": "The ID of the account creating the process.\nIf omitted, the account is derived from the authenticated user.", "format": "int32", "nullable": true }, "subject": { "type": "string", "description": "A short, descriptive title summarizing the process context.\n\nVisibility of the subject may depend on party-specific settings.\nFor example, property management companies can configure whether\nthe subject is shown or hidden in the user interface.", "nullable": true }, "report": { "minLength": 1, "type": "string", "description": "A rich-text (HTML-enabled) description providing detailed information\nabout the process context." }, "contactId": { "type": "integer", "description": "The party acting as the primary contact for this process.", "format": "int32" }, "typeId": { "type": "integer", "description": "The ID of the `ProcessType` defining the classification of the process.", "format": "int32" }, "stageId": { "type": "integer", "description": "The initial or updated `ProcessStage` of the process.", "format": "int32", "nullable": true }, "isFinished": { "type": "boolean", "description": "Indicates whether the process should be marked as finished.", "default": false, "nullable": true }, "finishDate": { "type": "string", "description": "The date and time when the process was finished.\nThis date can only be set, if `IsFinished` is `true`.\nIt will fall back to the current timestamp, if `IsFinished` is `true`.\nIf `IsFinished` is `false`, this date will be always set to `null`.", "format": "date-time", "nullable": true }, "unitId": { "type": "integer", "description": "The unit this process is associated with.", "format": "int32" }, "externalId": { "type": "string", "description": "External identifier used when synchronizing this process\nwith a third-party system.", "nullable": true } }, "additionalProperties": false, "description": "Defines the data required to create or update a process." }, "PropertyEmergencyContactRead": { "required": [ "id", "propertyId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "propertyId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "contactInformation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PropertyEmergencyContactSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the PropertyEmergencyContact's Name and ContactInformation.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "propertyId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PropertyEmergencyContactWrite": { "required": [ "contactInformation", "name", "propertyId" ], "type": "object", "properties": { "propertyId": { "type": "integer", "format": "int32" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "contactInformation": { "maxLength": 255, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "PropertyRead": { "required": [ "eligibleUnitsSelected", "id", "isArchived", "parentId", "resolutionCollectionStartOffset", "tenantId", "unitsCount" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "tenantId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "fullStreet": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "resolutionCollectionStartOffset": { "type": "integer", "format": "int32" }, "imageId": { "type": "integer", "format": "int32", "nullable": true }, "isArchived": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true }, "externalOldId": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "key": { "type": "string", "nullable": true }, "unitsCount": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "eligibleUnitsSelected": { "type": "boolean" } }, "additionalProperties": false }, "PropertyRoleDefaultRead": { "required": [ "forPropertyManagementCompanyId", "id", "roleId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "forPropertyManagementCompanyId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PropertyRoleMapping": { "required": [ "accountId", "propertyId", "roleId" ], "type": "object", "properties": { "propertyId": { "type": "integer", "description": "The ID of the `Property` associated with this mapping.", "format": "int32" }, "accountId": { "type": "integer", "description": "The ID of the `Account` associated with this mapping.", "format": "int32" }, "roleId": { "type": "integer", "description": "The ID of the `PropertyRole` assigned to this account-property relation. An account can have multiple assignments to the same property, with different roles.", "format": "int32" } }, "additionalProperties": false }, "PropertyRoleRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PropertySearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Property's Name, Number, FullStreet, and City.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "externalId": { "type": "string", "nullable": true }, "attributeName": { "type": "string", "nullable": true }, "attributeValue": { "type": "string", "nullable": true }, "unitIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "managedByPropertyManagementCompanyId": { "type": "integer", "format": "int32", "nullable": true }, "fullAddress": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PropertyWrite": { "required": [ "city", "fullStreet", "name", "number", "resolutionCollectionStartOffset", "tenantId", "zipCode" ], "type": "object", "properties": { "tenantId": { "type": "integer", "format": "int32" }, "number": { "maxLength": 45, "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "fullStreet": { "maxLength": 255, "type": "string" }, "zipCode": { "maxLength": 255, "type": "string" }, "city": { "maxLength": 255, "type": "string" }, "resolutionCollectionStartOffset": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true }, "externalOldId": { "maxLength": 50, "type": "string", "nullable": true }, "latitude": { "maximum": 90, "minimum": -90, "type": "number", "format": "double", "nullable": true }, "longitude": { "maximum": 180, "minimum": -180, "type": "number", "format": "double", "nullable": true }, "imageId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ProtocolCreate": { "required": [ "printConferenceDetailsOnProtocol", "printConferenceResultsOnProtocol", "printTopicDescriptionsOnProtocol", "printTopicTitlesOnProtocol", "protocolInfoTextFont", "protocolInfoTextSize", "protocolResolutionTextFont", "protocolResolutionTextSize", "protocolResolutionTitleFont", "protocolResolutionTitleSize", "protocolResultTextFont", "protocolResultTextSize", "protocolTopicDescriptionFont", "protocolTopicDescriptionSize", "protocolTopicTitleFont", "protocolTopicTitleSize" ], "type": "object", "properties": { "protocolInfoTextFont": { "type": "string" }, "protocolInfoTextSize": { "type": "integer", "format": "int32" }, "protocolTopicTitleFont": { "type": "string" }, "protocolTopicTitleSize": { "type": "integer", "format": "int32" }, "protocolTopicDescriptionFont": { "type": "string" }, "protocolTopicDescriptionSize": { "type": "integer", "format": "int32" }, "protocolResolutionTitleFont": { "type": "string" }, "protocolResolutionTitleSize": { "type": "integer", "format": "int32" }, "protocolResolutionTextFont": { "type": "string" }, "protocolResolutionTextSize": { "type": "integer", "format": "int32" }, "protocolResultTextFont": { "type": "string" }, "protocolResultTextSize": { "type": "integer", "format": "int32" }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "endedAt": { "type": "string", "format": "date-time", "nullable": true }, "printConferenceDetailsOnProtocol": { "type": "boolean" }, "printTopicTitlesOnProtocol": { "type": "boolean" }, "printTopicDescriptionsOnProtocol": { "type": "boolean" }, "printConferenceResultsOnProtocol": { "type": "boolean" } }, "additionalProperties": false }, "RefreshTokenRequest": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" } }, "additionalProperties": false }, "RegenerateInquiryDetailsRequest": { "required": [ "fields" ], "type": "object", "properties": { "feedback": { "type": "string", "description": "Optional free-text instruction for refining the previously generated title/summary/labels.\nOmit for a fresh generation.", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryAiEvaluationDetailField" }, "description": "The detail fields to regenerate. Omit or send an empty list to regenerate all fields\n(Subject, Summary and Labels); otherwise only the listed fields are persisted, leaving the\nothers untouched. The AI is always called for the full set regardless — this only controls\nwhich parts of its result are stored." } }, "additionalProperties": false, "description": "Request body for regenerating an inquiry's AI evaluation." }, "ResendChallengeRequest": { "required": [ "nonce" ], "type": "object", "properties": { "nonce": { "type": "string" } }, "additionalProperties": false }, "Resolution": { "required": [ "addToAgenda", "addToProtocol", "resolutionId", "resolutionNumber", "topicId", "topicNumber" ], "type": "object", "properties": { "resolutionId": { "type": "integer", "format": "int32" }, "resolutionNumber": { "type": "integer", "format": "int32" }, "topicId": { "type": "integer", "format": "int32" }, "topicNumber": { "type": "integer", "format": "int32" }, "addToProtocol": { "type": "boolean" }, "addToAgenda": { "type": "boolean" } }, "additionalProperties": false }, "ResolutionAttachmentRead": { "required": [ "addToAgenda", "addToProtocol", "fileId", "id", "resolutionId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "resolutionId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32" }, "addToProtocol": { "type": "boolean" }, "addToAgenda": { "type": "boolean" } }, "additionalProperties": false }, "ResolutionAttachmentWrite": { "type": "object", "properties": { "addToProtocol": { "type": "boolean", "nullable": true }, "addToAgenda": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ResolutionOptionRead": { "required": [ "id", "number", "resolutionId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "number": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "resolutionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResolutionOptionTemplateRead": { "required": [ "id", "resolutionTemplateId", "title" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "title": { "type": "string" }, "resolutionText": { "type": "string", "nullable": true }, "resolutionTemplateId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResolutionOptionTemplateSearchRequest": { "required": [ "resolutionTemplateId" ], "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "resolutionTemplateId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResolutionOptionTemplateWrite": { "required": [ "resolutionTemplateId", "title" ], "type": "object", "properties": { "title": { "maxLength": 255, "minLength": 1, "type": "string" }, "resolutionText": { "maxLength": 255, "type": "string", "nullable": true }, "resolutionTemplateId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResolutionOptionWrite": { "required": [ "resolutionId" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "resolutionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResolutionRead": { "required": [ "addToCollection", "hasBeenSkipped", "hasOptionsVoting", "hasSimpleVoting", "id", "isDependant", "number", "resolutionStatus", "title", "type", "votingMajorityId", "votingProcedureId", "wasManuallyEdited" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "number": { "type": "integer", "format": "int32" }, "collectionNumber": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "resolutionText": { "type": "string", "nullable": true }, "requiredPercentage": { "type": "number", "format": "double", "nullable": true }, "resolutionStatus": { "allOf": [ { "$ref": "#/components/schemas/ResolutionStatus" } ], "description": "Possible values:\n- 0 = Valid\n- 1 = Contested\n- 2 = Repealed\n- 3 = Changed\n- 4 = Deleted\n- 5 = Invalid" }, "note": { "type": "string", "nullable": true }, "topicId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "dependantOptionId": { "type": "integer", "format": "int32", "nullable": true }, "votingProcedureId": { "type": "integer", "format": "int32" }, "votingMajorityId": { "type": "integer", "format": "int32" }, "addToCollection": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ResolutionType" } ], "description": "Possible values:\n- 0 = SimpleVoting\n- 1 = MultiOptionVoting\n- 2 = MultiOptionVotingWithResolutions" }, "wasManuallyEdited": { "type": "boolean" }, "hasSimpleVoting": { "type": "boolean" }, "hasOptionsVoting": { "type": "boolean" }, "isDependant": { "type": "boolean" }, "processId": { "type": "integer", "format": "int32", "nullable": true }, "hasBeenSkipped": { "type": "boolean" }, "selectedOptionId": { "type": "integer", "format": "int32", "nullable": true }, "votedOptionId": { "type": "integer", "format": "int32", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVotingSession" } ], "description": "Possible values:\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option", "nullable": true }, "defaultToSumVote": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ResolutionSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "conferenceId": { "type": "integer", "format": "int32", "nullable": true }, "topicId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "inResolutionCollection": { "type": "boolean", "nullable": true }, "inConference": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ResolutionStatus": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "Possible values:\n- 0 = Valid\n- 1 = Contested\n- 2 = Repealed\n- 3 = Changed\n- 4 = Deleted\n- 5 = Invalid", "format": "int32" }, "ResolutionTemplateRead": { "required": [ "addToCollection", "description", "id", "number", "resolutionText", "title", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string" }, "resolutionText": { "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ResolutionType" } ], "description": "Possible values:\n- 0 = SimpleVoting\n- 1 = MultiOptionVoting\n- 2 = MultiOptionVotingWithResolutions" }, "interfaceId": { "type": "integer", "format": "int32", "nullable": true }, "addToCollection": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "defaultToSumVote": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ResolutionTemplateWrite": { "required": [ "addToCollection", "description", "interfaceId", "resolutionText", "title", "type" ], "type": "object", "properties": { "title": { "maxLength": 500, "minLength": 1, "type": "string" }, "description": { "type": "string" }, "resolutionText": { "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ResolutionType" } ], "description": "Possible values:\n- 0 = SimpleVoting\n- 1 = MultiOptionVoting\n- 2 = MultiOptionVotingWithResolutions" }, "interfaceId": { "type": "integer", "format": "int32" }, "addToCollection": { "type": "boolean" }, "defaultToSumVote": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ResolutionType": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Possible values:\n- 0 = SimpleVoting\n- 1 = MultiOptionVoting\n- 2 = MultiOptionVotingWithResolutions", "format": "int32" }, "ResolutionWrite": { "required": [ "addToCollection", "resolutionStatus", "title", "type", "votingMajorityId", "votingProcedureId", "wasManuallyEdited" ], "type": "object", "properties": { "collectionNumber": { "type": "integer", "format": "int32", "nullable": true }, "title": { "maxLength": 500, "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "resolutionText": { "type": "string", "nullable": true }, "requiredPercentage": { "maximum": 100, "minimum": 1, "type": "number", "format": "double", "nullable": true }, "resolutionStatus": { "allOf": [ { "$ref": "#/components/schemas/ResolutionStatus" } ], "description": "Possible values:\n- 0 = Valid\n- 1 = Contested\n- 2 = Repealed\n- 3 = Changed\n- 4 = Deleted\n- 5 = Invalid" }, "topicId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "dependantOptionId": { "type": "integer", "format": "int32", "nullable": true }, "votingProcedureId": { "type": "integer", "format": "int32" }, "votingMajorityId": { "type": "integer", "format": "int32" }, "addToCollection": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ResolutionType" } ], "description": "Possible values:\n- 0 = SimpleVoting\n- 1 = MultiOptionVoting\n- 2 = MultiOptionVotingWithResolutions" }, "processId": { "type": "integer", "format": "int32", "nullable": true }, "selectedOptionId": { "type": "integer", "format": "int32", "nullable": true }, "votedOptionId": { "type": "integer", "format": "int32", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVotingSession" } ], "description": "Possible values:\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option", "nullable": true }, "wasManuallyEdited": { "type": "boolean" }, "defaultToSumVote": { "type": "boolean", "nullable": true }, "location": { "maxLength": 500, "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ResultsCount": { "type": "object", "properties": { "acceptedCount": { "type": "number", "format": "double", "nullable": true }, "declinedCount": { "type": "number", "format": "double", "nullable": true }, "abstentionCount": { "type": "number", "format": "double", "nullable": true }, "optionsCount": { "type": "array", "items": { "$ref": "#/components/schemas/OptionsResultCount" }, "nullable": true }, "optionsAbstentionCount": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "SearchChip": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string" }, "color": { "allOf": [ { "$ref": "#/components/schemas/SearchChipColor" } ], "description": "Possible values:\n- 0 = Primary\n- 1 = Secondary\n- 2 = Danger\n- 3 = Warning\n- 4 = Success\n- 5 = Grey\n- 6 = Purple\n- 7 = Pink\n- 8 = Highlight\n- 9 = InvisGrey\n- 10 = InvisHighlight\n- 11 = HeavyDanger\n- 12 = HeavyHighlight", "nullable": true }, "icon": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SearchChipColor": { "enum": [ "primary", "secondary", "danger", "warning", "success", "grey", "purple", "pink", "highlight", "invisGrey", "invisHighlight", "heavyDanger", "heavyHighlight" ], "type": "string", "description": "Possible values:\n- 0 = Primary\n- 1 = Secondary\n- 2 = Danger\n- 3 = Warning\n- 4 = Success\n- 5 = Grey\n- 6 = Purple\n- 7 = Pink\n- 8 = Highlight\n- 9 = InvisGrey\n- 10 = InvisHighlight\n- 11 = HeavyDanger\n- 12 = HeavyHighlight" }, "SearchContext": { "type": "object", "properties": { "number": { "type": "string", "nullable": true }, "partyTypeId": { "type": "integer", "format": "int32", "nullable": true }, "partyTypeName": { "type": "string", "nullable": true }, "tenantId": { "type": "integer", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "entranceId": { "type": "integer", "format": "int32", "nullable": true }, "entranceName": { "type": "string", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "unitName": { "type": "string", "nullable": true }, "unitContractId": { "type": "integer", "format": "int32", "nullable": true }, "unitContractName": { "type": "string", "nullable": true }, "tradeId": { "type": "integer", "format": "int32", "nullable": true }, "tradeName": { "type": "string", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "partyName": { "type": "string", "nullable": true }, "party2Id": { "type": "integer", "format": "int32", "nullable": true }, "party2Name": { "type": "string", "nullable": true }, "inquirySourceId": { "type": "integer", "format": "int32", "nullable": true }, "inquiryCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "processId": { "type": "integer", "format": "int32", "nullable": true }, "processName": { "type": "integer", "format": "int32", "nullable": true }, "fileId": { "type": "integer", "format": "int32", "nullable": true }, "page": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SearchQueryResultItem": { "required": [ "chips", "contextLine", "entityId", "entityName", "title", "type" ], "type": "object", "properties": { "entityId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "entityIcon": { "type": "string", "nullable": true }, "entityName": { "type": "string" }, "title": { "type": "string" }, "contextLine": { "type": "string" }, "textMatch": { "type": "string", "nullable": true }, "chips": { "type": "array", "items": { "$ref": "#/components/schemas/SearchChip" } }, "url": { "type": "string", "nullable": true }, "page": { "type": "integer", "format": "int32", "nullable": true }, "fileId": { "type": "integer", "format": "int32", "nullable": true }, "context": { "allOf": [ { "$ref": "#/components/schemas/SearchContext" } ], "nullable": true } }, "additionalProperties": false }, "SetAttendanceRequest": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/AttendanceType" } ], "description": "Possible values:\n- 1 = Online\n- 2 = Onsite\n- 3 = Represented\n- 4 = NoParticipation" } }, "additionalProperties": false }, "SettingsRead": { "required": [ "areForProperty", "areGlobal", "defaultVotingMajorityId", "defaultVotingProcedureId", "id", "interfaceId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "interfaceId": { "type": "integer", "format": "int32" }, "defaultVotingProcedureId": { "type": "integer", "format": "int32" }, "defaultVotingMajorityId": { "type": "integer", "format": "int32" }, "defaultTimerLength": { "type": "integer", "format": "int32", "nullable": true }, "shouldImportToProcessFeed": { "type": "boolean", "nullable": true }, "invitationLetterBackgroundFileId": { "type": "integer", "format": "int32", "nullable": true }, "agendaBackgroundFileId": { "type": "integer", "format": "int32", "nullable": true }, "protocolBackgroundFileId": { "type": "integer", "format": "int32", "nullable": true }, "mandateBackgroundFileId": { "type": "integer", "format": "int32", "nullable": true }, "mandateDocumentGroupId": { "type": "integer", "format": "int32", "nullable": true }, "coverLetterDocumentGroupId": { "type": "integer", "format": "int32", "nullable": true }, "onSitePresentationDescription": { "type": "string", "nullable": true }, "onSitePresentationTitleBackgroundColor": { "type": "string", "nullable": true }, "onSitePresentationBodyBackgroundColor": { "type": "string", "nullable": true }, "onSitePresentationTitleTextColor": { "type": "string", "nullable": true }, "onSitePresentationBodyTextColor": { "type": "string", "nullable": true }, "oneSitePresentationImageMode": { "allOf": [ { "$ref": "#/components/schemas/OneSitePresentationImageMode" } ], "description": "Possible values:\n- 1 = Property\n- 2 = Static\n- 3 = Custom", "nullable": true }, "onSiteStaticPresentationImageId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "areForProperty": { "type": "boolean" }, "areGlobal": { "type": "boolean" }, "defaultToSumVote": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "SettingsWrite": { "required": [ "defaultVotingMajorityId", "defaultVotingProcedureId", "interfaceId" ], "type": "object", "properties": { "interfaceId": { "type": "integer", "format": "int32" }, "defaultVotingProcedureId": { "type": "integer", "format": "int32" }, "defaultVotingMajorityId": { "type": "integer", "format": "int32" }, "defaultTimerLength": { "type": "integer", "format": "int32", "nullable": true }, "shouldImportToProcessFeed": { "type": "boolean", "nullable": true }, "invitationLetterBackgroundFileId": { "type": "integer", "format": "int32", "nullable": true }, "agendaBackgroundFileId": { "type": "integer", "format": "int32", "nullable": true }, "protocolBackgroundFileId": { "type": "integer", "format": "int32", "nullable": true }, "mandateBackgroundFileId": { "type": "integer", "format": "int32", "nullable": true }, "mandateDocumentGroupId": { "type": "integer", "format": "int32", "nullable": true }, "coverLetterDocumentGroupId": { "type": "integer", "format": "int32", "nullable": true }, "onSitePresentationDescription": { "maxLength": 65535, "type": "string", "nullable": true }, "onSitePresentationTitleBackgroundColor": { "maxLength": 7, "minLength": 7, "type": "string", "nullable": true }, "onSitePresentationBodyBackgroundColor": { "maxLength": 7, "minLength": 7, "type": "string", "nullable": true }, "onSitePresentationTitleTextColor": { "maxLength": 7, "minLength": 7, "type": "string", "nullable": true }, "onSitePresentationBodyTextColor": { "maxLength": 7, "minLength": 7, "type": "string", "nullable": true }, "oneSitePresentationImageMode": { "allOf": [ { "$ref": "#/components/schemas/OneSitePresentationImageMode" } ], "description": "Possible values:\n- 1 = Property\n- 2 = Static\n- 3 = Custom", "nullable": true }, "onSiteStaticPresentationImageId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "defaultToSumVote": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "SharesResponse": { "required": [ "unitId" ], "type": "object", "properties": { "unitId": { "type": "integer", "format": "int32" }, "shares": { "type": "number", "format": "double", "nullable": true }, "error": { "allOf": [ { "$ref": "#/components/schemas/Error" } ], "nullable": true } }, "additionalProperties": false }, "SigneeRead": { "required": [ "conferenceId", "fullName", "id", "role" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "fullName": { "type": "string" }, "role": { "type": "string" }, "conferenceId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SigneeWrite": { "required": [ "conferenceId", "fullName", "role" ], "type": "object", "properties": { "fullName": { "maxLength": 255, "type": "string" }, "role": { "maxLength": 255, "type": "string" }, "conferenceId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SmartLockRead": { "required": [ "deviceId", "id", "propertyId", "typeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "propertyId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "deviceId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SmartLockSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "propertyIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "SmartLockTypeRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SsoResponse": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } }, "additionalProperties": false }, "SumVoteRead": { "required": [ "decision", "id", "isOptionVote", "isRegularVote", "votingSessionId", "weight" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "votingSessionId": { "type": "integer", "format": "int32" }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent" }, "isOptionVote": { "type": "boolean" }, "isRegularVote": { "type": "boolean" }, "resolutionOptionId": { "type": "integer", "format": "int32", "nullable": true }, "weight": { "type": "number", "format": "double" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TenantPartyAccess": { "required": [ "mode", "partyId", "tenantId" ], "type": "object", "properties": { "partyId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "integer", "format": "int32" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/TenantPartyAccessMode" } ], "description": "Possible values:\n- 0 = OnlyProcesses\n- 1 = PropertiesUnits\n- 2 = Contracts" } }, "additionalProperties": false }, "TenantPartyAccessCreate": { "required": [ "mode", "partyId" ], "type": "object", "properties": { "partyId": { "type": "integer", "format": "int32" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/TenantPartyAccessMode" } ], "description": "Possible values:\n- 0 = OnlyProcesses\n- 1 = PropertiesUnits\n- 2 = Contracts" } }, "additionalProperties": false }, "TenantPartyAccessMode": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Possible values:\n- 0 = OnlyProcesses\n- 1 = PropertiesUnits\n- 2 = Contracts", "format": "int32" }, "TenantRead": { "required": [ "feedback", "hidden", "id", "ownerPartyId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "ownerPartyId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "invoiceAddressTitle": { "type": "string", "nullable": true }, "invoiceAddressCareOf": { "type": "string", "nullable": true }, "invoiceAddressStreetWithNumber": { "type": "string", "nullable": true }, "invoiceAddressZipCode": { "type": "string", "nullable": true }, "invoiceAddressLocation": { "type": "string", "nullable": true }, "hidden": { "type": "boolean" }, "feedback": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TenantSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Tenant's Title.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "externalId": { "type": "string", "nullable": true }, "hidden": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TenantWrite": { "required": [ "hidden", "number", "title" ], "type": "object", "properties": { "number": { "maxLength": 45, "type": "string" }, "title": { "maxLength": 255, "type": "string" }, "invoiceAddressTitle": { "maxLength": 255, "type": "string", "nullable": true }, "invoiceAddressCareOf": { "maxLength": 255, "type": "string", "nullable": true }, "invoiceAddressStreetWithNumber": { "maxLength": 255, "type": "string", "nullable": true }, "invoiceAddressZipCode": { "maxLength": 255, "type": "string", "nullable": true }, "invoiceAddressLocation": { "maxLength": 255, "type": "string", "nullable": true }, "hidden": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TermRead": { "required": [ "id", "isActive" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "text": { "type": "string", "nullable": true }, "privacyText": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "ThemeMode": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Possible values:\n- 0 = Light\n- 1 = Dark\n- 2 = System", "format": "int32" }, "ThumbnailQueryResponse": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string" } }, "additionalProperties": false }, "TokenPair": { "required": [ "accessToken", "refreshToken" ], "type": "object", "properties": { "accessToken": { "type": "string" }, "refreshToken": { "allOf": [ { "$ref": "#/components/schemas/AuthSession" } ] } }, "additionalProperties": false }, "Topic": { "required": [ "addToAgenda", "addToProtocol", "topicId", "topicNumber" ], "type": "object", "properties": { "topicId": { "type": "integer", "format": "int32" }, "topicNumber": { "type": "integer", "format": "int32" }, "addToProtocol": { "type": "boolean" }, "addToAgenda": { "type": "boolean" } }, "additionalProperties": false }, "TopicAttachmentRead": { "required": [ "addToAgenda", "addToProtocol", "fileId", "id", "topicId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "topicId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32" }, "addToProtocol": { "type": "boolean" }, "addToAgenda": { "type": "boolean" } }, "additionalProperties": false }, "TopicAttachmentWrite": { "type": "object", "properties": { "addToProtocol": { "type": "boolean", "nullable": true }, "addToAgenda": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TopicNoteRead": { "required": [ "id", "lastEditedByAccountId", "lastEditedByPartyId", "number", "text", "title", "topicId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "title": { "type": "string" }, "text": { "type": "string" }, "number": { "type": "integer", "format": "int32" }, "topicId": { "type": "integer", "format": "int32" }, "lastEditedByPartyId": { "type": "integer", "format": "int32" }, "lastEditedByAccountId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TopicNoteSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "topicId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "TopicNoteWrite": { "required": [ "number", "text", "title", "topicId" ], "type": "object", "properties": { "title": { "type": "string" }, "text": { "type": "string" }, "number": { "type": "integer", "format": "int32" }, "topicId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TopicRead": { "required": [ "id", "number", "title" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "number": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "conferenceId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "TopicSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "conferenceId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "withoutConference": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TopicTemplateRead": { "required": [ "id", "interfaceId", "name", "number" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "interfaceId": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TopicTemplateResolutionTemplateRead": { "required": [ "id", "number", "resolutionTemplateId", "topicTemplateId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "topicTemplateId": { "type": "integer", "format": "int32" }, "resolutionTemplateId": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TopicTemplateResolutionTemplateWrite": { "required": [ "number", "resolutionTemplateId", "topicTemplateId" ], "type": "object", "properties": { "topicTemplateId": { "type": "integer", "format": "int32" }, "resolutionTemplateId": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TopicTemplateWrite": { "required": [ "interfaceId", "name" ], "type": "object", "properties": { "name": { "maxLength": 500, "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "interfaceId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TopicWrite": { "required": [ "title" ], "type": "object", "properties": { "title": { "maxLength": 500, "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "conferenceId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "TradeRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TradeSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Trade's Name.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "partyId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "TradeWrite": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "color": { "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": "string", "nullable": true } }, "additionalProperties": false }, "UnblockRecoveryCodeRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email of the user whose recovery code should be unblocked." } }, "additionalProperties": false }, "UnblockRecoveryCodeResponse": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email of the user whose recovery code was unblocked." } }, "additionalProperties": false }, "UnitContractRead": { "required": [ "id", "isArchived", "partyId", "type", "unitId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "number": { "type": "string", "nullable": true }, "effectiveFrom": { "type": "string", "format": "date-time", "nullable": true }, "terminationAt": { "type": "string", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32" }, "unitId": { "type": "integer", "format": "int32" }, "type": { "type": "integer", "format": "int32" }, "isArchived": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnitContractSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the UnitContract's Number.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "isActive": { "type": "boolean", "description": "Filters unit contracts based on the effective contract state, i.e., comparing the `EffectiveFrom` and `TerminationAt` dates against the current timestamp as upper and lower boundaries.\nIf either one of the dates is `null`, this side of the boundary is immediately considered as active.\nThree-way filter logic: `null` => all, `true` => active unit contracts, and `false` => inactive unit contracts.", "nullable": true }, "unitId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "entranceId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "propertyId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "partyId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "number": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/LegacyUnitContractType" } ], "description": "Possible values:\n- 1 = BoardChairman\n- 2 = BoardMember\n- 3 = Owner\n- 4 = Tenant\n- 5 = Subtenant\n- 6 = Resident\n- 7 = SpecialOwner\n- 8 = PropertyOwner\n- 9 = AuthorizedOwnerRecipient\n- 10 = AuthorizedTenantRecipient\n- 11 = AuthorizedPropertyOwnerRecipient", "nullable": true }, "unitTypeId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnitContractTypeRead": { "required": [ "icon", "id", "name", "order" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string" }, "order": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UnitContractWrite": { "required": [ "partyId", "type", "unitId" ], "type": "object", "properties": { "number": { "type": "string", "nullable": true }, "effectiveFrom": { "type": "string", "format": "date-time", "nullable": true }, "terminationAt": { "type": "string", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "format": "int32" }, "unitId": { "type": "integer", "format": "int32" }, "type": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnitHoldingTypeRead": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" } }, "additionalProperties": false }, "UnitRead": { "required": [ "entranceId", "holdingTypeId", "id", "isArchived", "typeId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "holdingTypeId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true }, "entranceId": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean", "nullable": true }, "squareMeters": { "type": "number", "format": "double", "nullable": true }, "roomCount": { "type": "number", "format": "double", "nullable": true }, "rentReduction": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "externalIdOld": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean" } }, "additionalProperties": false }, "UnitSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the Unit's Number and Position.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "externalId": { "type": "string", "nullable": true }, "eligibleInResolutionId": { "type": "integer", "format": "int32", "nullable": true }, "notEligibleInResolutionId": { "type": "integer", "format": "int32", "nullable": true }, "entranceId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "number": { "type": "string", "nullable": true }, "typeId": { "type": "integer", "format": "int32", "nullable": true }, "isHidden": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UnitTypeRead": { "required": [ "icon", "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "icon": { "type": "string" } }, "additionalProperties": false }, "UnitWrite": { "required": [ "entranceId", "holdingTypeId", "typeId" ], "type": "object", "properties": { "typeId": { "maximum": 8, "minimum": 1, "type": "integer", "format": "int32" }, "holdingTypeId": { "maximum": 2, "minimum": 1, "type": "integer", "format": "int32" }, "number": { "maxLength": 45, "type": "string", "nullable": true }, "position": { "maxLength": 255, "type": "string", "nullable": true }, "entranceId": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean", "nullable": true }, "squareMeters": { "type": "number", "format": "double", "nullable": true }, "roomCount": { "type": "number", "format": "double", "nullable": true }, "rentReduction": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "externalIdOld": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UploadFileRequest": { "type": "object", "properties": { "enforceContentType": { "type": "boolean", "description": "Optional flag that enforces the `Content-Type` header when uploading the file via the generated pre-signed URL.\n \nIf enabled and a MIME type is defined for the file (`File.Type.MimeType`),\nthe generated upload URL will require the client to use the same `Content-Type` header.\nUpload requests with a different or missing `Content-Type` will be rejected by the storage provider.\n \nNote: This does not validate the actual file content. It only enforces the HTTP header used during upload.\n \nDefaults to `false`. This will default to `true` in a future API version.", "default": false, "nullable": true } }, "additionalProperties": false }, "UserTaskCollectionRead": { "required": [ "id", "isSharedAcrossAccounts", "ownerId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "ownerId": { "type": "integer", "format": "int32" }, "parentCollectionId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true }, "isSharedAcrossAccounts": { "type": "boolean" } }, "additionalProperties": false }, "UserTaskCollectionWrite": { "required": [ "isSharedAcrossAccounts", "ownerId" ], "type": "object", "properties": { "ownerId": { "type": "integer", "format": "int32" }, "parentCollectionId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "nullable": true }, "isSharedAcrossAccounts": { "type": "boolean" } }, "additionalProperties": false }, "UserTaskFeedEntryRead": { "required": [ "creatorId", "id", "userTaskId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "userTaskId": { "type": "integer", "format": "int32" }, "creatorId": { "type": "integer", "format": "int32" }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserTaskNotificationRead": { "required": [ "id", "initiatorAccountId", "recipientAccountId", "typeId", "userTaskId", "wasRead" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "userTaskId": { "type": "integer", "format": "int32" }, "initiatorAccountId": { "type": "integer", "format": "int32" }, "recipientAccountId": { "type": "integer", "format": "int32" }, "wasRead": { "type": "boolean" }, "readByAccountId": { "type": "integer", "format": "int32", "nullable": true }, "readAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UserTaskNotificationWrite": { "required": [ "initiatorAccountId", "recipientAccountId", "typeId", "userTaskId", "wasRead" ], "type": "object", "properties": { "typeId": { "type": "integer", "format": "int32" }, "userTaskId": { "type": "integer", "format": "int32" }, "initiatorAccountId": { "type": "integer", "format": "int32" }, "recipientAccountId": { "type": "integer", "format": "int32" }, "wasRead": { "type": "boolean" } }, "additionalProperties": false }, "UserTaskPriorityRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "ordinal": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UserTaskRead": { "required": [ "creatorId", "id", "isCompleted", "isEmail", "primaryAssigneeId", "priorityId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "creatorId": { "type": "integer", "format": "int32" }, "collectionId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToPropertyId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToUnitId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToUnitContractId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToPartyId": { "type": "integer", "format": "int32", "nullable": true }, "primaryAssigneeId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "priorityId": { "type": "integer", "format": "int32" }, "isEmail": { "type": "boolean" }, "deadline": { "type": "string", "format": "date-time", "nullable": true }, "isCompleted": { "type": "boolean" }, "completedById": { "type": "integer", "format": "int32", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UserTaskSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the UserTask's ID, and Description.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "creatorId": { "type": "integer", "format": "int32", "nullable": true }, "collectionId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToPropertyId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToUnitId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToUnitContractId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToPartyId": { "type": "integer", "format": "int32", "nullable": true }, "primaryAssigneeId": { "type": "integer", "format": "int32", "nullable": true }, "priorityId": { "type": "integer", "format": "int32", "nullable": true }, "isEmail": { "type": "boolean", "nullable": true }, "isCompleted": { "type": "boolean", "nullable": true }, "completedById": { "type": "integer", "format": "int32", "nullable": true }, "processId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UserTaskWrite": { "required": [ "description", "isCompleted", "isEmail", "primaryAssigneeId", "priorityId" ], "type": "object", "properties": { "collectionId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToPropertyId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToUnitId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToUnitContractId": { "type": "integer", "format": "int32", "nullable": true }, "linkedToPartyId": { "type": "integer", "format": "int32", "nullable": true }, "primaryAssigneeId": { "type": "integer", "format": "int32" }, "description": { "minLength": 1, "type": "string" }, "priorityId": { "type": "integer", "format": "int32" }, "isEmail": { "type": "boolean" }, "deadline": { "type": "string", "format": "date-time", "nullable": true }, "isCompleted": { "type": "boolean" } }, "additionalProperties": false }, "ViewSettingCardinality": { "enum": [ 0, 1 ], "type": "integer", "description": "Whether a view setting group may hold multiple view settings per owner.\nfacilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingCardinality.Single — at most one row per owner (e.g. sidebar width).facilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingCardinality.Multi — many rows per owner (e.g. table views / sub-tabs).\nThe server enforces this on create.\n\nPossible values:\n- 0 = Single\n- 1 = Multi", "format": "int32" }, "ViewSettingGroupRead": { "required": [ "cardinality", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "key": { "type": "string", "description": "Stable group code, e.g. `INQUIRY_TABLE_VIEW`.", "nullable": true }, "cardinality": { "allOf": [ { "$ref": "#/components/schemas/ViewSettingCardinality" } ], "description": "Whether a view setting group may hold multiple view settings per owner.\nfacilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingCardinality.Single — at most one row per owner (e.g. sidebar width).facilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingCardinality.Multi — many rows per owner (e.g. table views / sub-tabs).\nThe server enforces this on create.\n\nPossible values:\n- 0 = Single\n- 1 = Multi" } }, "additionalProperties": false }, "ViewSettingGroupSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the ViewSettingGroup's Key.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "key": { "type": "string", "description": "Restrict to groups whose key contains this value.", "nullable": true }, "cardinality": { "allOf": [ { "$ref": "#/components/schemas/ViewSettingCardinality" } ], "description": "Restrict to groups with this cardinality.\n\nPossible values:\n- 0 = Single\n- 1 = Multi", "nullable": true } }, "additionalProperties": false }, "ViewSettingRead": { "required": [ "groupId", "id", "order", "scope" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "description": "Owning party, or `null` for system templates. Together with `AccountId` this\nis how the client tells the layer apart: (null, null) = system, (party, null) = party template,\n(party, account) = personal.", "format": "int32", "nullable": true }, "accountId": { "type": "integer", "description": "Owning account, or `null` for party/system templates. When set, `PartyId` is\nalways the party that account belongs to — there is no other combination when\n`AccountId` is non-null.", "format": "int32", "nullable": true }, "groupId": { "type": "integer", "description": "Id of the group this setting belongs to (see `ViewSettingGroupReadDto`).", "format": "int32" }, "order": { "type": "integer", "description": "Display order within the owner and group, relevant only for groups with Multi cardinality.\nDefaults to 0.", "format": "int32" }, "key": { "type": "string", "description": "Client-defined identifier, unique within the selected scope and group. Null for groups with\nSingle cardinality; required for groups with Multi cardinality.", "nullable": true }, "description": { "type": "string", "description": "Optional free-text description of this view setting.", "nullable": true }, "value": { "type": "string", "description": "Opaque JSON payload owned by the client.", "nullable": true }, "scope": { "allOf": [ { "$ref": "#/components/schemas/ViewSettingScope" } ], "description": "The ownership level a client targets when writing a view setting. The server derives the owner\ncolumns from this plus the auth context; the client never sends owner ids.\nfacilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.Personal → cid = PartyId, uid = AccountId.facilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.PartyTemplate → cid = PartyId, uid = null (party admins only).facilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.SystemTemplate → cid = null, uid = null (facilioo super-admins only).\n\nPossible values:\n- 0 = Personal\n- 1 = PartyTemplate\n- 2 = SystemTemplate", "readOnly": true } }, "additionalProperties": false }, "ViewSettingScope": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "The ownership level a client targets when writing a view setting. The server derives the owner\ncolumns from this plus the auth context; the client never sends owner ids.\nfacilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.Personal → cid = PartyId, uid = AccountId.facilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.PartyTemplate → cid = PartyId, uid = null (party admins only).facilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.SystemTemplate → cid = null, uid = null (facilioo super-admins only).\n\nPossible values:\n- 0 = Personal\n- 1 = PartyTemplate\n- 2 = SystemTemplate", "format": "int32" }, "ViewSettingSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the ViewSetting's Key.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "groupId": { "type": "integer", "description": "Restrict to view settings belonging to this group.", "format": "int32", "nullable": true }, "key": { "type": "string", "description": "Restrict to view settings with this exact client-defined key.", "nullable": true }, "scope": { "allOf": [ { "$ref": "#/components/schemas/ViewSettingScope" } ], "description": "Restrict to a single ownership level (derived from the owner columns within the accessible set).\n\nPossible values:\n- 0 = Personal\n- 1 = PartyTemplate\n- 2 = SystemTemplate", "nullable": true } }, "additionalProperties": false }, "ViewSettingWrite": { "required": [ "groupId", "scope", "value" ], "type": "object", "properties": { "scope": { "allOf": [ { "$ref": "#/components/schemas/ViewSettingScope" } ], "description": "The ownership level a client targets when writing a view setting. The server derives the owner\ncolumns from this plus the auth context; the client never sends owner ids.\nfacilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.Personal → cid = PartyId, uid = AccountId.facilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.PartyTemplate → cid = PartyId, uid = null (party admins only).facilioo.Domain.PropertyManagement.Types.ViewSettings.ViewSettingScope.SystemTemplate → cid = null, uid = null (facilioo super-admins only).\n\nPossible values:\n- 0 = Personal\n- 1 = PartyTemplate\n- 2 = SystemTemplate" }, "groupId": { "type": "integer", "description": "Id of the `ViewSettingGroup` this setting belongs to.", "format": "int32" }, "key": { "maxLength": 255, "type": "string", "description": "Client-defined identifier, unique within the selected scope and group. Must be null for groups\nwith Single cardinality; required for groups with Multi cardinality.", "nullable": true }, "description": { "type": "string", "description": "Optional free-text description of this view setting.", "nullable": true }, "order": { "type": "integer", "description": "Display order within the owner and group, relevant only for groups with Multi cardinality.\nOptional; defaults to 0 when omitted.", "format": "int32", "nullable": true }, "value": { "type": "string", "description": "Opaque JSON payload owned by the client." } }, "additionalProperties": false }, "Void": { "type": "object", "additionalProperties": false }, "VoteType": { "enum": [ 1, 2 ], "type": "integer", "description": "Possible values:\n- 1 = MandateVote\n- 2 = ConferenceVote", "format": "int32" }, "VotingEndReasonRead": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" } }, "additionalProperties": false }, "VotingGroupDocumentCreateFromTemplate": { "required": [ "documentTemplateId", "votingGroupId" ], "type": "object", "properties": { "documentTemplateId": { "type": "integer", "format": "int32" }, "votingGroupId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VotingGroupRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "conferenceId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "units": { "type": "array", "items": { "$ref": "#/components/schemas/UnitRead" }, "nullable": true }, "parties": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRead" }, "nullable": true } }, "additionalProperties": false }, "VotingGroupSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "conferenceId": { "type": "integer", "format": "int32", "nullable": true }, "votingSessionId": { "type": "integer", "format": "int32", "nullable": true }, "voteResult": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent", "nullable": true }, "optionId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "VotingGroupShares": { "required": [ "votingGroupId" ], "type": "object", "properties": { "votingGroupId": { "type": "integer", "format": "int32" }, "shares": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VotingGroupVoteRead": { "required": [ "decision", "id", "isOptionVote", "isRegularVote", "votingGroupId", "votingSessionId", "weight" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "votingGroupId": { "type": "integer", "format": "int32" }, "votingSessionId": { "type": "integer", "format": "int32" }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent" }, "isOptionVote": { "type": "boolean" }, "isRegularVote": { "type": "boolean" }, "resolutionOptionId": { "type": "integer", "format": "int32", "nullable": true }, "weight": { "type": "string" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VotingGroupVoteWrite": { "required": [ "decision", "votingGroupId", "votingSessionId", "weight" ], "type": "object", "properties": { "votingGroupId": { "type": "integer", "format": "int32" }, "votingSessionId": { "type": "integer", "format": "int32" }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVote" } ], "description": "Possible values:\n- 0 = Abstention\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option\n- 4 = SumVote\n- 5 = NotPresent" }, "resolutionOptionId": { "type": "integer", "format": "int32", "nullable": true }, "weight": { "type": "number", "format": "double" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VotingGroupWrite": { "type": "object", "properties": { "conferenceId": { "type": "integer", "format": "int32", "nullable": true }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VotingMajorityRead": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" } }, "additionalProperties": false }, "VotingProcedureRead": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string" } }, "additionalProperties": false }, "VotingSessionRead": { "required": [ "creatorId", "hasResultsSharedWithOwners", "hasSumVotes", "id", "isOptionVotingSession", "isRegularVotingSession", "resolutionId", "startedAt" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "resolutionId": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVotingSession" } ], "description": "Possible values:\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option", "nullable": true }, "votedOptionId": { "type": "integer", "format": "int32", "nullable": true }, "selectedOptionId": { "type": "integer", "format": "int32", "nullable": true }, "endReasonId": { "type": "integer", "format": "int32", "nullable": true }, "startedAt": { "type": "string", "format": "date-time" }, "votingEndedAt": { "type": "string", "format": "date-time", "nullable": true }, "endedAt": { "type": "string", "format": "date-time", "nullable": true }, "hasResultsSharedWithOwners": { "type": "boolean" }, "isOptionVotingSession": { "type": "boolean" }, "isRegularVotingSession": { "type": "boolean" }, "creatorId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true }, "hasSumVotes": { "type": "boolean" } }, "additionalProperties": false }, "VotingSessionWrite": { "required": [ "creatorId", "hasResultsSharedWithOwners", "hasSumVotes", "resolutionId", "startedAt" ], "type": "object", "properties": { "resolutionId": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/DecisionTypeOfVotingSession" } ], "description": "Possible values:\n- 1 = Accepted\n- 2 = Declined\n- 3 = Option", "nullable": true }, "votedOptionId": { "type": "integer", "format": "int32", "nullable": true }, "selectedOptionId": { "type": "integer", "format": "int32", "nullable": true }, "endReasonId": { "type": "integer", "format": "int32", "nullable": true }, "startedAt": { "type": "string", "format": "date-time" }, "votingEndedAt": { "type": "string", "format": "date-time", "nullable": true }, "endedAt": { "type": "string", "format": "date-time", "nullable": true }, "hasResultsSharedWithOwners": { "type": "boolean" }, "creatorId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "nullable": true }, "hasSumVotes": { "type": "boolean" } }, "additionalProperties": false }, "WebhookAttemptRead": { "required": [ "id", "tryCount", "webhookId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "webhookId": { "type": "integer", "description": "Identifier of the webhook this attempt belongs to.", "format": "int32" }, "scheduledAt": { "type": "string", "description": "Time when the attempt was scheduled for delivery.", "format": "date-time", "nullable": true }, "responseHttpStatusCode": { "type": "integer", "description": "HTTP status code returned by the target system, if any.", "format": "int32", "nullable": true }, "responseBody": { "type": "string", "description": "Response body returned by the target system, if any.", "nullable": true }, "tryCount": { "type": "integer", "description": "Number of delivery attempts that have been made.", "format": "int32" } }, "additionalProperties": false, "description": "Represents a single attempt to deliver a webhook,\nincluding scheduling, response details, and retry information." }, "WebhookEventRead": { "required": [ "entityName", "id", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of the webhook event (e.g., create, update, delete).\n\nPossible values:\n- 1 = Created\n- 2 = Updated\n- 3 = Deleted\n- 4 = ReplaceRelation\n- 5 = AddToRelation\n- 6 = RemoveFromRelation" }, "entityName": { "type": "string", "description": "The name of the entity associated with this event (e.g., `Process`, `Party`, etc.)." } }, "additionalProperties": false, "description": "Represents a webhook event definition, describing which type of event is triggered\nand the entity it relates to." }, "WebhookEventType": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "Possible values:\n- 1 = Created\n- 2 = Updated\n- 3 = Deleted\n- 4 = ReplaceRelation\n- 5 = AddToRelation\n- 6 = RemoveFromRelation", "format": "int32" }, "WebhookEventWrite": { "required": [ "entityName", "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/WebhookEventType" } ], "description": "The type of the webhook event (e.g., create, update, delete).\n\nPossible values:\n- 1 = Created\n- 2 = Updated\n- 3 = Deleted\n- 4 = ReplaceRelation\n- 5 = AddToRelation\n- 6 = RemoveFromRelation" }, "entityName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The name of the entity associated with this event (e.g., `Process`, `Party`, etc.)." } }, "additionalProperties": false, "description": "Defines the data required for creating or updating a webhook event, specifying the type of event\nand the related entity." }, "WebhookRead": { "required": [ "entityId", "entityJson", "eventId", "id", "messageGroupId", "state", "webhookRegistrationId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "webhookRegistrationId": { "type": "integer", "description": "The ID of the webhook registration this webhook belongs to.", "format": "int32" }, "eventId": { "type": "integer", "description": "The ID of the associated webhook event.", "format": "int32" }, "entityId": { "type": "integer", "description": "The ID of the entity related to this webhook.", "format": "int32" }, "state": { "allOf": [ { "$ref": "#/components/schemas/WebhookState" } ], "description": "The current state of the webhook.\n\nPossible values:\n- 1 = Created\n- 2 = Retrying\n- 3 = Successful\n- 4 = Failed\n- 5 = Aborted\n- 6 = Pending\n- 7 = Resolved" }, "relationName": { "type": "string", "description": "Optional name of the relation associated with this webhook.", "nullable": true }, "messageGroupId": { "type": "string", "description": "Group identifier used to organize related webhook messages." }, "entityJson": { "type": "string", "description": "The JSON payload representing the entity." } }, "additionalProperties": false, "description": "Represents a webhook instance with its current state and payload." }, "WebhookRegistrationCreate": { "required": [ "enabledEvents", "partyId", "shouldGroup", "shouldGroupContinueAfterFail", "targetAuthorization", "targetUrl" ], "type": "object", "properties": { "partyId": { "type": "integer", "description": "The ID of the party associated with this webhook registration.\nThat means, only actions made by this particular party in the facilioo will trigger a webhook.", "format": "int32" }, "targetUrl": { "maxLength": 2048, "minLength": 1, "type": "string", "description": "The URL where webhook messages should be sent via an HTTP POST request." }, "enabledEvents": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventWrite" }, "description": "The events that this webhook should be subscribed to." }, "shouldGroup": { "type": "boolean", "description": "If enabled, related messages are assigned to the same group.\nMessages within a group are always delivered in order, meaning a message will not be sent\nuntil the delivery of all earlier messages in the same group has succeeded.\n(e.g., Property - Entrance - Unit or Conference - Topic, are in the same group)" }, "shouldGroupContinueAfterFail": { "type": "boolean", "description": "If enabled, message delivery within a group continues even after a failure.\nIf disabled, a failed message blocks all subsequent messages in the same group\nuntil the failed delivery has been resolved." }, "targetAuthorization": { "allOf": [ { "$ref": "#/components/schemas/WebhookTargetAuthorizationWrite" } ], "description": "Authorization details for accessing the target URL." } }, "additionalProperties": false, "description": "Represents the data needed to create a webhook registration, including the target, enabled events, and authorization." }, "WebhookRegistrationRead": { "required": [ "enabledEvents", "id", "partyId", "shouldGroup", "shouldGroupContinueAfterFail", "targetAuthorization", "targetUrl" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "partyId": { "type": "integer", "description": "The ID of the party associated with this webhook registration.\nThat means, only actions made by this particular party in the facilioo will trigger a webhook.", "format": "int32" }, "targetUrl": { "type": "string", "description": "The URL to which webhook messages will be sent via an HTTP POST request." }, "enabledEvents": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventRead" }, "description": "List of events that are enabled for this registration." }, "shouldGroup": { "type": "boolean", "description": "If enabled, related messages are assigned to the same group.\nMessages within a group are always delivered in order, meaning a message will not be sent\nuntil the delivery of all earlier messages in the same group has succeeded.\n(e.g., Property - Entrance - Unit or Conference - Topic, are in the same group)" }, "shouldGroupContinueAfterFail": { "type": "boolean", "description": "If enabled, message delivery within a group continues even after a failure.\nIf disabled, a failed message blocks all subsequent messages in the same group\nuntil the failed delivery has been resolved." }, "targetAuthorization": { "allOf": [ { "$ref": "#/components/schemas/WebhookTargetAuthorizationRead" } ], "description": "Authorization information used to access the target URL." } }, "additionalProperties": false, "description": "Represents a webhook registration with its configuration and enabled events." }, "WebhookRegistrationSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "targetUrl": { "type": "string", "description": "Filter webhook registrations by target URL.", "nullable": true } }, "additionalProperties": false, "description": "Parameters for searching webhook registrations." }, "WebhookState": { "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "Possible values:\n- 1 = Created\n- 2 = Retrying\n- 3 = Successful\n- 4 = Failed\n- 5 = Aborted\n- 6 = Pending\n- 7 = Resolved", "format": "int32" }, "WebhookTargetAuthorizationRead": { "required": [ "authorizationType", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "authorizationType": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationType" } ], "description": "The type of authorization to use for the target.\n\nPossible values:\n- 0 = NoAuth\n- 1 = BasicAuth\n- 2 = PlatformSignedBearerTokenHeader\n- 3 = PlatformSignedBearerTokenBody\n- 4 = TargetApiToken" }, "username": { "type": "string", "description": "Username for Basic Authentication; only applicable when AuthorizationType is BasicAuth (`AuthorizationType == 1`).", "nullable": true } }, "additionalProperties": false, "description": "Represents authorization details used to access a webhook target." }, "WebhookTargetAuthorizationWrite": { "required": [ "authorizationType" ], "type": "object", "properties": { "authorizationType": { "allOf": [ { "$ref": "#/components/schemas/AuthorizationType" } ], "description": "The type of authorization to use for the target.\n\nPossible values:\n- 0 = NoAuth\n- 1 = BasicAuth\n- 2 = PlatformSignedBearerTokenHeader\n- 3 = PlatformSignedBearerTokenBody\n- 4 = TargetApiToken" }, "username": { "type": "string", "description": "Username for Basic Authentication; only applicable when AuthorizationType is BasicAuth (`AuthorizationType == 1`).", "nullable": true }, "password": { "type": "string", "nullable": true }, "targetApiToken": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Represents data for creating authorization for a webhook target." }, "WorkOrderAppointmentRequestDateRead": { "required": [ "id", "workOrderAppointmentRequestId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "workOrderAppointmentRequestId": { "type": "integer", "format": "int32" }, "requestedAppointmentDate": { "type": "string", "format": "date-time", "nullable": true }, "requestStatus": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateStatus" } ], "description": "Possible values:\n- 0 = Unanswered\n- 1 = Accepted\n- 2 = Declined", "nullable": true } }, "additionalProperties": false }, "WorkOrderAppointmentRequestDateSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "requestStatus": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateStatus" } ], "description": "Possible values:\n- 0 = Unanswered\n- 1 = Accepted\n- 2 = Declined", "nullable": true }, "requestedAppointmentDateAfterDate": { "type": "string", "format": "date-time", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "WorkOrderAppointmentRequestDateStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Possible values:\n- 0 = Unanswered\n- 1 = Accepted\n- 2 = Declined", "format": "int32" }, "WorkOrderAppointmentRequestDateWrite": { "required": [ "workOrderAppointmentRequestId" ], "type": "object", "properties": { "workOrderAppointmentRequestId": { "type": "integer", "format": "int32" }, "requestedAppointmentDate": { "type": "string", "format": "date-time", "nullable": true }, "requestStatus": { "allOf": [ { "$ref": "#/components/schemas/WorkOrderAppointmentRequestDateStatus" } ], "description": "Possible values:\n- 0 = Unanswered\n- 1 = Accepted\n- 2 = Declined", "nullable": true } }, "additionalProperties": false }, "WorkOrderAppointmentRequestRead": { "required": [ "id", "requestedPartyId", "workOrderId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "workOrderId": { "type": "integer", "format": "int32" }, "requestedPartyId": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isFinished": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "WorkOrderAppointmentRequestWrite": { "required": [ "requestedPartyId", "workOrderId" ], "type": "object", "properties": { "workOrderId": { "type": "integer", "format": "int32" }, "requestedPartyId": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true }, "isFinished": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "WorkOrderFeedEntryRead": { "required": [ "creatorId", "id", "workOrderId", "workOrderStatusId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "workOrderId": { "type": "integer", "format": "int32" }, "creatorId": { "type": "integer", "format": "int32" }, "workOrderStatusId": { "type": "integer", "format": "int32" }, "text": { "type": "string", "nullable": true }, "deadlineDate": { "type": "string", "format": "date-time", "nullable": true }, "completionDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "WorkOrderFeedEntryWrite": { "required": [ "creatorId", "workOrderId", "workOrderStatusId" ], "type": "object", "properties": { "workOrderId": { "type": "integer", "format": "int32" }, "creatorId": { "type": "integer", "format": "int32" }, "workOrderStatusId": { "type": "integer", "format": "int32" }, "text": { "type": "string", "nullable": true }, "deadlineDate": { "type": "string", "format": "date-time", "nullable": true }, "completionDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "WorkOrderRead": { "required": [ "contractorId", "id", "processId", "typeId", "workOrderStatusId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "processId": { "type": "integer", "format": "int32" }, "contractorId": { "type": "integer", "format": "int32" }, "billingAddressId": { "type": "integer", "format": "int32", "nullable": true }, "associatedTradeId": { "type": "integer", "format": "int32", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "workOrderStatusId": { "type": "integer", "format": "int32" }, "todo": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "deadlineDate": { "type": "string", "format": "date-time", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkOrderSearchRequest": { "type": "object", "properties": { "searchTerm": { "type": "string", "description": "Searches the WorkOrder's Todo.", "nullable": true }, "ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "orderBy": { "type": "array", "items": { "type": "string" }, "nullable": true }, "changedSince": { "type": "string", "description": "Restricts the results to entities where `Created` or `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdFrom": { "type": "string", "description": "Restricts the results to entities where `Created` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "createdUntil": { "type": "string", "description": "Restricts the results to entities where `Created` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "lastModifiedFrom": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or after the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-01-01T00:00:00Z" }, "lastModifiedUntil": { "type": "string", "description": "Restricts the results to entities where `LastModified` is on or before the specified timestamp.", "format": "date-time", "nullable": true, "example": "2025-12-31T23:59:59Z" }, "propertyId": { "type": "integer", "format": "int32", "nullable": true }, "processId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "WorkOrderStatusRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "number": { "type": "integer", "format": "int32", "nullable": true }, "priorityNumber": { "type": "integer", "format": "int32", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkOrderTypeRead": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "readOnly": true }, "created": { "type": "string", "description": "Creation date of the entity.\nAlmost guaranteed to be set to an actual value, nullable for backwards-compability.", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "description": "Date of the latest update.\nIsn't set on creation.", "format": "date-time", "nullable": true }, "deleted": { "type": "string", "description": "Deletion date of the entity.\nActually never really set, as the API usually doesn't return deleted entities.", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkOrderWrite": { "required": [ "contractorId", "processId", "typeId", "workOrderStatusId" ], "type": "object", "properties": { "processId": { "type": "integer", "format": "int32" }, "contractorId": { "type": "integer", "format": "int32" }, "billingAddressId": { "type": "integer", "format": "int32", "nullable": true }, "associatedTradeId": { "type": "integer", "format": "int32", "nullable": true }, "typeId": { "type": "integer", "format": "int32" }, "workOrderStatusId": { "type": "integer", "format": "int32" }, "todo": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "deadlineDate": { "type": "string", "format": "date-time", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Put **_ONLY_** your JWT Bearer token on textbox below!", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Account" }, { "name": "AccountContactDetails" }, { "name": "AccountGroup" }, { "name": "AccountPermission" }, { "name": "Attendance" }, { "name": "Attribute" }, { "name": "AttributeGroup" }, { "name": "AttributeGroupType" }, { "name": "AttributeValue" }, { "name": "Auth" }, { "name": "BankAccount" }, { "name": "BookedPlatformProduct" }, { "name": "BookingAccount" }, { "name": "BookingAccountItem" }, { "name": "CallLog" }, { "name": "ChatbotConfiguration" }, { "name": "ChatbotConversation" }, { "name": "ChatbotMessage" }, { "name": "ChatGptSettings" }, { "name": "CloudConnectAudit" }, { "name": "Color" }, { "name": "Conference" }, { "name": "ConferenceDocumentSettings" }, { "name": "ConferenceDocumentTemplate" }, { "name": "ConferenceSettings" }, { "name": "ConferenceVote" }, { "name": "Connect" }, { "name": "ConsumptionBrand" }, { "name": "ConsumptionMeter" }, { "name": "ConsumptionReading" }, { "name": "ConsumptionReadingDate" }, { "name": "ConsumptionReadingExtended" }, { "name": "ConsumptionType" }, { "name": "ContactDetails" }, { "name": "ContactType" }, { "name": "CustomerApp" }, { "name": "CustomerAppCustomContent" }, { "name": "Document" }, { "name": "DocumentBackgroundJob" }, { "name": "DocumentGroup" }, { "name": "DocumentShare" }, { "name": "DocuWare" }, { "name": "EditorTextBlock" }, { "name": "EMailSenderSetting" }, { "name": "Entrance" }, { "name": "ErpImport" }, { "name": "Faq" }, { "name": "FaqGroup" }, { "name": "FaqGroupVisual" }, { "name": "File" }, { "name": "FileType" }, { "name": "GenericPartySetting" }, { "name": "HealthCheck" }, { "name": "IngestionPipeline" }, { "name": "Inquiry" }, { "name": "InquiryAiEvaluation" }, { "name": "InquiryCategory" }, { "name": "InquiryLabel" }, { "name": "InquirySource" }, { "name": "Invoice" }, { "name": "MailPlaceholder" }, { "name": "MailSignature" }, { "name": "MailTemplate" }, { "name": "Mandate" }, { "name": "NearbyPlacesCategory" }, { "name": "Notice" }, { "name": "Pantaenius" }, { "name": "Party" }, { "name": "PartyType" }, { "name": "PlatformProduct" }, { "name": "PredefinedVote" }, { "name": "Process" }, { "name": "ProcessFeed" }, { "name": "ProcessFeedCategory" }, { "name": "ProcessFeedType" }, { "name": "ProcessInsuranceClaim" }, { "name": "ProcessNotification" }, { "name": "ProcessStage" }, { "name": "ProcessType" }, { "name": "Property" }, { "name": "PropertyBillingAddress" }, { "name": "PropertyEmergencyContact" }, { "name": "PropertyManagementCompany" }, { "name": "PropertyManager" }, { "name": "PropertyRole" }, { "name": "PropertyRoleDefault" }, { "name": "Resolution" }, { "name": "ResolutionOption" }, { "name": "ResolutionOptionTemplate" }, { "name": "ResolutionTemplate" }, { "name": "Signee" }, { "name": "SmartLock" }, { "name": "SmartLockActivityAttempt" }, { "name": "SmartLockType" }, { "name": "SumVote" }, { "name": "Tenant" }, { "name": "Term" }, { "name": "Topic" }, { "name": "TopicNote" }, { "name": "TopicTemplate" }, { "name": "TopicTemplateResolutionTemplates" }, { "name": "Trade" }, { "name": "Unit" }, { "name": "UnitContract" }, { "name": "UnitContractType" }, { "name": "UnitType" }, { "name": "UserTask" }, { "name": "UserTaskCollection" }, { "name": "UserTaskNotification" }, { "name": "UserTaskPriority" }, { "name": "ViewSetting" }, { "name": "ViewSettingGroup" }, { "name": "VotingEndReason" }, { "name": "VotingGroup" }, { "name": "VotingGroupVote" }, { "name": "VotingMajority" }, { "name": "VotingProcedure" }, { "name": "VotingSession" }, { "name": "Webhook" }, { "name": "WebhookAttempt" }, { "name": "WebhookEvent" }, { "name": "WebhookRegistration" }, { "name": "WorkOrder" }, { "name": "WorkOrderAppointmentRequest" }, { "name": "WorkOrderAppointmentRequestDate" }, { "name": "WorkOrderFeedEntry" }, { "name": "WorkOrderStatus" }, { "name": "WorkOrderType" } ] }