SearchLayout

Represents a search layout defined for an object.

Version 

Introduced in API version 34.0.

Supported SOAP API Calls 

describeSObjects(), query()

Supported REST API Methods 

Query

Limitations 

SOQL Limitations

SOSL Limitations

Fields 

ButtonsDisplayed 

• Type: complexvalue

• Required: No

• 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

• Required: No

• 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

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: ID of the record in EntityDefinition. Use in subqueries.

FieldsDisplayed 

• Type: complexvalue

• Required: No

• 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

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The label for this search layout.

LayoutType 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The type of search layout.

ListLayout 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 48.0

• Description: Unique identifier for the field. Identifies the list layout a search layout is related to.

Profile 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 48.0

• Description: Unique identifier for the field. Identifies the profile to which a search layout applies.

ProfileName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 48.0

• Description: The name of the profile to which a search layout applies.

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 - 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.