List forwarding rules
Every forwarding rule of the team, in the order they are tried, with its addresses and whether each is confirmed.
GET
https://app.usenotix.dev/api/v1/forwarding-rulesFull access and read only keys can call this. Sending access keys cannot. Key permissions lists the extra rules some calls have.
Every forwarding rule of the team, in the order they are tried, with its addresses and whether each is confirmed.
Full access and read only keys can call it. A key limited to one domain sees only rules on receiving domains under its domain. Send-only and live AI keys cannot.
Headers
Authorizationstringrequired
Bearer followed by your API key.
Errors
403
`SCOPE_DENIED`: a send-only or live AI key.
Every error has the same shape. See all error codes.
curl -X GET "https://app.usenotix.dev/api/v1/forwarding-rules" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.forwarding.listRules();
Response200
{
"data": [
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"name": "Acme",
"pattern": "billing@reply.acmepay.com",
"patternType": "EXACT",
"receivingDomain": "reply.acmepay.com",
"destinations": [
null
],
"webhookId": "cm1x8f3k20001qz7v5b9d2e4a",
"fromAddress": "string",
"subjectPrefix": "Your receipt for order 4471",
"allowChaining": true,
"passthrough": true,
"note": "string",
"active": true,
"priority": 1,
"paused": true,
"pausedAt": "string",
"pauseReason": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}