---
schema_version: "1"
id: d8335924d8600210236f9c5f09dc0b3554b93ef84abfa6415dad57b028a8ccdc
title: SearchLayout
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_searchlayout.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_searchlayout.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: a249bbfd89bb03273b0063d28e3c55d90a7c6a6160ec64f684a0d7e03d424e07
description: Represents a search layout defined for an object.
---
# SearchLayout

Represents a search layout defined for an object.

This object is available in the Tooling API version 34.0 and later.

## Supported SOAP Calls

describeObjects(), query()

## Supported REST HTTP Methods

GET

## Limitations

[SOQL Limitations](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/reference_objects_soql_limits.htm "Some Tooling API objects have SOQL limitations. These limitations apply to any Metadata Catalog query, which applies to all Custom Metadata Types and Metadata Catalog entities, not only the ones explicitly listed.")

[SOSL Limitations](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/reference_objects_sosl_limits.htm "Two Tooling API objects, EntityDefinition and FieldDefinition, have some SOSL limitations. ExternalString and MetadataComponentDependency (Beta) don’t support SOSL searches.")

## Fields

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

[SearchLayoutButtonsDisplayed](#searchlayoutbuttonsdisplayed)

Properties

Nillable

Description

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

This field is equivalent to the Buttons Displayed value in Object Name List View in the Search Layouts related list on the object detail page. It’s also equivalent to the listViewButtons field on SearchLayouts 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.



 |
| EntityDefinition | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

The name of the object associated with this search layout. Use in subqueries.



 |
| EntityDefinitionId | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

ID of the record in EntityDefinition. Use in subqueries.



 |
| FieldsDisplayed | 

Type

[SearchLayoutFieldsDisplayed](#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 the Search Results in the Search Layouts related list on the object detail page in the application user interface. It’s also equivalent to searchResultsAdditionalFields 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.



 |

## SearchLayoutButtonsDisplayed

| Type | Details |
| --- | --- |
| applicable | 
Type

boolean

Description

If true, the buttons listed in buttons apply to the object associated with this search layout.



 |
| buttons | 

Type

[SearchLayoutButton](#SearchLayoutButton)

Description

The list of buttons on the object associated with this search layout.



 |

## SearchLayoutButton

| Type | Details |
| --- | --- |
| apiName | 
Type

string

Description

The API name of the button.



 |
| label | 

Type

string

Description

The button’s label text.



 |

## SearchLayoutFieldsDisplayed

| Type | Details |
| --- | --- |
| applicable | 
Type

boolean

Description

If true, the fields listed in fields are available in the object associated with this search layout.



 |
| fields | 

Type

string

Description

The list of fields on the object associated with this search layout.



 |

## SearchLayoutField

| Type | Details |
| --- | --- |
| apiName | 
Type

string

Description

The API name of the field.



 |
| label | 

Type

string

Description

The field’s label text.



 |
| sortable | 

Type

boolean

Description

If true, the fields can be sorted.



 |