/api/documents/search

post

https://api.facilioo.de/api/documents/search

Search

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

Module: Documents

Returns: Documents → Documents → DocumentRead (paginated)

Authorization

Required Token Scopes: Platform (0)

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

This will be evaluated against your used access token.

Query Params

PageSize

int32

PageNumber

int32

Body Params

searchTerm

string | null

Searches the Document's Title and Description.

ids

array of int32s | null

ids

orderBy

array of strings | null

orderBy

documentGroupId

int32 | null

Is direct child of this document group.

anyParentDocumentGroupId

int32 | null

Is descendant of this document group.

wasRead

boolean | null

Based requesters read state.

propertyId

int32 | null

entranceId

int32 | null

unitId

int32 | null

contractId

int32 | null

partyId

int32 | null

isSharedForParty

boolean | null

Filters for documents directly attached to a party (it doesn't have to be the requesters party).

fileTypeIds

array of int32s | null

fileTypeIds

dateAfter

date-time | null

dateBefore

date-time | 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

Response

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

application/json

200OK