Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Rules

Get rule

Fetch a rule.

Required scope: rules:read

get/rules/{rule_id}

Path parameters

rule_idstring required

The Rule ID

Response

A rule

idstring required

Unique identifier of the rule

namestring required

Name of the rule

actionsstring[] required

List of the rule's actions description

is_privateboolean required

Whether or not the rule is individual

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/rules/rul_58xhq"
  },
  "id": "rul_58xhq",
  "name": "Scranton new account workflow"
}