Search View Settings

⚠️ Experimental — this endpoint is subject to change and may be altered or removed without a new API version. Do not rely on it in production integrations.

Search View Settings

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

Module: View Settings

Returns: View Settings → ViewSettingRead (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
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 ViewSetting's Key.

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

Restrict to view settings belonging to this group.

string | null

Restrict to view settings with this exact client-defined key.

int32 | null
enum

Restrict to a single ownership level (derived from the owner columns within the accessible set).

Possible values:

  • 0 = Personal
  • 1 = PartyTemplate
  • 2 = SystemTemplate
Allowed:
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