Search Unit Contracts

post

https://api.facilioo.de/api/unit-contracts/search

Search Unit Contracts

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

Module: Properties

Returns: Master Data → Properties → Unit Contracts → UnitContractRead (paginated)

Authorization

Required Token Scopes: Platform (0)

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

Required Account Permission: ReadUnit (66)

This will be evaluated against your used access token.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

PageSize

int32

PageNumber

int32

Body Params

searchTerm

string | null

Searches the UnitContract's Number.

ids

array of int32s | null

ids

orderBy

array of strings | null

orderBy

changedSince

date-time | null

Restricts the results to entities where Created or LastModified is on or after the specified timestamp.

createdFrom

date-time | null

Restricts the results to entities where Created is on or after the specified timestamp.

createdUntil

date-time | null

Restricts the results to entities where Created is on or before the specified timestamp.

lastModifiedFrom

date-time | null

Restricts the results to entities where LastModified is on or after the specified timestamp.

lastModifiedUntil

date-time | null

Restricts the results to entities where LastModified is on or before the specified timestamp.

isActive

boolean | null

Filters unit contracts based on the effective contract state, i.e., comparing the EffectiveFrom and TerminationAt dates against the current timestamp as upper and lower boundaries.
If either one of the dates is null, this side of the boundary is immediately considered as active.
Three-way filter logic: null => all, true => active unit contracts, and false => inactive unit contracts.

unitId

array of int32s | null

unitId

entranceId

array of int32s | null

entranceId

propertyId

array of int32s | null

propertyId

partyId

array of int32s | null

partyId

number

string | null

type

int32 | null

enum

Possible values:

1 = BoardChairman
2 = BoardMember
3 = Owner
4 = Tenant
5 = Subtenant
6 = Resident
7 = SpecialOwner
8 = PropertyOwner
9 = AuthorizedOwnerRecipient
10 = AuthorizedTenantRecipient
11 = AuthorizedPropertyOwnerRecipient

unitTypeId

int32 | null

externalId

string | null

Headers

Accept-Language

string

Language preference header. Allowed languages: German (en-DE).

api-version

string

Defaults to 2.0

API version to use (1 or 2) either with trailing .0 or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).

Responses

401

Error: Unauthorized

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK