Your AWS SES. Your dedicated Mailat. See how it works
Documentation

List Rules

Request, response and authentication details for your Mailat instance.

← All API operations
GET/api/v1/rules

ListRules lists all email rules for the user GET /api/v1/rules Compatibility API synchronized with SES inbox filters. Prefer /inbox/filters. Unsupported legacy actions are rejected; migrated incompatible rules are disabled with migrationWarning.

Authentication & compatibility

Use a scoped bearer API key with email:read. The key is bound to its user and organization.

SES email workflow and its stored mailbox/configuration data. Provider actions require configured AWS permissions and verified owned domains; receiving is opt-in.

Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.

Request

Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.

cURL request
curl --request GET "$MAILAT_BASE_URL/api/v1/rules" \
  --header "Authorization: Bearer $MAILAT_TOKEN"

Parameters

query
activeboolean

Responses

HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.

200 · Success
Header: X-RateLimit-Remaininginteger

Remaining requests in this API key's current minute window (present for API-key authentication).

minimum: 0

application/json

responseobject
Fields
codeintegerrequired
dataarray
Each itemall of · nullable
Variant 1object
Fields · service.EmailRule
actionsarray
Each itemobject
Fields · service.RuleAction
typestring

move_to_folder, add_label, mark_read, mark_starred, forward, delete, auto_reply, stop_processing

valuestring

Folder name, label name, forward address, etc.

activeboolean
conditionLogicstring

"all" or "any"

conditionsarray
Each itemobject
Fields · service.RuleCondition
caseSensitiveboolean
fieldstring

from, to, subject, body, header

headerNamestring

Only for field="header"

operatorstring

contains, equals, matches, starts_with, ends_with, not_contains, not_equals

valuestring
createdAtstring (date-time)
descriptionstring
idinteger (int64)
identityIdsarray
Each iteminteger (int64)
lastMatchedAtall of · nullable
Variant 1string (date-time)
matchCountinteger (int64)
migrationWarningstring
namestring
orgIdinteger (int64)
priorityinteger (int64)
updatedAtstring (date-time)
userIdinteger (int64)
uuidstring
messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract