Get Layout Rule

GET {{baseUrl}}/api/v1/layouts/:layout_id/layoutRules/{layoutRule_id}

This API fetches a single rule from your help desk layout.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
includestringAdditional information related to the rules. Values allowed are: creator and modifier.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"fieldConditions":[{"name":"condition 1","pattern":"(1and2)","conditions":[{"condition":"is","fieldName":"email","value":["carol@zylker.com"]},{"condition":"is","fieldName":"phone","value":["9993292892"]}],"actions":{"showSections":["Additional Information"],"showFields":["subject"],"setMandatoryFields":["priority"]}}],"modifiedTime":"2018-09-14T01:08:42.000Z","fieldName":"email","description":"Rule 1 for layout","systemGenerated":false,"layoutId":"4000000007723","executeInHelpCentre":false,"createdBy":"4000000015963","name":"Rule 1","createdTime":"2018-09-14T01:07:22.000Z","modifiedBy":"4000000015963","id":"4000000020001","status":"active"}