Get a forwarding rule
One rule, with paused and pauseReason: BREAKER (too many forwards in 10 minutes), REPUTATION (bounces or complaints on the team's forwards), KEY_REVOKED…
https://app.usenotix.dev/api/v1/forwarding-rules/{id}Full access and read only keys can call this. Sending access keys cannot. Key permissions lists the extra rules some calls have.
One rule, with paused and pauseReason: BREAKER (too many forwards in 10 minutes), REPUTATION (bounces or complaints on the team's forwards), KEY_REVOKED (the API key that created it was deleted), MEMBER_REMOVED (the member who made it left the team), MEMBER_DEMOTED (the admin who made it became a member) or MANUAL. Pausing an API key does not pause its rules; deleting it does.
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.
Path parameters
Headers
Bearer followed by your API key.
Errors
`SCOPE_DENIED`: a send-only or live AI key.
No rule with this id for the calling team, or outside a pinned key's domain.
Every error has the same shape. See all error codes.
curl -X GET "https://app.usenotix.dev/api/v1/forwarding-rules/<id>" \
-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.getRule("clx9f2k3l0001qz8a7b6c5d4e");
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"name": "Acme",
"pattern": "billing@reply.acmepay.com",
"patternType": "EXACT",
"receivingDomain": "reply.acmepay.com",
"destinations": [
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"email": "customer@example.com",
"status": "PENDING"
}
],
"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"
}