Get domain-wide sender filters

{ "ok": true, "meta": { "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx" }, "data": { "rules": [ { "pattern": "partner.com", "note": "billing webhooks" } ] } }

Authorizations

Authorization

string

header

required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-None-Match

string

Weak ETag from a previous response. Returns 304 when unchanged.

Path Parameters

public_id

string

required

Domain public ID

Response

Filter state

enum<boolean>

required

Available options:

true

meta

object

required

Hide child attributes

meta.request_id

string

required

Example:

"req_clxxxxxxxxxxxxxxxxxxxxxxxxx"

data

object

required

Hide child attributes

data.mode

enum<string>

required

Active filtering mode. off disables filtering (all senders accepted). allowlist only accepts senders matching a rule. denylist blocks senders matching a rule.

Available options:

off,

allowlist,

denylist

data.rules

object[]

required

Current rules, sorted by pattern ascending

Hide child attributes

data.rules.type

enum<string>

required

Rule type

Available options:

allow,

deny

data.rules.pattern

string

required

Email address or bare domain name. Validated against RFC 5321/1035 regexes. The *@domain wildcard spelling is accepted and normalised to the bare domain (matching is by exact address or sender domain).

Example:

"partner.com"

data.rules.note

string | null

Free-form caption for the rule (≤255 chars). UI-only metadata — never consulted at match time. null when absent.

Maximum string length: 255

Example:

"billing webhooks"