SMsmartsheet
automationRules

Get an automation rule

Returns the specified automation rule, including any action values.

get/sheets/{sheetId}/automationrules/{automationRuleId}

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SHEETS

Response

AutomationRule object

idnumber

AutomationRule ID.

actionunknown
disabledReason'APPROVAL_COLUMN_MISSING' | 'APPROVAL_COLUMN_WRONG_TYPE' | 'AUTOMATION_NOT_ENABLED_FOR_ORG' | 'COLUMN_MISSING' | 'COLUMN_TYPE_INCOMPATIBLE' | 'NO_POTENTIAL_RECIPIENTS' | 'NO_VALID_SELECTED_COLUMNS'

Machine-readable reason a rule is disabled:

  • APPROVAL_COLUMN_MISSING This rule's approval status column has been deleted.

  • APPROVAL_COLUMN_WRONG_TYPE The approval column must be a dropdown column.

  • AUTOMATION_NOT_ENABLED_FOR_ORG To create or edit automated actions, you need to upgrade your organization account to a Business or Enterprise plan.

  • COLUMN_MISSING A column referenced by this rule has been deleted.

  • COLUMN_TYPE_INCOMPATIBLE A column referenced by this rule has been changed to an incompatible column type.

  • NO_POTENTIAL_RECIPIENTS This rule has no recipients that will be able to receive notifications based on this sheet's permission settings or this account's approved domain sharing list.

  • NO_VALID_SELECTED_COLUMNS All selected columns for this rule have been deleted.

disabledReasonTextstring

Descriptive reason a rule is disabled.

enabledboolean

If true, indicates that the rule is active.

namestring

Rule name as shown in the UI.

userCanModifyboolean

If true, indicates that the current user can modify the rule.

Example response

{
  "createdBy": {
    "email": "jane.doe@smartsheet.com",
    "name": "Jane Doe"
  },
  "modifiedBy": {
    "email": "jane.doe@smartsheet.com",
    "name": "Jane Doe"
  }
}

Changes

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