/api/inquiries/search

post

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

Search

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.

Query Params

PageSize

int32

PageNumber

int32

Body Params

searchTerm

string | null

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

ids

array of int32s | null

ids

orderBy

array of strings | null

orderBy

processId

int32 | null

Filter by the ID of the associated process.

unitId

int32 | null

Filter by the ID of the connected unit.

propertyId

int32 | null

Filter by the ID of the connected property.

sourceId

int32 | null

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

readStatus

int32 | null

Filter by the read status of the inquiry (0 for unread, 1 for accepted, 2 for rejected).

createdInYear

int32 | null

Filter by the year the inquiry was created.

createdInMonth

int32 | null

Filter by the month the inquiry was created.

createdInDay

int32 | null

Filter by the day the inquiry was created.

createdFrom

date-time | null

Filter inquiries created from this date onwards.

createdUntil

date-time | null

Filter inquiries created until this date.

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