Skip to main content

Get Rule Options

GET 
/api/support/admin/rules/options

Returns the vocabulary an automation rule is composed from: the triggers, the condition fields (with their value type, the operators that fit them, and the allowed values for enum fields), the operators, the actions (with the value kind each expects and, where applicable, the allowed values), the customer notices, and the placeholders a message template may use. Use it to validate a rule client-side before creating or updating it; group and notice options reflect the current configuration.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Response fields

  • triggers[] — value (string), label (string).
  • fields[] — value (string), label (string), type (string — one of: enum, string, text, list, number, bool, user, tenant), options (object[] — value, label; only for enum fields, otherwise null), operators (string[] — the operator values that fit this field).
  • operators[] — value (string), label (string), unary (boolean — takes no value), applies_to (string[] — the field types it fits).
  • actions[] — value (string), label (string), value_type (string — one of: status, priority, type, group, user, users, list, template, notice, none), options (object[] — value, label; for set_status, set_priority, set_type, set_group and send_customer_notice, otherwise null).
  • customer_notices[] — value (string), label (string).
  • template_placeholders (string[]) — keys usable as {{key}} in notify_slack and add_internal_note templates.

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role who also holds the support admin role. No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type