Search View Setting Groups

⚠️ 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 Setting Groups

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

Module: View Settings

Returns: View Settings → ViewSettingGroupRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

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 ViewSettingGroup's Key.

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

Restrict to groups whose key contains this value.

int32 | null
enum

Restrict to groups with this cardinality.

Possible values:

  • 0 = Single
  • 1 = Multi
Allowed:
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