Search Documents

Search Documents

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)

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
string | null

Searches the Document's Title and Description.

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

int32 | null

Restricts the results to documents filed directly in this document group.

int32 | null

Restricts the results to documents filed in this document group or in any group below it.

boolean | null

Restricts the results to documents 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 documents 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 documents assigned to this entrance.

int32 | null

Restricts the results to documents assigned to this unit.

int32 | null

Restricts the results to documents assigned to this contract.

int32 | null

Restricts the results to documents assigned to this party.

boolean | null

When true, restricts the results to documents 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 documents whose file is of one of these file types.

fileTypeIds
date-time | null

Restricts the results to documents 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 documents 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 document 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