---
schema_version: "1"
id: a4e614f488178f4b81da0f6abf35fcdccf633a25e470751e92df223d7aa58aa6
title: SearchLayouts
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_searchlayouts.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_searchlayouts.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 0aff5469c35c208e54d571459208fb73a7b3990dc96fed044143300fb14b2f09
description: Represents the metadata associated with the search layouts for an object. You can customize which fields to display for users in search results, search filter fields, lookup dialogs, and recent record lists on tab home pages. You can access SearchLayouts only by accessing its encompassing CustomObject.
---
# SearchLayouts

Represents the metadata associated with the search layouts for an object. You can customize which fields to display for users in search results, search filter fields, lookup dialogs, and recent record lists on tab home pages. You can access SearchLayouts only by accessing its encompassing CustomObject.

For more information, see [Customize Layouts for Search Results](https://help.salesforce.com/articleView?id=ai.customizing_search_layouts.htm&type=5&language=en_US "HTML (New Window)") and [Customize Search Layouts for Custom Objects](https://help.salesforce.com/articleView?id=ai.customizing_search_layouts.htm&type=5&language=en_US) in Salesforce Help.

## Version

Search layouts for custom objects are available in API version 14.0 and later. The ability to modify search layouts for standard objects (except events and tasks) is available in API version 27.0 and later.

## Fields

When defining metadata for search layouts:

- Any Name field defined as a text type is mandatory; it’s always displayed as the first column in the search results page. When you query for a list of fields; the name field isn’t returned but all other fields are. If you define the Name field as an autonumber type, it’s not mandatory and you can remove it from the list, but when you import the search layout with Metadata API, it will always add the Name field back. These rules apply to customTabListAdditionalFields, lookupDialogsAdditionalFields, lookupPhoneDialogsAdditionalFields, and searchResultsAdditionalFields
- For custom objects, the search layout uses the API name, for example, MyCustomField\_\_c instead of the field name My Custom Field.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d838295e107">Field</th>

              <th class="featureTableHeader  " id="d838295e110">Field Type</th>

              <th class="featureTableHeader  " id="d838295e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">customTabListAdditionalFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields displayed in the Recent <var class="keyword varname">Object
                  Name</var> list view for an object.</td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">excludedStandardButtons</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of standard buttons excluded from the search
                layout.</td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">listViewButtons</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of buttons available in list views for an object.<p class="p">This
                  field is equivalent to the Buttons Displayed value in the
                  <span class="keyword parmname"><var class="keyword varname">Object Name</var> List
                    View</span> in the related list of the object detail
                  page in the UI.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">lookupDialogsAdditionalFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields displayed in a lookup dialog for the
                object.<p class="p">Salesforce objects often include one or more
                  <dfn class="term">lookup fields</dfn> that allow users to associate two
                  records together in a relationship. For example, a contact
                  record includes an <span class="keyword parmname">Account</span> lookup field
                  that represents the relationship between the contact and the
                  organization with which the contact is associated. A lookup
                  search dialog helps you search for the record associated with
                  the one being edited. Lookup filter fields allow you to filter
                  your lookup search by a customized list of fields in the
                  object.
                </p>
                <p class="p">This field is equivalent to the <span class="keyword parmname">Lookup
                    Dialogs</span> related list on the object detail page in
                  the UI.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">lookupFilterFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields that can be used to filter enhanced lookups
                for an object. Enhanced lookups are optionally enabled by your
                administrator.<p class="p">This field is equivalent to the
                  <span class="keyword parmname">Lookup Filter Fields</span> related list on
                  the object detail page in the application user interface.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">lookupPhoneDialogsAdditionalFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of phone-related fields displayed in a lookup dialog for
                the object.<p class="p">This list enables integration of the fields with a
                  softphone dial pad.</p>
                <p class="p">This field is equivalent to the
                  <span class="keyword parmname">Lookup Phone Dialogs</span> related list on
                  the object detail page in the application user
                  interface.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">massQuickActions</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of actions that you can use to perform mass quick action
                on records. Use this field to add an existing create or update
                action.<p class="p">You can perform mass quick actions on custom objects
                  and all standard objects that support quick actions and have a
                  search layout in Lightning Experience. This includes but isn’t
                  limited to cases, leads, accounts, campaigns, contacts,
                  opportunities, and work orders.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">searchFilterFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields that can be used to filter a search for the
                object.<p class="p">This field is equivalent to the <span class="keyword parmname">Search
                    Filter Fields</span> related list on the object detail
                  page in the application user interface.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">searchResultsAdditionalFields</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of fields displayed in a search result for the
                object.<p class="p">This field is equivalent to the <span class="keyword parmname">Search
                    Results</span> related list on the object detail page in
                  the application user interface.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d838295e107" data-title="Field"><span class="keyword parmname">searchResultsCustomButtons</span></td>

              <td class="entry" headers="d838295e110" data-title="Field Type">string[]</td>

              <td class="entry" headers="d838295e113" data-title="Description">The list of custom buttons available in a search result for the
                object. The actions associated with the buttons can be applied to
                any of the records returned in the search result.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample definition of object’s search layout is shown..

<?xml version="1.0" encoding="UTF-8"?>
                <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
                . . .
                <searchLayouts\>
                <listViewButtons\>New</listViewButtons\>
                <listViewButtons\>Accept</listViewButtons\>
                <listViewButtons\>ChangeOwner</listViewButtons\>
                <lookupDialogsAdditionalFields\>firstQuote\_\_c</lookupDialogsAdditionalFields\>
                <lookupDialogsAdditionalFields\>finalQuote\_\_c</lookupDialogsAdditionalFields\>
                <massQuickActions\>Create\_MQA\_Contact</massQuickActions\>
                <searchResultsAdditionalFields\>CREATEDBY\_USER</searchResultsAdditionalFields\>
                </searchLayouts\>
                . . .
                </CustomObject\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

- [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordtype.htm "RecordType")
- [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_apexsharingreason.htm "SharingReason")

#### See Also

- [CustomObject](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customobject.htm "Represents a custom object that stores data unique to your org or an external object that maps to data stored outside your org.")
- [ProfileSearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_profilesearchlayouts.htm "Represents a user profile’s search results layouts for an object. ProfileSearchLayouts are similar to SearchLayouts. However, with profile-specific layouts, each user profile can have a different search results layout for an object.")