Search Inquiries

Search Inquiries

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

Module: Inquiries

Returns: Inquiries → Inquiries → InquiryRead (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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
int32
Body Params
string | null

Searches the Inquiry's ID, Report, RejectionResponse, and CompletionResponse.

ids
array of int32s | null
ids
orderBy
array of strings | null
orderBy
int32 | null

Filter by the ID of the associated process.

int32 | null

Filter by the ID of the associated user task (currently named AssociatedTodoID).

int32 | null

Filter by the ID of the creator account.

int32 | null

Filter by the ID of the creator party.

int32 | null

Filter by the ID of the receiver party.

int32 | null

Filter by the ID of the connected party.

int32 | null

Filter by the ID of the connected unit.

int32 | null

Filter by the ID of the connected property.

int32 | null

Filter by the ID of the tenant of the connected property.

int32 | null

Filter by the ID of the InquirySource. For example can be Customer App, E-Mail, Phone, etc.

int32 | null

Filter by the ID of the InquiryCategory.

int32 | null

Filter by the ID of an account (of your own Party) that can access the inquiry.

int32 | null
enum

Possible values:

  • 0 = Unknown
  • 10 = Low
  • 20 = Middle
  • 30 = High
Allowed:
readStatus
array of objects | null

Filter by the read status of the inquiry.

readStatus
int32 | null

Filter by the year the inquiry was created.

int32 | null

Filter by the month the inquiry was created.

int32 | null

Filter by the day the inquiry was created.

date-time | null

Filter inquiries created from this date onwards.

date-time | null

Filter inquiries created until this date.

boolean | null

When true, only returns inquiries that have a due date set. When false, only returns inquiries without a due date.

date-time | null

Filter inquiries with a due date from this date onwards.

date-time | null

Filter inquiries with a due date until this date.

date-time | null

Filter inquiries last modified from this date onwards.

date-time | null

Filter inquiries last modified until this date.

Headers
string

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