Search EMail Sender 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 EMail Sender Settings

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

Module: EMail Sender Settings

Returns: EMail Sender Settings → EMailSenderSettingRead (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 mailbox From-address and display Name.

ids
array of int32s | null
ids
orderBy
array of strings | null
orderBy
date-time | null

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

date-time | null

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

date-time | null

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

date-time | null

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

date-time | null

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

int32 | null

Filters mailboxes by the owning party.

int32 | null

Filters mailboxes by the owning account.

int32 | null

Filters mailboxes by mail-account type (IMAP/SMTP/Exchange/…).

boolean | null

When set, restricts to company-wide (true) or personal (false) mailboxes.

boolean | null

When set, restricts to primary/default (true) or non-primary (false) mailboxes.

boolean | null

When set, restricts to healthy (true) or failing (false) mailboxes.

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