/api/contact-details/search

post

https://api.facilioo.de/api/contact-details/search

Search

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

Module: Identity

Returns: Master Data → Parties → Contact Details → ContactDetailsRead (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 ContactDetails's Value (ignoring white spaces).

ids

array of int32s | null

ids

orderBy

array of strings | null

orderBy

partyId

int32 | null

Filters contact details by the owning party. When set, only contact details belonging to the specified party are returned.

contactTypeId

int32 | null

Filters contact details by contact type. Corresponds to ContactTypeId on the contact details entity. When omitted, all contact types are included.

includeSnapshots

boolean | null

Determines whether snapshot entries should be included in the result. true: Includes snapshot contact details (e.g. linked to processes or work orders). false or null: Only current (non-snapshot) contact details are returned.

areBillingDetails

boolean | null

Filters contact details by billing relevance. When set, only contact details matching the given billing flag are returned.

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