Retrieve Page Layouts

Given an object, retrieve all page layouts associated with that object. You can use this data to retrieve specific page layout metadata.

GET/api/{version}/metadata/vobjects/{object_name}/page_layouts

Headers

Name	Description
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`{object_name}`	The `name` of the object from which to retrieve page layouts.

Request

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v23.1/metadata/vobjects/quality_event__qdm/page_layouts

Response

{
   "responseStatus": "SUCCESS",
   "data": [
       {
           "name": "quality_event_detail_page_layout__c",
           "label": "Quality Event Page Layout",
           "object_type": "base__v",
           "url": "/api/v23.1/metadata/vobjects/quality_event__qdm/page_layouts/quality_event_detail_page_layout__c"
       },
       {
           "name": "change_control_detail_page_layout__c",
           "label": "Change Control Detail Page Layout",
           "object_type": "change_control__qdm",
           "url": "/api/v23.1/metadata/vobjects/quality_event__qdm/page_layouts/change_control_detail_page_layout__c"
       },
       {
           "name": "internal_finding_detail_page_layout__c",
           "label": "Internal Finding Detail Page Layout",
           "object_type": "internal_finding__qdm",
           "url": "/api/v23.1/metadata/vobjects/quality_event__qdm/page_layouts/internal_finding_detail_page_layout__c"
       }
    ]

}

Response Details

On SUCCESS, the API returns the name, label, and object_type associated with all page layouts in the specified object.