List receive rules
GET
/v1/email/mailboxes/{mailbox_id}/receive-rules
curl -X GET "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/receive-rules" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"Returns a paginated list of the mailbox's receive rules, oldest first. Filter by action to see only allow or only block entries.
Abfrageparameter
action
string
Filter by rule action.
Possible values: allow, block
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Antwort-Payload
data
array of object
erforderlich
Untergeordnete Attribute anzeigen
data.id
string
erforderlich
Receive rule ID.
data.mailbox_id
string
erforderlich
The mailbox the rule applies to.
data.action
string
erforderlich
What the rule does when it matches. Block rules always win — over allow rules and over the reply admission on allowlist mailboxes.
Possible values: allow, block
data.entry
string
erforderlich
The sender address or domain the rule matches. Domains also match their subdomains.
data.entry_type
string
erforderlich
Whether the entry is a full address or a domain.
Possible values: address, domain
data.note
nullable string
erforderlich
Your own note about why the rule exists. Null when unset.
data.created_at
string
erforderlich
When the rule was created.
next_cursor
nullable string
erforderlich
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
erforderlich
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
erforderlich
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.