Back to Developer Center

API v1 Reference

List Custom Object Layouts

Retrieves a list of layouts associated with a custom object.

Endpoint

https://api.neoncrm.com/neonws/services/api/customObject/listCustomObjectLayouts

Request

https://api.neoncrm.com/neonws/services/api/customObject/listCustomObjectLayouts?userSessionId=[session_id]&objectApiName=Custom_Event_c&layoutType=FORM

Response

{
    "listCustomObjectLayoutsResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2017-12-19T18:18:08.124+0000",
        "layoutDetails": {
            "layoutDetail": [
                {
                    "layoutId": 50,
                    "layoutName": "Test Layout 1",
                    "lastModifiedDateTime": "2017-01-19T17:44:48.000+0000",
                    "lastModifiedBy": "John Doe",
                    "isDefault": true
                },
                {
                    "layoutId": 51,
                    "layoutName": "Test Layout 2",
                    "lastModifiedDateTime": "2017-01-19T17:47:35.000+0000",
                    "lastModifiedBy": "John Doe",
                    "isDefault": false
                },
                {
                    "layoutId": 52,
                    "layoutName": "Test Layout 3",
                    "lastModifiedDateTime": "2017-01-19T17:53:54.000+0000",
                    "lastModifiedBy": "John Doe",
                    "isDefault": false
                }
            ]
        }
    }
}

Request Parameters

Parameter Required Description
userSessionId Yes
objectApiName Yes
layoutType Yes Possible values: TABLE, FORM

Response Parameters

Parameter Description
layoutDetails.layoutDetail.layoutId
layoutDetails.layoutDetail.layoutName
layoutDetails.layoutDetail.lastModifiedDateTime
layoutDetails.layoutDetail.lastModifiedBy
layoutDetails.layoutDetail.isDefault