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.
Parâmetros de consulta
action
string
Filter by rule action.
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.
Payload de resposta
data
array of object
obrigatório
Mostrar atributos secundários
data.id
string
obrigatório
Receive rule ID.
data.mailbox_id
string
obrigatório
The mailbox the rule applies to.
data.action
string
obrigatório
What the rule does when it matches. Block rules always win — over allow rules and over the reply admission on allowlist mailboxes.
data.entry
string
obrigatório
The sender address or domain the rule matches. Domains also match their subdomains.
data.entry_type
string
obrigatório
Whether the entry is a full address or a domain.
data.note
nullable string
obrigatório
Your own note about why the rule exists. Null when unset.
data.created_at
string
obrigatório
When the rule was created.
next_cursor
nullable string
obrigatório
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obrigatório
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obrigatório
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.