PRprimitive
Email Rules

Read a rule

A rule and its current version. The SQL the version renders to is included only when include_sql is true. Needs mail:read, a credential acting as a member with their full access (API keys, agent keys and narrowed tokens are refused), and the email rules feature on the organization.

get/email-rules/{id}

Request

  • Base URL
    https://api.primitive.dev/v1
  • URL
    https://api.primitive.dev/v1/email-rules/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The rule id.

Query parameters

include_sql'true' | 'false'

true to include the SQL the current version renders to.

Response

Read a rule

successtrue required

Changes

No operation changes recorded.