List Layouts
GET {{baseUrl}}/api/v1/layouts?module=<String>
This API lists all the layouts configured for a module.
OAuth Scope
Desk.basic.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
module | string | Name of the module whose layouts must be fetched. Values allowed are tickets, contacts, accounts , calls , events, tasks, timeEntry, products, and contracts. | |
departmentId | string | ID of the department in which the layouts are configured | |
status | string | Status of the layout Values allowed are active | |
from | string | from index | |
limit | string | no of layouts to be fetched | |
layoutName | string | Name of the layout used as the keyword for the search |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"modifiedTime":"2019-05-09T06:24:10.000Z","departmentId":"4000000012710","module":"Cases","layoutDisplayName":"New Layout For Tickets","layoutDesc":"DESC","isDefaultLayout":true,"layoutName":"New Layout For Tickets","skipDeptAccessValidation":false,"layoutProfiles":[{"profileName":"Support Administrator","isDefault":true,"id":"4000000015183","type":"ADMIN"},{"profileName":"Agent","isDefault":true,"id":"4000000015186","type":"STANDARD"},{"profileName":"Help Center","isDefault":true,"id":"4000000015189","type":"PORTAL"}],"createdBy":"4000000015894","createdTime":"2019-05-03T06:36:33.000Z","modifiedBy":"4000000015894","id":"4000000013464","status":"active"},{"modifiedTime":"2019-05-06T01:45:58.000Z","departmentId":"4000000012710","module":"Cases","layoutDisplayName":"cloneLayout","layoutDesc":"DESC","isDefaultLayout":false,"layoutName":"cloneLayout","skipDeptAccessValidation":false,"layoutProfiles":[{"profileName":"Support Administrator","isDefault":true,"id":"4000000015183","type":"ADMIN"},{"profileName":"Agent","isDefault":true,"id":"4000000015186","type":"STANDARD"},{"profileName":"Help Center","isDefault":true,"id":"4000000015189","type":"PORTAL"},{"profileName":"Supervisor","isDefault":false,"id":"4000000015192","type":"CUSTOM"},{"profileName":"Support Manager","isDefault":false,"id":"4000000015195","type":"CUSTOM"},{"profileName":"Newbie Agent","isDefault":false,"id":"4000000015198","type":"CUSTOM"},{"profileName":"Light Agent","isDefault":true,"id":"4000000015201","type":"LIGHT"}],"createdBy":"4000000015894","createdTime":"2019-05-06T01:45:58.000Z","modifiedBy":"4000000015894","id":"4000000017001","status":"active"}]}