---
schema_version: "1"
id: baa87788fc42e40f9265109bb7d63201cfce93a2db4c19d02df34f0317fb1529
title: SearchLayout
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_searchlayout.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_searchlayout.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4e523c25a376e0d0ca33ce7a432341cc637eb04f460156f8c8396bd1754a3ab6
description: Represents a search layout defined for an object. This object is available in API version 35.0 and later.
---
# SearchLayout

Represents a search layout defined for an object. This object is available in API version 35.0 and later.

## Supported Calls

describeSObjects(), query()

## Special Access Rules

Users with the View Setup and Configuration permission can access this object.

## Fields

| Field | Details |
| --- | --- |
| ButtonsDisplayed | 
Type

[SearchLayoutButtonsDisplayed](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_searchlayout.htm#searchlayoutbuttonsdisplayed)

Properties

Nillable

Description

The list of buttons available in list views for an object.

This field is equivalent to the listViewButtons field on [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_searchlayouts.htm) in Metadata API.



 |
| DurableId | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. DurableId in queries allows you to find the right record without having to retrieve the entire record.



 |
| EntityDefinitionId | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

ID of the record in EntityDefinition. Use in subqueries.

This field is a relationship field.

Relationship Name

EntityDefinition

Refers To

EntityDefinition



 |
| FieldsDisplayed | 

Type

[SearchLayoutFieldsDisplayed](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/tooling_api_objects_searchlayout.htm#searchlayoutfieldsdisplayed)

Properties

Nillable

Description

The list of fields displayed in a search result for the object. The name field is required. It’s always displayed as the first column header, so it isn’t included in this list; all additional fields are included. The field name relative to the object name, for example MyCustomField\_\_c, is specified for each custom field.

This field is equivalent to searchResultsAdditionalFields on [SearchLayouts](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_searchlayouts.htm) in Metadata API.



 |
| Label | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The label for this search layout.



 |
| LayoutType | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The type of search layout.



 |
| ListLayout | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

Unique identifier for the field. Identifies the list layout a search layout is related to. Available in API version 48.0 and later.



 |
| Profile | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

Unique identifier for the field. Identifies the profile to which a search layout applies. Available in API version 48.0 and later.





 |
| ProfileName | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The name of the profile to which a search layout applies. Available in API version 48.0 and later.



 |

## Usage

Use the SearchLayout object to control the fields displayed and actions available to a user profile. The search layout applies to global and lookup searches.