---
schema_version: "1"
id: 52cb912ad70886e2d8a470eb604e427880955acb5c4a79ac26ad3566de95ff9f
title: CompactLayout
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_compactlayout.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_compactlayout.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6d2d82218248d4e8a80c6c6f21fc61cc3c4cd0982fcf8967f2ff135eec63e9e9
description: Represents the values that define a compact page layout.
---
# 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

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


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

              <th class="featureTableHeader  " id="d60844e87">Details</th>

            </tr>

          </thead>

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

              <td class="entry" headers="d60844e87" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The developer’s internal name for the compact layout
                    (for example, “CL_c”) used in the API.</dd>


                  <dd class="dd">
                    <div class="box message info">
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p>Only users with View DeveloperName OR View Setup
                                and Configuration permission can view, group, sort,
                                and filter this field.</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>

                  </dd>



                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d60844e87" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Group, Nillable</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The unique name used as the compact layout identifier
                    for API access. The
                    <span class="keyword parmname">fullName</span> 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.
                  </dd>

                  <dd class="dd">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.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d60844e87" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">ManageableState enumerated list</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Nillable, Restricted picklist, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates the manageable state of the specified component that is contained
                    in a package: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">beta</samp></li>

                      <li class="li"><samp class="codeph nolang">deleted</samp></li>

                      <li class="li"><samp class="codeph nolang" id="d2076e189-d2107e373"><a name="d2076e189-d2107e373"><!-- --></a>deprecated</samp></li>

                      <li class="li"><samp class="codeph nolang">deprecatedEditable</samp></li>

                      <li class="li"><samp class="codeph nolang">installed</samp></li>

                      <li class="li"><samp class="codeph nolang">installedEditable</samp></li>

                      <li class="li"><samp class="codeph nolang">released</samp></li>

                      <li class="li"><samp class="codeph nolang">unmanaged</samp></li>

                    </ul>
                  </dd>


                </dl>

                <p class="p">This field is available in API version 38.0 and later.</p>

              </td>

            </tr>

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

              <td class="entry" headers="d60844e87" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The name of the compact layout in Setup.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d60844e87" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">
                    <samp class="codeph nolang">mns:</samp>CompactLayout
                  </dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Nillable, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The compact layout metadata.</dd>

                  <dd class="dd">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.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d60844e87" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Nillable, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The namespace of the package of which the compact layout
                    is a part.</dd>


                </dl>

              </td>

            </tr>

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

              <td class="entry" headers="d60844e87" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">Restricted picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Group, Restricted picklist, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The type of object used in the layout, such as an
                    Account or Lead.</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png)

#### Note

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