/api/document-groups/search

post

https://api.facilioo.de/api/document-groups/search

Search

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

Module: Documents

Returns: Documents → Document Groups → DocumentGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

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

This will be evaluated against your used access token.

Query Params

PageSize

int32

PageNumber

int32

Body Params

searchTerm

string | null

Searches the DocumentGroup's Name.

ids

array of int32s | null

ids

orderBy

array of strings | null

orderBy

isRoot

boolean | null

Has no parent document group.

parentId

int32 | null

Retrieve all direct children of this group id.

anyParentId

int32 | null

Retrieve all descendants of this group id.

childId

int32 | null

Retrieve all direct parents of this group id.

anyChildId

int32 | null

Retrieve all ancestor this group id.

wasRead

boolean | null

Based on contained documents and requesters read state.

propertyId

int32 | null

Based on contained documents.

entranceId

int32 | null

Based on contained documents.

unitId

int32 | null

Based on contained documents.

contractId

int32 | null

Based on contained documents.

partyId

int32 | null

Based on contained documents.

isSharedForParty

boolean | null

Filters for document groups that have 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

200OK