Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

CompactLayout

Represents the values that define a compact page layout.

This object is available in API version 32.0 and later.

Supported SOAP Calls

create(), delete(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()

Supported REST HTTP Methods

DELETE, GET, PATCH, POST

Fields

Field	Details
DeveloperName	Type string Properties Filter, Group, Sort Description The developer’s internal name for the compact layout (for example, “CL_c”) used in the API. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
FullName	Type string Properties Create, Group, Nillable Description The unique name used as the compact layout identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged` This field is available in API version 38.0 and later.
MasterLabel	Type string Properties Filter, Group, Sort Description The name of the compact layout in Setup.
Metadata	Type `mns:`CompactLayout Properties Create, Nillable, Update Description The compact layout metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace of the package of which the compact layout is a part.
SobjectType	Type Restricted picklist Properties Filter, Group, Restricted picklist, Sort Description The type of object used in the layout, such as an Account or Lead.

CompactLayout is exposed in Tooling API to user profiles with the View Setup and Configuration permission.

Note