FRfrontapp
Rules

Get rule

Fetch a rule.

Required scope: rules:read

get/rules/{rule_id}

Request

  • Base URL
    https://api2.frontapp.com
  • URL
    https://api2.frontapp.com/rules/{rule_id}
  • Auth
    HTTP bearer

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",
  "actions": [
    "Assign to Pam",
    "Unassign from Michael",
    "Tag with Scranton is the Best Branch",
    "Tag with Michael is the Best Boss"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.