Search Inquiries

post

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

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

PageSize

int32

PageNumber

int32

Body Params

searchTerm

string | null

Searches the Inquiry's ID, Report, RejectionResponse, CompletionResponse, AI Subject Recommendation, and AI Summary.

ids

array of int32s | null

ids

orderBy

array of strings | null

orderBy

changedSince

date-time | null

Restricts the results to entities where Created or LastModified is on or after the specified timestamp.

createdFrom

date-time | null

Restricts the results to entities where Created is on or after the specified timestamp.

createdUntil

date-time | null

Restricts the results to entities where Created is on or before the specified timestamp.

lastModifiedFrom

date-time | null

Restricts the results to entities where LastModified is on or after the specified timestamp.

lastModifiedUntil

date-time | null

Restricts the results to entities where LastModified is on or before the specified timestamp.

processId

array of int32s | null

Filter by the ID of the associated process.

processId

userTaskId

array of int32s | null

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

userTaskId

creatorAccountId

array of int32s | null

Filter by the ID of the creator account.

creatorAccountId

creatorPartyId

array of int32s | null

Filter by the ID of the creator party.

creatorPartyId

receiverPartyId

array of int32s | null

Filter by the ID of the receiver party.

receiverPartyId

connectedPartyId

array of int32s | null

Filter by the ID of the connected party.

connectedPartyId

unitId

array of int32s | null

Filter by the ID of the connected unit.

unitId

propertyId

array of int32s | null

Filter by the ID of the connected property.

propertyId

tenantId

array of int32s | null

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

tenantId

sourceId

array of int32s | null

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

sourceId

categoryId

array of int32s | null

Filter by the ID of the InquiryCategory.

categoryId

accessibleByAccountId

array of int32s | null

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

accessibleByAccountId

priority

array of objects | null

Filter by the priority of the inquiry.

priority

Allowed:

labelId

array of int32s | null

Filter by the ID of an associated label.

labelId

readStatus

array of objects | null

Filter by the read status of the inquiry.

readStatus

Allowed:

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.

hasDueDate

boolean | null

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

dueDateFrom

date-time | null

Filter inquiries with a due date from this date onwards.

dueDateUntil

date-time | null

Filter inquiries with a due date 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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK