Creates a new account from the provided data, associating it within the requester's scope.
Module: Authentication
Returns: Identity → Accounts → AccountRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Returns the account of the currently used authentication token.
Module: Authentication
Returns: Identity → Accounts → AccountRead (single)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified account, if it falls within the caller’s scope.
Module: Authentication
Returns: Void
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}/account-contact-details": { "get": { "tags": [ "Account" ], "summary": "List Contact Details", "description": "Shows the account contact details for the given account.
Module: Authentication
Returns: Master Data → Accounts → Contact Details → AccountContactDetailsRead (paginated)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Authentication
Returns: Identity → Application Requests → AccountActivationMessageResponse (single)
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": "Returns the party of the given account.
Module: Authentication
Returns: Identity → Parties → PartyRead (single)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Authentication
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified account contact detail, if it falls within the caller’s scope.
Module: Identity
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified account group, if it falls within the caller’s scope.
Module: Identity
Returns: Void
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-permissions": { "get": { "tags": [ "AccountPermission" ], "summary": "List Account Permissions", "description": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new attendance from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Attendances → AttendanceRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified attendance, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Creates a new attribute from the provided data, associating it within the requester's scope.
Module: Attributes
Returns: Master Data → Properties → Attributes → AttributeRead (single)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "Deletes the specified attribute, if it falls within the caller’s scope.
Module: Attributes
Returns: Void
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "Deletes the specified attribute group, if it falls within the caller’s scope.
Module: Attributes
Returns: Void
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": "Module: Attributes
Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)
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": "Module: Attributes
Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)
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": "Module: Attributes
Returns: Master Data → Properties → Attribute Values → AttributeValueRead (paginated)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "Deletes the specified attribute value, if it falls within the caller’s scope.
Module: Attributes
Returns: Void
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": "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": "Completes the MFA challenge using a token and nonce. Requires authentication and MFA scope.
Module: Authentication
Returns: Identity → Application Requests → LoginCommandResponse (single)
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": "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": "Resends the MFA challenge email to the user. Requires authentication and MFA scope.
Module: Authentication
Returns: Void
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": "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": "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 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": "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": "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": "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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified bank account, if it falls within the caller’s scope.
Module: Bank Accounts
Returns: Void
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-accounts": { "post": { "tags": [ "BookingAccount" ], "summary": "Create Booking Account", "description": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified booking account, if it falls within the caller’s scope.
Module: Booking Accounts
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified booking account item, if it falls within the caller’s scope.
Module: Booking Accounts
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new chatbot configuration from the provided data, associating it within the requester's scope.
Module: Chatbot
Returns: Chatbot → Chatbot Configurations → ChatbotConfigurationRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified chatbot configuration, if it falls within the caller’s scope.
Module: Chatbot
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Chatbot
Returns: Chatbot → Chatbot Messages → ChatbotMessageRead (paginated)
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": "Creates a new chatbot message from the provided data, associating it within the requester's scope.
Module: Chatbot
Returns: Chatbot → Chatbot Messages → ChatbotMessageRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified chatbot message, if it falls within the caller’s scope.
Module: Chatbot
Returns: Void
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "Deletes the specified chat gpt setting, if it falls within the caller’s scope.
Module: Integrations
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified cloud connect audit, if it falls within the caller’s scope.
Module: Cloud Connect
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new conference from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Conferences → ConferenceRead (single)
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-07-18T22:10:01Z","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-07-18T22:10:01Z","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-07-31T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-07-18T22:10:01Z","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-07-18T22:10:01Z","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-07-31T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-07-18T22:10:01Z","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-07-18T22:10:01Z","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-07-31T22:10:01Z","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": "Module: Conferences
Returns: Conferences → Attendances → AttendanceRead (single)
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": "Module: Conferences
Returns: Conferences → Attendances → AttendanceRead (single)
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": "Module: Conferences
Returns: Conferences → Topics → TopicRead (list)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-07-18T22:10:01Z","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-07-18T22:10:01Z","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-07-31T22:10:01Z","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": "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)
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-07-18T22:10:01Z","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-07-18T22:10:01Z","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-07-31T22:10:01Z","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": "Deletes the specified conference, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: Documents → Files → FileAttachmentRead (paginated)
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": "Module: Conferences
Returns: Conferences → Attendances → AttendanceRead (paginated)
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": "Module: Conferences
Returns: Conferences → Conferences → ConferenceChecklist (single)
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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Conferences
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Conferences
Returns: Conferences → Conference Events → ConferenceEventRead (paginated)
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": "Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Mandates → MandateRead (paginated)
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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: Conferences → Resolutions → ResolutionRead (paginated)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Module: Conferences
Returns: Documents → Files → FileDownloadResponse (single)
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": "Module: Conferences
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Conferences
Returns: Conferences → Voting → Votes → PredefinedVoteRead (paginated)
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": "Module: Conferences
Returns: Master Data → Properties → Properties → PropertyRead (single)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","lastModified":null,"deleted":null,"id":4} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/conferences/{id}/protocol": { "post": { "tags": [ "Conference" ], "summary": "Get Protocol Document", "description": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: Conferences → Resolutions → ResolutionRead (paginated)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Module: Conferences
Returns: Conferences → Resolutions → ResolutionRead (paginated)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)
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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: Conferences → Roles → ConferenceRole (paginated)
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": "Module: Conferences
Returns: Conferences → Roles → ConferenceRole (list)
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": "Module: Conferences
Returns: Conferences → Signees → SigneeRead (paginated)
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": "Module: Conferences
Returns: System → Object (list)
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": "Module: Conferences
Returns: Conferences → Topics → TopicRead (paginated)
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-06-13T22:10:01Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Module: Conferences
Returns: Conferences → Voting Groups → VotingGroupRead (paginated)
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": "Module: Conferences
Returns: Conferences → Voting Groups → VotingGroupShares (paginated)
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": "Module: Conferences
Returns: Conferences → Voting → Sessions → VotingSessionRead (paginated)
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": "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)
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": "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)
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": "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)
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": "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)
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": "Module: Conferences
Returns: Conferences → Document Settings → DocumentSettingsRead (single)
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": "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)
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": "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)
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": "Deletes the specified conference document setting, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified conference document template, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Creates a new conference setting from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Settings → SettingsRead (single)
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": "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)
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": "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)
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": "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)
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": "Module: Conferences
Returns: Conferences → Settings → SettingsRead (single)
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": "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)
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": "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)
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": "Deletes the specified conference setting, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Creates a new conference vote from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Voting → Votes → ConferenceVoteRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified conference vote, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Creates a new connect from the provided data, associating it within the requester's scope.
Module: Integrations
Returns: Integrations → Connect → ConnectRead (single)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
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": "Deletes the specified connect, if it falls within the caller’s scope.
Module: Integrations
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Consumptions
Returns: System → Object (list)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Consumptions
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Consumptions
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Consumptions
Returns: Consumptions → Readings → ConsumptionReadingRead (paginated)
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": "Creates a new consumption reading from the provided data, associating it within the requester's scope.
Module: Consumptions
Returns: Consumptions → Readings → ConsumptionReadingRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified consumption reading, if it falls within the caller’s scope.
Module: Consumptions
Returns: Void
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": "Module: Consumptions
Returns: Consumptions → Consumption Readings → ConsumptionReadingExtended (paginated)
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": "Module: Consumptions
Returns: Consumptions → Consumption Readings → ConsumptionReadingExtended (paginated)
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": "Module: Consumptions
Returns: Consumptions → Readings → ConsumptionReadingDate (paginated)
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": "Module: Consumptions
Returns: Consumptions → Readings → ConsumptionReadingDate (paginated)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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" } ], "description": "Defines search and filter parameters for querying contact details.\nInherits common search, paging and sorting options from facilioo.Application.Crud.Dtos.Base.SearchQueryParameters.\n\nThe !:SearchQueryParameters.SearchTerm is applied to the contact details value.\nThe comparison is case-insensitive and ignores white spaces in the stored contact value\n(e.g. searching for \"030400500\" will match \"030 400 500\", but not vice versa)." } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified contact detail, if it falls within the caller’s scope.
Module: Identity
Returns: Void
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": "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)
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": "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)
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": "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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Customer Apps
Returns: System → Int32 (list)
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" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/documents": { "post": { "tags": [ "Document" ], "summary": "Create Document", "description": "Creates a new document from the provided data, associating it within the requester's scope.
Module: Documents
Returns: Documents → Documents → DocumentRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified document, if it falls within the caller’s scope.
Module: Documents
Returns: Void
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": "Module: Documents
Returns: Documents → Documents → Shares → DocumentShareRead (paginated)
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": "Module: Documents
Returns: Documents → Documents → Shares → DocumentShareRead (list)
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": "Module: Documents
Returns: Documents → Document Background Jobs → DocumentBackgroundJobRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new document group from the provided data, associating it within the requester's scope.
Module: Documents
Returns: Documents → Document Groups → DocumentGroupRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified document group, if it falls within the caller’s scope.
Module: Documents
Returns: Void
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": "Module: Documents
Returns: Documents → Documents → DocumentRead (paginated)
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": "Creates a new document share from the provided data, associating it within the requester's scope.
Module: Documents
Returns: Documents → Documents → Shares → DocumentShareRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified document share, if it falls within the caller’s scope.
Module: Documents
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified editor text block, if it falls within the caller’s scope.
Module: Editor Text Blocks
Returns: Void
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": { "post": { "tags": [ "Entrance" ], "summary": "Create Entrance", "description": "Creates a new entrance from the provided data, associating it within the requester's scope.
Module: Properties
Returns: Master Data → Properties → Entrances → EntranceRead (single)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Deletes the specified entrance, if it falls within the caller’s scope.
Module: Properties
Returns: Void
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": "Module: Properties
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified erp import, if it falls within the caller’s scope.
Module: Integrations
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Faqs
Returns: Customer App → Faqs → FaqRead (paginated)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new file from the provided data, associating it within the requester's scope.
Module: Documents
Returns: Documents → Files → FileRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified file, if it falls within the caller’s scope.
Module: Documents
Returns: Void
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": "Module: Documents
Returns: System → Object (list)
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": "Module: Documents
Returns: Documents → Documents → DocumentRead (single)
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": "Module: Documents
Returns: Documents → Files → FileDownloadResponse (single)
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": "Module: Documents
Returns: Processes → Feed → ProcessFeedRead (paginated)
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": "Module: Documents
Returns: Documents → Files → Queries → Helper → ThumbnailQueryResponse (single)
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": "Module: Documents
Returns: Documents → File Types → FileTypeRead (single)
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": "Module: Documents
Returns: Documents → Files → FileUploadResponse (single)
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": "Module: Documents
Returns: Documents → Files → FileRead (paginated)
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": "Module: Documents
Returns: Documents → Files → FileRead (paginated)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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": "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": "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": "Creates a new inquiry from the provided data, associating it within the requester's scope.
Module: Inquiries
Returns: Inquiries → Inquiries → InquiryRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified inquiry, if it falls within the caller’s scope.
Module: Inquiries
Returns: Void
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": "Module: Inquiries
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Inquiries
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Inquiries
Returns: Identity → Accounts → AccountRead (paginated)
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": { "get": { "tags": [ "Inquiry" ], "summary": "Show Ai Evaluation", "description": "Module: Inquiries
Returns: Inquiries → Ai Evaluations → InquiryAiEvaluationRead (single)
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": "Module: Inquiries
Returns: Documents → Files → FileRead (paginated)
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": "Module: Inquiries
Returns: Documents → Files → FileRead (paginated)
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": "Module: Inquiries
Returns: Documents → Files → FileRead (paginated)
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}/response-attachments": { "get": { "tags": [ "Inquiry" ], "summary": "Get Response Attachments", "description": "Module: Inquiries
Returns: Documents → Files → FileRead (paginated)
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": "Module: Inquiries
Returns: Documents → Files → FileRead (paginated)
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": "Module: Inquiries
Returns: Documents → Files → FileRead (paginated)
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": "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)
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": "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)
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": [ ] } ] } }, "/api/inquiry-ai-evaluations/search": { "post": { "tags": [ "InquiryAiEvaluation" ], "summary": "Search Inquiry Ai Evaluations", "description": "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)
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": "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)
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": [ ] } ] } }, "/api/inquiry-categories": { "get": { "tags": [ "InquiryCategory" ], "summary": "List Inquiry Categories", "description": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-sources": { "get": { "tags": [ "InquirySource" ], "summary": "List Inquiry Sources", "description": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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": "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": "Module: Integrations
Returns: Processes → Processes → ProcessRead (single)
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": "Module: Integrations
Returns: Processes → Processes → ProcessRead (single)
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": "Module: Integrations
Returns: Processes → Processes → ProcessRead (single)
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": "Creates a new invoice from the provided data, associating it within the requester's scope.
Module: Processes
Returns: Processes → Invoices → InvoiceRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified invoice, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "Module: Processes
Returns: Documents → Files → FileRead (paginated)
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": "Module: Processes
Returns: Documents → Files → FileRead (paginated)
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": "Module: Processes
Returns: Documents → Files → FileRead (paginated)
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/mandates": { "post": { "tags": [ "Mandate" ], "summary": "Create Mandate", "description": "Creates a new mandate from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Mandates → MandateRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified mandate, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Voting → Votes → PredefinedVoteRead (paginated)
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": "Module: Conferences
Returns: Conferences → Voting → Votes → PredefinedVoteRead (list)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new notice from the provided data, associating it within the requester's scope.
Module: Notices
Returns: Processes → Notices → NoticeRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified notice, if it falls within the caller’s scope.
Module: Notices
Returns: Void
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": "Module: Notices
Returns: Processes → Notices → Accesses → NoticeAccessRead (paginated)
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": "Module: Notices
Returns: Documents → Files → FileRead (paginated)
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": "Module: Notices
Returns: Processes → Notices → Accesses → NoticeAccessRead (single)
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": "Creates a new party from the provided data, associating it within the requester's scope.
Module: Identity
Returns: Identity → Parties → PartyRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Returns the party of the currently used authentication token.
Module: Identity
Returns: Identity → Parties → PartyRead (single)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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": "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)
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": "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)
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": "Deletes the specified party, if it falls within the caller’s scope.
Module: Identity
Returns: Void
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": "Module: Identity
Returns: Identity → Accounts → AccountRead (single)
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": "Module: Identity
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Identity
Returns: Master Data → Parties → Trades → TradeRead (paginated)
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": "Module: Identity
Returns: Master Data → Properties → Properties → PropertyRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Identity
Returns: Master Data → Parties → Contact Details → ContactDetailsRead (paginated)
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": "Module: Identity
Returns: Master Data → Parties → Contact Details → ContactDetailsRead (list)
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": "Module: Identity
Returns: Customer App → Customer Apps → CustomerAppStartupConfiguration (single)
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": "Module: Identity
Returns: Documents → Document Groups → DocumentGroupRead (paginated)
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": "Module: Identity
Returns: System → String (paginated)
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": "Module: Identity
Returns: System → String (list)
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": "Module: Identity
Returns: Documents → Files → FileDownloadResponse (single)
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": "Module: Identity
Returns: Processes → Processes → ProcessRead (paginated)
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": "Module: Identity
Returns: Master Data → Parties → Trades → TradeRead (paginated)
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": "Module: Identity
Returns: Master Data → Parties → Trades → TradeRead (paginated)
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": "Module: Identity
Returns: Master Data → Properties → Properties → PropertyRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Identity
Returns: Master Data → Parties → Trades → TradeRead (paginated)
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}/document-groups/{documentGroupId}/documents": { "get": { "tags": [ "Party" ], "summary": "List Documents", "description": "Module: Identity
Returns: Documents → Documents → DocumentRead (paginated)
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/party-types": { "get": { "tags": [ "PartyType" ], "summary": "List Party Types", "description": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/predefined-votes": { "post": { "tags": [ "PredefinedVote" ], "summary": "Create Predefined Vote", "description": "Creates a new predefined vote from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Voting → Votes → PredefinedVoteRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified predefined vote, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Creates a new proces from the provided data, associating it within the requester's scope.
Module: Processes
Returns: Processes → Processes → ProcessRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified proces, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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}/additional-linked-units": { "get": { "tags": [ "Process" ], "summary": "List Additional Linked Units", "description": "Returns all units that are additionally linked to this process (can be an empty set). The main unit (
Module: Processes
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Processes
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Processes
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Processes
Returns: Processes → Feed → ProcessFeedRead (paginated)
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": "Module: Processes
Returns: Processes → Feed → ProcessFeedRead (paginated)
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": "Module: Processes
Returns: Documents → Files → FileRead (paginated)
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": "Module: Processes
Returns: Inquiries → Inquiries → InquiryRead (paginated)
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": "Module: Processes
Returns: Processes → Process Insurance Claims → ProcessInsuranceClaimRead (paginated)
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": "Module: Processes
Returns: Processes → Stages → ProcessStageRead (single)
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": "Module: Processes
Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (paginated)
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": "Module: Processes
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Processes
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Processes
Returns: Identity → Accounts → AccountRead (paginated)
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": "Returns the entities related to the specified resource.
Module: Processes
Returns: Processes → User Tasks → UserTaskRead (paginated)
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": "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)
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": "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)
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": "Module: Processes
Returns: Processes → Work Orders → WorkOrderRead (paginated)
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": "Creates a new process feed from the provided data, associating it within the requester's scope.
Module: Processes
Returns: Processes → Feed → ProcessFeedRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified process feed, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "Module: Processes
Returns: Identity → Parties → PartyRead (paginated)
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": "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)
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": "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)
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": "Module: Processes
Returns: Documents → Files → FileRead (paginated)
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": "Module: Processes
Returns: Documents → Files → FileRead (paginated)
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": "Module: Processes
Returns: Documents → Files → FileRead (paginated)
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": "Module: Processes
Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (single)
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": "Module: Processes
Returns: Void
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": "Module: Processes
Returns: Processes → Feed → Categories → ProcessFeedCategoryRead (single)
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": "Returns the creator party of the given process feed.
Module: Processes
Returns: Identity → Parties → PartyRead (single)
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": "Module: Processes
Returns: Processes → Notifications → ProcessNotificationRead (paginated)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified process feed category, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified process insurance claim, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "Creates a new process notification from the provided data, associating it within the requester's scope.
Module: Processes
Returns: Processes → Notifications → ProcessNotificationRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified process notification, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "Creates a new process stage from the provided data, associating it within the requester's scope.
Module: Processes
Returns: Processes → Stages → ProcessStageRead (single)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
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": "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)
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": "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)
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": "Deletes the specified process stage, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "Module: Processes
Returns: Processes → Types → ProcessTypeRead (paginated)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Processes
Returns: Processes → Processes → ExtendedProcessStageRead (paginated)
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": "Module: Processes
Returns: Processes → Stages → ProcessStageProcessTypeRead (single)
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": "Module: Processes
Returns: Processes → Stages → ProcessStageRead (paginated)
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": "Creates a new property from the provided data, associating it within the requester's scope.
Module: Properties
Returns: Master Data → Properties → Properties → PropertyRead (single)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Deletes the specified property, if it falls within the caller’s scope.
Module: Properties
Returns: Void
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": "Module: Properties
Returns: Master Data → Properties → Attributes → AttributeRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Attribute Values → AttributeValueRead (paginated)
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": "Module: Properties
Returns: Master Data → Parties → Bank Accounts → BankAccountRead (paginated)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Properties
Returns: Master Data → Parties → Bank Accounts → BankAccountRead (paginated)
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": "Module: Properties
Returns: Master Data → Parties → Bank Accounts → BankAccountRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Billing Addresses → BillingAddressRead (paginated)
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": "Module: Properties
Returns: Conferences → Conferences → ConferenceRead (paginated)
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-07-18T22:10:01Z","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-07-18T22:10:01Z","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-07-31T22:10:01Z","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-07-18T22:10:01Z","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-07-18T22:10:01Z","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-07-31T22:10:01Z","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-07-18T22:10:01Z","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-07-18T22:10:01Z","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-07-31T22:10:01Z","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": "Module: Properties
Returns: Conferences → Settings → SettingsRead (single)
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": "Module: Properties
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Properties
Returns: Master Data → Parties → Trades → TradeRead (paginated)
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": "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)
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": "Removes a trade assignment for a construction party on a property.
Module: Properties
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Properties
Returns: Documents → Document Groups → DocumentGroupRead (paginated)
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": "Module: Properties
Returns: Documents → Documents → DocumentRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Properties
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Properties
Returns: Customer App → Property Emergency Contacts → PropertyEmergencyContactRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Entrances → EntranceRead (paginated)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
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": "Module: Properties
Returns: Documents → Files → FileDownloadResponse (single)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Properties
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Properties
Returns: Documents → Files → FileRead (single)
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": "Module: Properties
Returns: Documents → Files → FileRead (single)
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": "Module: Properties
Returns: Documents → Files → FileRead (single)
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": "Module: Properties
Returns: Processes → Processes → ProcessRead (paginated)
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": "Module: Properties
Returns: Conferences → Resolutions → ResolutionRead (paginated)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Module: Properties
Returns: System → Object (list)
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": "Returns all Accounts of the Owner Party of the associated Tenant of the Property. To retrieve the Accounts responsible for this particular Property, use
Module: Properties
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Properties
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Properties → Roles → PropertyRoleRead (single)
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": "Module: Properties
Returns: Master Data → Properties → Properties → Roles → PropertyRoleRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Properties → Roles → Mappings → PropertyRoleMapping (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Properties → Roles → Mappings → PropertyRoleMapping (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Properties → Roles → Mappings → PropertyRoleMapping (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Properties → Roles → Mappings → PropertyRoleMapping (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Attributes → AttributeRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Properties → PropertyRead (single)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","lastModified":null,"deleted":null,"id":4} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "Property" ], "summary": "Remove Shares Attribute From Property", "description": "Module: Properties
Returns: Master Data → Properties → Properties → PropertyRead (single)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Returns the technical unit of a property if it exists.
Module: Properties
Returns: Master Data → Properties → Units → UnitRead (single)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","lastModified":null,"deleted":null,"id":5} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "Property" ], "summary": "Provision Technical Unit", "description": "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)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","lastModified":null,"deleted":null,"id":5} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/properties/{id}/tenant": { "get": { "tags": [ "Property" ], "summary": "Show Tenant", "description": "Module: Properties
Returns: Master Data → Properties → Tenants → TenantRead (single)
Required Token Scopes: Platform (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": "Module: Properties
Returns: Master Data → Parties → Trades → TradeRead (paginated)
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": "Returns the construction parties assigned to the specified trade for this property.
Module: Properties
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Properties
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Units → DetailedUnitRead (paginated)
Required Token Scopes: Platform (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": "Module: Properties
Returns: Attributes → Responses → SharesResponse (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Unit Contracts → UnitContractRead (paginated)
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": "Module: Properties
Returns: Conferences → Voting Groups → VotingGroupRead (paginated)
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": "Module: Authentication
Returns: Identity → Accounts → AccountRead (paginated)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified property billing addres, if it falls within the caller’s scope.
Module: Properties
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified property emergency contact, if it falls within the caller’s scope.
Module: Properties
Returns: Void
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": "Module: Identity
Returns: Identity → Parties → PartyRead (paginated)
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": "Module: Identity
Returns: Identity → Parties → PartyRead (single)
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": "Module: Identity
Returns: Conferences → Interfaces → ConferenceInterfaceRead (single)
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": "Module: Identity
Returns: Identity → Accounts → AccountRead (paginated)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new resolution from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Resolutions → ResolutionRead (single)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "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)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Deletes the specified resolution, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolution Attachments → ResolutionAttachmentRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolutions → ResolutionRead (paginated)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Module: Conferences
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Conferences
Returns: Master Data → Properties → Units → UnitRead (paginated)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Conferences
Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolution Options → ResolutionOptionRead (paginated)
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": "Module: Conferences
Returns: Conferences → Voting Groups → VotingGroupRead (paginated)
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": "Module: Conferences
Returns: Conferences → Voting → Sessions → VotingSessionRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolution Attachments → ResolutionAttachmentRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolution Attachments → ResolutionAttachmentRead (single)
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": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "Creates a new resolution option from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Resolution Options → ResolutionOptionRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified resolution option, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Resolutions → ResolutionRead (single)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","lastModified":null,"deleted":null,"id":5} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/resolution-options/{id}/attachments": { "get": { "tags": [ "ResolutionOption" ], "summary": "Get Attachments", "description": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolution Options → ResolutionOptionRead (list)
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": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified resolution option template, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Creates a new resolution template from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Resolution Templates → ResolutionTemplateRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified resolution template, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolution Option Templates → ResolutionOptionTemplateRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolution Templates → ResolutionTemplateRead (list)
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/signees": { "post": { "tags": [ "Signee" ], "summary": "Create Signee", "description": "Creates a new signee from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Signees → SigneeRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified signee, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified smart lock activity attempt, if it falls within the caller’s scope.
Module: Smart Locks
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new tenant from the provided data, associating it within the requester's scope.
Module: Identity
Returns: Master Data → Properties → Tenants → TenantRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified tenant, if it falls within the caller’s scope.
Module: Identity
Returns: Void
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": "Module: Identity
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Identity
Returns: Identity → Tenant Party Accesses → TenantPartyAccess (paginated)
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": "Module: Identity
Returns: Identity → Tenant Party Accesses → TenantPartyAccess (paginated)
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": "Module: Identity
Returns: Master Data → Properties → Properties → PropertyRead (paginated)
Required Token Scopes: Platform (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Identity
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Identity
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Identity
Returns: Identity → Tenant Party Accesses → TenantPartyAccess (paginated)
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": "Module: Identity
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Identity
Returns: Identity → Accounts → AccountRead (paginated)
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": "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": "Creates a new topic from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Topics → TopicRead (single)
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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-13T22:10:01Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-13T22:10:01Z","lastModified":null,"deleted":null,"id":1},{"number":2,"title":"Freigaben Jahresabrechnung / Wirtschaftspläne","description":null,"externalId":null,"conferenceId":1,"propertyId":null,"created":"2026-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "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)
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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Deletes the specified topic, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "Module: Conferences
Returns: Conferences → Topic Attachments → TopicAttachmentRead (paginated)
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": "Module: Conferences
Returns: Conferences → Topic Notes → TopicNoteRead (paginated)
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": "Module: Conferences
Returns: Conferences → Topic Notes → TopicNoteRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolutions → ResolutionRead (paginated)
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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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 04/24/2026 22:10:01 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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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-06-13T22:10:01Z","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": "Module: Conferences
Returns: Conferences → Topic Attachments → TopicAttachmentRead (paginated)
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": "Module: Conferences
Returns: Conferences → Topic Attachments → TopicAttachmentRead (single)
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": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "Module: Conferences
Returns: Documents → Files → FileRead (paginated)
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": "Module: Conferences
Returns: Conferences → Resolutions → ResolutionRead (list)
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": "Creates a new topic note from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Topic Notes → TopicNoteRead (single)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "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)
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": "Deletes the specified topic note, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Creates a new topic template from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Topic Templates → TopicTemplateRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified topic template, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Topic Templates → TopicTemplateRead (list)
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": "Module: Conferences
Returns: Conferences → Resolution Templates → ResolutionTemplateRead (paginated)
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": "Module: Conferences
Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (paginated)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified topic template resolution template, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Topic Templates → Resolution Templates → TopicTemplateResolutionTemplateRead (list)
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": "Creates a new trade from the provided data, associating it within the requester's scope.
Module: Trades
Returns: Master Data → Parties → Trades → TradeRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified trade, if it falls within the caller’s scope.
Module: Trades
Returns: Void
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": "Creates a new unit from the provided data, associating it within the requester's scope.
Module: Properties
Returns: Master Data → Properties → Units → UnitRead (single)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "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)
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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Deletes the specified unit, if it falls within the caller’s scope.
Module: Properties
Returns: Void
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": "Module: Properties
Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Attribute Groups → AttributeGroupRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Unit Contracts → UnitContractRead (paginated)
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": "Module: Properties
Returns: Documents → Document Groups → DocumentGroupRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Entrances → EntranceRead (single)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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": "Module: Properties
Returns: Master Data → Properties → Unit Contracts → Holding Types → UnitHoldingTypeRead (single)
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": "Module: Properties
Returns: Processes → Processes → ProcessRead (paginated)
Required Token Scopes: Platform (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": "Module: Properties
Returns: Master Data → Properties → Properties → PropertyRead (single)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","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-06-12T22:10:01Z","lastModified":null,"deleted":null,"id":4} } } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/units/{id}/shares": { "get": { "tags": [ "Unit" ], "summary": "Show Shares", "description": "Module: Properties
Returns: Attributes → Responses → SharesResponse (single)
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": "Module: Properties
Returns: Master Data → Properties → Attribute Values → NestedAttributeValueRead (paginated)
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": "Module: Properties
Returns: Master Data → Properties → Tenants → TenantRead (single)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Properties
Returns: Master Data → Properties → Units → Types → UnitTypeRead (single)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Module: Properties
Returns: Documents → Documents → DocumentRead (paginated)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified unit contract, if it falls within the caller’s scope.
Module: Properties
Returns: Void
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": "Module: Properties
Returns: Identity → Parties → PartyRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new user task from the provided data, associating it within the requester's scope.
Module: Processes
Returns: Processes → User Tasks → UserTaskRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified user task, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "Module: Processes
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Processes
Returns: Documents → Files → FileRead (paginated)
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": "Module: Processes
Returns: Processes → User Tasks → Feed Entries → UserTaskFeedEntryRead (paginated)
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": "Module: Processes
Returns: Processes → User Tasks → Notifications → UserTaskNotificationRead (paginated)
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": "Returns the entities related to the specified resource.
Module: Processes
Returns: Processes → Processes → ProcessRead (paginated)
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": "Module: Processes
Returns: Identity → Accounts → AccountRead (paginated)
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": "Module: Processes
Returns: Identity → Accounts → AccountRead (paginated)
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": "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)
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": "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)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified user task collection, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified user task notification, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/voting-end-reasons": { "get": { "tags": [ "VotingEndReason" ], "summary": "Get Voting End Reasons", "description": "Module: Conferences
Returns: Conferences → Voting → End Reasons → VotingEndReasonRead (paginated)
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": "Creates a new voting group from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Voting Groups → VotingGroupRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified voting group, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Voting → Votes → VotingGroupVoteRead (paginated)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified voting group vote, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Voting → Majorities → VotingMajorityRead (paginated)
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": "Module: Conferences
Returns: Conferences → Voting → Procedures → VotingProcedureRead (paginated)
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": "Creates a new voting session from the provided data, associating it within the requester's scope.
Module: Conferences
Returns: Conferences → Voting → Sessions → VotingSessionRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified voting session, if it falls within the caller’s scope.
Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Voting → Votes → ResultsCount (single)
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": "Module: Conferences
Returns: Conferences → Sum Votes → SumVoteRead (paginated)
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": "Module: Conferences
Returns: Conferences → Voting → Votes → ConferenceVoteRead (paginated)
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": "Module: Conferences
Returns: Void
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": "Module: Conferences
Returns: Conferences → Voting → Votes → VotingGroupVoteRead (paginated)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Returns the entities related to the specified resource.
Module: Webhooks
Returns: Web Hooks → WebhookAttemptRead (paginated)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "Creates a new webhook registration from the provided data, associating it within the requester's scope.
Module: Webhooks
Returns: Web Hooks → WebhookRegistrationRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified webhook registration, if it falls within the caller’s scope.
Module: Webhooks
Returns: Void
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": "Returns the entities related to the specified resource.
Module: Webhooks
Returns: Web Hooks → WebhookRead (paginated)
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": "Creates a new work order from the provided data, associating it within the requester's scope.
Module: Processes
Returns: Processes → Work Orders → WorkOrderRead (single)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified work order, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "Module: Processes
Returns: Processes → Work Orders → Appointment Requests → WorkOrderAppointmentRequestRead (paginated)
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": "Module: Processes
Returns: Processes → Invoices → InvoiceRead (paginated)
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": "Module: Processes
Returns: Processes → Invoices → InvoiceRead (paginated)
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": "Module: Processes
Returns: Processes → Invoices → InvoiceRead (paginated)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/SearchQueryParameters" } ] } } } }, "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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified work order appointment request, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "Module: Processes
Returns: Processes → Work Orders → Appointment Requests → Dates → WorkOrderAppointmentRequestDateRead (paginated)
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified work order appointment request date, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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/PaginatedListOfWorkOrderFeedEntryRead" } } } }, "401": { "description": "Error: Unauthorized" } }, "security": [ { "Bearer": [ ] } ] } }, "/api/work-order-feed-entries/{id}": { "get": { "tags": [ "WorkOrderFeedEntry" ], "summary": "Get Work Order Feed Entry", "description": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
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": "Deletes the specified work order feed entry, if it falls within the caller’s scope.
Module: Processes
Returns: Void
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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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": "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)
Required Token Scopes: Platform (0)
Allowed Party Types (Account Role): Admin (1), Property Management Company (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 }, "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", "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", "nullable": true }, "number": { "type": "integer", "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 }, "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 }, "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 }, "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 }, "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 }, "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 }, "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 }, "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 }, "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 }, "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 }, "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/SearchResultItem" }, "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" }, "timeStamp": { "type": "string", "format": "date-time" }, "description": { "type": "string" } }, "additionalProperties": false }, "ConferenceEventType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "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", "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 }, "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 }, "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 }, "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 }, "dates": { "type": "array", "items": { "type": "string" }, "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 }, "partyId": { "type": "integer", "description": "Filters contact details by the owning party.\nWhen set, only contact details belonging to the specified party are returned.", "format": "int32", "nullable": true }, "contactTypeId": { "type": "integer", "description": "Filters contact details by contact type.\nCorresponds to `ContactTypeId` on the contact details entity.\nWhen omitted, all contact types are included.", "format": "int32", "nullable": true }, "includeSnapshots": { "type": "boolean", "description": "Determines whether snapshot entries should be included in the result.\n