Search Document Groups

Search Document Groups

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

Module: Documents

Returns: Documents → Document Groups → DocumentGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

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

Required Account Permission: ReadDocumentGroup (72)

This will be evaluated against your used access token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
1 to 100
Defaults to 10

Defines the number of results per page. Must be between 1 and 100.

int32
≥ 1
Defaults to 1

Specifies which page of results to return, starting from 1. The maximum depends on the total number of available results and the selected page size.

Body Params

The document-based filters (wasRead, propertyId, entranceId, unitId, contractId, partyId, isSharedForParty, fileTypeIds, dateAfter and dateBefore) match a group when at least one accessible document matching all of them is filed in the group or in any group below it.
As soon as one of them is set, groups without such a document are left out, including empty groups.

string | null

Searches the DocumentGroup's Name.

ids
array of int32s | null

Restricts the results to the entries matching the specified IDs.

ids
orderBy
array of strings | null

Defines the sort order of the results, e.g., "name desc", "name asc", or simply "name" (with default sorting order).

orderBy
date-time | null

Restricts the results to entities where Created or LastModified is on or after the specified timestamp.
More info: Dates and Times

date-time | null

Restricts the results to entities where Created is on or after the specified timestamp.
More info: Dates and Times

date-time | null

Restricts the results to entities where Created is on or before the specified timestamp.
More info: Dates and Times

date-time | null

Restricts the results to entities where LastModified is on or after the specified timestamp.
More info: Dates and Times

date-time | null

Restricts the results to entities where LastModified is on or before the specified timestamp.
More info: Dates and Times

boolean | null

When true, restricts the results to top-level groups.
When false, restricts the results to groups nested under another group.

int32 | null

Restricts the results to the groups nested directly under this group.

int32 | null

Restricts the results to this group and every group below it at any depth.

int32 | null

Restricts the results to the group this group is nested directly under.

int32 | null

Restricts the results to this group and every group above it up to the top level.

boolean | null

Restricts the results to groups containing a document shared with the requesting party that it has read (true) or not yet read (false).
Documents not shared with the requesting party never match.

int32 | null

Restricts the results to groups containing a document assigned to this property.
Only matches the exact property, so documents assigned to one of its entrances are not included.

int32 | null

Restricts the results to groups containing a document assigned to this entrance.

int32 | null

Restricts the results to groups containing a document assigned to this unit.

int32 | null

Restricts the results to groups containing a document assigned to this contract.

int32 | null

Restricts the results to groups containing a document assigned to this party.

boolean | null

When true, restricts the results to groups containing a document assigned to a party only, without a property, unit or contract.
The party doesn't have to be the requesting party.
false applies no filter.

fileTypeIds
array of int32s | null

Restricts the results to groups containing a document whose file is of one of these file types.

fileTypeIds
date-time | null

Restricts the results to groups containing a document whose date is on or after the specified timestamp.
Documents without a date never match.
More info: Dates and Times

date-time | null

Restricts the results to groups containing a document whose date is on or before the specified timestamp.
Documents without a date never match.
More info: Dates and Times

string | null

Restricts the results to the group with this identifier from an external system.
More info: External IDs

Headers
string
Defaults to en-DE

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

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json