# legacydeveloper Uiapi - Full Documentation

<!-- document id=4fea7caeda5a68c355f420441906dad4b008aa26b9639ec831e92ede9af2f9d3 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_action.md -->

# Action

The actions for a single record or a collection of records.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| actions | Map<String, [Object Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_action.htm#ui_api_responses_object_action "The actions for an object.")\> | A map of record IDs to the actions for each record. | Small, 41.0 | 41.0 |
| url | String | The URL of the current request. | Big, 41.0 | 41.0 |

#### See Also

- [Get Related List Actions with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_actions_get.htm "Get the actions on related lists for a record detail page. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.")

<!-- document id=f4bd8158da627f9452a605300682e87121c30a6543c75fd0487f9ef6273c9eda url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_action_input.md -->

# Action Input

Get the actions on related lists on a record detail page.

JSON example

To get information about related list actions on a record detail page, use this request with a request body.

POST /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list

{
  "apiNames": \["New"\],
  "retrievalMode": "All"
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d18491e80">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d18491e83">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d18491e86">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d18491e89">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d18491e92">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d18491e80" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d18491e83" data-title="Type">String[]</td>

                  <td class="entry" headers="d18491e86" data-title="Description">The action type. One or more of these values: <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a URL or
                        Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined Salesforce
                        action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or object-specific
                        action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined Salesforce button,
                        such as <strong class="ph uicontrol">New</strong>, <strong class="ph uicontrol">Edit</strong>, and
                        <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d18491e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d18491e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d18491e80" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d18491e83" data-title="Type">String[]</td>

                  <td class="entry" headers="d18491e86" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter only when
                    passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d18491e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d18491e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d18491e80" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d18491e83" data-title="Type">String</td>

                  <td class="entry" headers="d18491e86" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to get a layout
                        for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a layout for
                        tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a layout for phone
                        display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d18491e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d18491e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d18491e80" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d18491e83" data-title="Type">String</td>

                  <td class="entry" headers="d18491e86" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>, this
                    parameter indicates which actions to retrieve from the record page. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified in the
                        <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves actions from the
                        page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d18491e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d18491e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d18491e80" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d18491e83" data-title="Type">String[]</td>

                  <td class="entry" headers="d18491e86" data-title="Description">The section of the user interface that the actions reside in. One or more of these
                    values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d18491e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d18491e92" data-title="Available Version">57.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Get Related List Actions with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_actions_get.htm "Get the actions on related lists for a record detail page. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.")

<!-- document id=add71e792f40469c967a76f1cf09c5265d491891c1d469fee1be89a064dee953 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_action_related_list_single_batch_input.md -->

# Action Related List Single Batch Input

Get the actions on a batch of related lists for a record.

JSON example

To get information about the actions for the Contacts and Opportunities related lists on an Account record page, use this request with parameters in a request body.

POST /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list/batch

{
  "relatedListsActionParameters":
  \[
    {
      "relatedListId": "Contacts",
      "apiNames": \[ "New" \],
      "retrievalMode": "All"
    },
    {
      "relatedListId": "Opportunities",
      "apiNames": \["New" \],
      "retrievalMode": "All"
    }
  \]
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d19695e80">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d19695e83">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d19695e86">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d19695e89">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d19695e92">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d19695e80" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d19695e83" data-title="Type">String[]</td>

                  <td class="entry" headers="d19695e86" data-title="Description">The action type. One or more of these values: <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a URL or
                        Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined Salesforce
                        action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or object-specific
                        action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined Salesforce button,
                        such as <strong class="ph uicontrol">New</strong>, <strong class="ph uicontrol">Edit</strong>, and
                        <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d19695e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d19695e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d19695e80" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d19695e83" data-title="Type">String[]</td>

                  <td class="entry" headers="d19695e86" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter only when
                    passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d19695e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d19695e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d19695e80" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d19695e83" data-title="Type">String</td>

                  <td class="entry" headers="d19695e86" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to get a layout
                        for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a layout for
                        tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a layout for phone
                        display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d19695e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d19695e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d19695e80" data-title="Parameter Name"><samp class="codeph nolang">relatedListId</samp></td>

                  <td class="entry" headers="d19695e83" data-title="Type">String</td>

                  <td class="entry" headers="d19695e86" data-title="Description">The ID of the related list.</td>

                  <td class="entry" headers="d19695e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d19695e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d19695e80" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d19695e83" data-title="Type">String</td>

                  <td class="entry" headers="d19695e86" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>, this
                    parameter indicates which actions to retrieve from the record page. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified in the
                        <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves actions from the
                        page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d19695e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d19695e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d19695e80" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d19695e83" data-title="Type">String[]</td>

                  <td class="entry" headers="d19695e86" data-title="Description">The section of the user interface that the actions reside in. One or more of these
                    values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d19695e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d19695e92" data-title="Available Version">57.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Get a Batch of Related List Actions with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_actions_batch_get.htm "Get the actions on a batch of related lists for a record. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.")

<!-- document id=286920496efb54bd5be59a3db2fa9b1ca4ddcd535814cfd59748f7e08429955c url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_action_related_list_batch_input.md -->

# Action Related Lists Batch Input

Get the actions on a batch of related lists for a record.

JSON example

To get information about the actions for the Contacts and Opportunities related lists on an Account record page, use this request with parameters in a request body.

POST /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list/batch

{
  "relatedListsActionParameters":
  \[
    {
      "relatedListId": "Contacts",
      "apiNames": \[ "New" \],
      "retrievalMode": "All"
    },
    {
      "relatedListId": "Opportunities",
      "apiNames": \["New" \],
      "retrievalMode": "All"
    }
  \]
}

Properties

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| relatedListsActionParameters | [Action Related List Single Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_action_related_list_single_batch_input.htm "Get the actions on a batch of related lists for a record.") | Parameters for each related list in the batch request. | Required | 57.0 |

#### See Also

- [Get a Batch of Related List Actions with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_actions_batch_get.htm "Get the actions on a batch of related lists for a record. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.")

<!-- document id=fd5a33e70b99f0d9b01a86a58428f4a714246d9e229ef0adfd1c14cef8874197 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_actions.md -->

# Actions

Use these resources to get data and metadata about actions displayed in the Salesforce UI. Examples include standard and custom buttons, quick actions, and productivity actions.

- **[Get Global Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_global.htm)**  
    Get the actions in the Global Actions menu.
- **[Get Record Detail Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_action_record.htm)**  
    Get the actions on record detail pages.
- **[Get Record Edit Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_action_record_edit.htm)**  
    Get the actions on a record edit page.
- **[Get Related List Actions with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list.htm)**  
    Get the actions on related lists on a record detail page via URL parameters.
- **[Get Related List Actions with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_actions_get.htm)**  
    Get the actions on related lists for a record detail page. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.
- **[Get a Batch of Related List Actions with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_lists_batch.htm)**  
    Get the actions on a batch of related lists for a record via URL parameters.
- **[Get a Batch of Related List Actions with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_actions_batch_get.htm)**  
    Get the actions on a batch of related lists for a record. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.
- **[Get Related List Record Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_record.htm)**  
    Get the actions on records in related lists.
- **[Get List View Header Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view.htm)**  
    Get the header actions on list views.
- **[Get List View Record Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view_record.htm)**  
    Get the record actions on list views.
- **[Get List View Chart Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view_chart.htm)**  
    Get the chart actions on list views.
- **[Get Lightning Page Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_flexipage.htm)**  
    Get the actions on Lightning pages (FlexiPages).
- **[Get Lookup Field Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup.htm)**  
    Get the actions on lookup fields.
- **[Get MRU List View Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_mru_list.htm)**  
    Get the header actions on the most recently used (MRU) list view for objects.
- **[Get Photo Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_photo.htm)**  
    Get the photo actions for pages. Currently, only group and user pages support photo actions.
- **[Get a Quick Action Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_quick_action_layout.htm)**  
    Get information about the record layout used by a Create a Record or Update a Record quick action.
- **[Perform Quick Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_perform_action.htm)**  
    Perform a quick action that creates or updates a record.
- **[Update a Record with a Quick Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_update_action.htm)**  
    Perform an Update a Record quick action. To perform a quick action that creates or updates a record, you can also use the POST method.

<!-- document id=8f692066d624b7a1f5ca77dcf7931bd65fefd8ff344a4f29fafe1fe288b900ab url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_advanced_lookup_display_info.md -->

# Advanced Lookup Display Info

Search lookups advanced display information.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fields | [Advanced Lookup Display Info Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_advanced_lookup_display_info_field.htm "Search lookups advanced display field information.")\[\] | Ordered list of advanced lookup display fields. | Small, 61.0 | 61.0 |

<!-- document id=10359d79aba4cc501cc7c5d963de1a36ecccc8bd5a4055939bce4f198158ff81 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_advanced_lookup_display_info_field.md -->

# Advanced Lookup Display Info Field

Search lookups advanced display field information.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fieldPath | String | Advanced lookup display field path. | Small, 61.0 | 61.0 |
| label | String | Advanced lookup display field label. | Small, 61.0 | 61.0 |
| objectApiName | String | Advanced lookup display field object API name. | Small, 61.0 | 61.0 |

<!-- document id=45b0c2a94f3671c9a7f0b3a7a0c9e5fa1a486b692b910398445a373fbb718920 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_advanced_lookup_info.md -->

# Advanced Lookup Info

Advanced search lookup information.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| displayInfo | [Advanced Lookup Display Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_advanced_lookup_display_info.htm "Search lookups advanced display information.") | Advanced lookup display information. | Small, 61.0 | 61.0 |

<!-- document id=99726c695d70800c4b931fb0da7278e43f547d3ae13276ab3b377075e0c6d968 url=/legacydeveloper/current/en-us/uiapi/ui_api_all_supported_objects.md -->

# All Supported Objects

User Interface API supports many standard objects as well as all custom and external objects.

For general information about the supported objects for UI API, see [Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm "User Interface API supports all custom objects and external objects and many standard objects."). This is a list of supported standard objects.

As of Summer ’23, all new standard objects are auto-enabled for UI API usage. This list might not reflect the latest object support. To check if a specific object is supported, use the [/ui-api/object-info/{objectApiName} resource](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm "User Interface API supports all custom objects and external objects and many standard objects.").

- AISentimentResult
- Account
- AccountBrand
- AccountContactRelation
- AccountForecast
- AccountForecastAdjustment
- AccountForecastPeriodMetric
- AccountParticipant
- AccountPartner
- AccountProductForecast
- AccountProductPeriodForecast
- AccountRelationship
- AccountTeamMember
- Accreditation
- AcctMgrPeriodicTargetDstr
- AcctMgrTarget
- AcctMgrTargetDstr
- ActionCadence
- ActionCadenceStep
- ActionCadenceTracker
- ActionCadenceStepTracker
- ActionPlan
- ActionPlanItem
- ActionPlanItemDependency
- ActionPlanTemplate
- ActionPlanTemplateItem
- ActionPlanTemplateItemValue
- ActionPlanTemplateVersion
- ActionPlnTmplItmDependency
- ActionPlanTmplItmAssessmentInd
- ActionVisibility
- ActivationTarget
- ActiveScratchOrg
- ActivityMetric
- ActivityTiming
- AddOnDefinition
- Address
- AdCreativeSizeType
- AdOrderItem
- AdOrderLineAdTarget
- AdPageLayoutType
- AdProductTargetCategory
- AdQuote
- AdServer
- AdServerAccount
- AdServerUser
- AdSpaceCreativeSizeType
- AdSpaceGroupMember
- AdSpaceSpecification
- AdTargetCategory
- AdTargetCategorySegment
- AdUsage
- AdUsageSummary
- AdvAccountForecastFact
- AdvAcctForecastSetPartner
- AiDataset
- AiImageDetectedObject
- AiImageTrainingObject
- AiVisionModel
- AiVisionModelMetric
- AiVisionModelObjectMetric
- AiVisitRecommendRequest
- AiVisitRecommendation
- AiVisitSummary
- AiVisitTaskRcmd
- AiVisitTaskRcmdRequest
- AirTravelEmssnFctr
- AirTravelEnrgyUse
- AllergyIntolerance
- AlternativePaymentMethod
- ApiAnomalyEventStore
- AppAnalyticsQueryRequest
- AppExtension
- AppMenuItem
- AppUsageAssignment
- ApplicationCase
- ApplicationFormTemplate
- AppointmentInvitation
- AppointmentInvitee
- AppointmentReason
- AppointmentTopicTimeSlot
- ApptBundleAggrDurDnscale
- ApptBundleAggrPolicy
- ApptBundleConfig
- ApptBundlePolicy
- ApptBundlePolicySvcTerr
- ApptBundlePropagatePolicy
- ApptBundleRestrictPolicy
- ApptBundleSortPolicy
- Assessment
- AssessmentIndDefinedValue
- AssessmentIndValue
- AssessmentIndicatorDefinition
- AssessmentQuestion
- AssessmentQuestionResponse
- AssessmentQuestionSet
- AssessmentQuestionVersion
- AssessmentTask
- AssessmentTaskContentDocument
- AssessmentTaskDefinition
- AssessmentTaskIndDefinition
- AssessmentTaskOrder
- Asset
- AssetAction
- AssetActionSource
- AssetAttribute
- AssetDowntimePeriod
- AssetRelationship
- AssetStatePeriod
- AssetWarranty
- AssignedResource
- AssistantText
- AssociatedLocation
- Assortment
- AssortmentProduct
- AsyncOperationLog
- AttachedContentNote
- AttributeCategory
- AttributeDefinition
- AttributePicklist
- AttributePicklistValue
- AuthApplicationAsset
- AuthApplicationPlace
- AuthFormRequestRecord
- AuthLocationAccessSchedule
- AuthorNote
- AuthorizationForm
- AuthorizationFormConsent
- AuthorizationFormDataUse
- AuthorizationFormText
- AuthorizedInsuranceLine
- AuthProvider
- AutomatedAction
- AutomatedActionCondition
- AutomatedActionParameter
- Award
- BCEntityPermission
- BCEntityPermissionSet
- BCFieldPermission
- BCParticipant
- BCParticipantAccess
- BCPermissionSet
- BCRecordAccess
- BCRecordAccessApproval
- BCRelatedParticipant
- BackgroundOperation
- Banker
- BatchJob
- BatchJobDefinition
- BatchJobPart
- BatchJobPartFailedRecord
- Benefit
- BenefitParameterValue
- BenefitSchedule
- BenefitSession
- BenefitType
- BillingBatchFilterCriteria
- BillingBatchScheduler
- BillingPeriodItem
- BillingPeriodTaxItem
- BillingPolicy
- BillingSchedule
- BillingScheduleCreationStatus
- BillingScheduleGroup
- BillingTreatment
- BillingTreatmentItem
- BldgEnrgyIntensity
- BldgEnrgyIntensityVal
- BldgSizeCategory
- BlockchainAppMember
- BlockchainApplication
- BlockchainEntity
- BlockchainField
- BlockchainMember
- BoardCertification
- BranchUnit
- BranchUnitBusinessMember
- BranchUnitCustomer
- BranchUnitRelatedRecord
- BroadcastCommunication
- Budget
- BudgetAllocation
- BundledCareFeeAgreement
- BusRegAuthTypeDependency
- BusRegAuthorizationType
- BusinessBrand
- BusinessHours
- BusinessLicense
- BusinessLicenseApplication
- BusinessMilestone
- BusinessProfile
- BusinessType
- BuyerAccount
- BuyerGroupPricebook
- CalcProcStepRelationship
- CalculationMatrix
- CalculationMatrixColumn
- CalculationMatrixRow
- CalculationMatrixVersion
- CalculationProcedure
- CalculationProcedureStep
- CalculationProcedureVariable
- CalculationProcedureVersion
- Campaign
- CampaignInfluence
- CampaignInsight
- CampaignMember
- CampaignMemberStatus
- CapitationCareFeeAgreement
- CardPaymentMethod
- CareBarrier
- CareBarrierDeterminant
- CareBarrierType
- CareBenefitVerifyRequest
- CareDeterminant
- CareDeterminantType
- CareDiagnosis
- CareFeeScheduleItem
- CareInterventionType
- CareLimitType
- CareMetricTarget
- CareObservation
- CareObservationComponent
- CarePlanDetail
- CarePerformer
- CarePgmProvHealthcareProvider
- CarePractnFacilityAppt
- CarePreauth
- CarePreauthItem
- CareProgram
- CareProgramCampaign
- CareProgramEligibilityRule
- CareProgramEnrollee
- CareProgramEnrolleeProduct
- CareProgramEnrollmentCard
- CareProgramGoal
- CareProgramProduct
- CareProgramProvider
- CareProgramTeamMember
- CareProviderAdverseAction
- CareProviderFacilitySpecialty
- CareProviderSearchableField
- CareRegisteredDevice
- CareRequest
- CareRequestDrug
- CareRequestExtension
- CareRequestItem
- CareRequestReviewer
- CareSpecialty
- CareSpecialtyTaxonomy
- CareTaxonomy
- CartDeliveryGroup
- CartItem
- CartItemPriceAdjustment
- CartTax
- Case
- CaseArticle—See [Salesforce Knowledge Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.knowledge_dev.meta/knowledge_dev/knowledge_development_uiapi_limitations.htm) for UI API limitations.
- CaseContactRole
- CaseMilestone
- CaseParticipant
- CaseRelatedFile
- CaseRelatedIssue
- CaseServicePlan
- CategorizedCareFeeAgreement
- ChangeRequest
- ChangeRequestRelatedIssue
- ChannelObjectLinkingRule
- ChannelProgram
- ChannelProgramLevel
- ChannelProgramMember
- Claim
- ClaimCase
- ClaimCovPaymentAdjustment
- ClaimCovReserveAdjustment
- ClaimCoverage
- ClaimCoveragePaymentDetail
- ClaimCoverageReserveDetail
- ClaimItem
- ClaimParticipant
- ClaimPaymentSummary
- ClaimRecovery
- ClinicalAlert
- ClinicalEncounter
- ClinicalEncounterDiagnosis
- ClinicalEncounterFacility
- ClinicalEncounterIdentifier
- ClinicalEncounterProvider
- ClinicalEncounterReason
- ClinicalEncounterSvcRequest
- ClinicalServiceRequest
- ClinicalServiceRequestDetail
- CloudServiceProvider
- CodeSet
- CodeSetBundle
- CommSubscription
- CommSubscriptionChannelType
- CommSubscriptionConsent
- CommSubscriptionTiming
- CommissionSchedule
- CommissionScheduleAssignment
- ComplaintCase
- ComplaintParticipant
- ConsentMetric
- ConsentUsageMetric
- ConsumptionRate
- ConsumptionSchedule
- Contact
- ContactEncounter
- ContactEncounterParticipant
- ContactPointAddress
- ContactPointConsent
- ContactPointEmail
- ContactPointPhone
- ContactPointTypeConsent
- ContactRequest
- ContentDocument
- ContentDocumentLink
- ContentDocumentListViewMapping
- ContentFolderItem
- ContentFolderLink
- ContentNote
- ContentVersion
- ContentWorkspace
- Contract
- ContractContactRole
- ContractDocVerContentDoc
- ContractDocVersionSection
- ContractDocumentVersion
- ContractGroupPlan
- ContractGroupPlanGroupClass
- ContractLineItem
- ContractPaymentAgreement
- ContractType
- ContractTypeConfig
- ConversationBroadcast
- ConversationBroadcastEntry
- Coupon
- CourseOffering
- CourtAction
- CourtActionOutcome
- CoverageBenefit
- CoverageBenefitItem
- CoverageBenefitItemLimit
- CoverageType
- CrbnEmssnScopeAlloc
- CrbnEmssnScopeAllocVal
- CredentialStuffingEventStore
- CreditMemo
- CreditMemoInvApplication
- CreditMemoLine
- Crisis
- CryptoTransEnvelopeChgLog
- CspTrustedSites
- Customer
- CustomerProperty
- CustomObjectParticipant
- CustomPermission
- DandBCompany
- DataAction
- DataActionTarget
- DataConnectorS3
- DataLakeObjectInstance
- DataStream
- DataUseLegalBasis
- DataUsePurpose
- DelegatedAccount
- DeleteEvent
- DeliveryTask
- DiagnosticSummary
- DiagnosticSummaryDetail
- DigitalSignature
- DigitalWallet
- DistributorAuthorization
- DocTemplateSectionCondition
- DocumentChecklistItem
- DocumentEnvelope
- DocumentGenerationSetting
- DocumentRecipient
- DocumentTemplate
- DocumentTemplateClause
- DocumentTemplateContentDoc
- DocumentTemplateSection
- DocumentTemplateToken
- DsarPolicyLog
- DuplicateRecordItem
- DuplicateRecordSet
- DynamicDataCapture
- ECart
- EditionDefinition
- ElectricityEmssnFctrSet
- ElectronicMediaGroup
- EmailMessage
- EmailTemplate
- Employee
- EmployeeAsset
- EmployeeContact
- EmployeeCrisisAssessment
- EmployeeJob
- EmployeeJobPosition
- EmployeeOrganization
- EmpUserProvisioningProcess
- EmpUserProvisionProcessErr
- EnablementMeasureDefinition
- EnablementProgram
- EndCaseArticle
- EngagementChannelType
- EnhancedLetterhead
- EnrolleeBenefit
- EnrollmentEligibilityCriteria
- Entitlement
- EntitlementContact
- EntityArchivingException
- EntityArchivingJob
- EntityArchivingSetup
- EntityMilestone
- EnvironmentHubMember
- Event
- Examination
- Expense
- ExpenseReport
- ExpenseReportEntry
- ExplainabilityMsgTemplate
- ExpressionSetView
- ExternalAccountHierarchy
- ExtDataShare
- ExtDataShareTarget
- FeedItem
- FeeScheduleDefinition
- FieldPermissions
- FieldServiceMobileExtension
- FieldServiceMobileSettings
- FieldServiceOrgSettings
- FinanceBalanceSnapshot
- FinanceBook
- FinancePeriod
- FinanceTransaction
- FinanceTransactionErrorLog
- FinancialDeal
- FinancialDealAsset
- FinancialDealBid
- FinancialDealInteraction
- FinancialDealParticipant
- FinancialDealParty
- FinancialDealProduct
- FinclDealInteractionSummary
- FlowInterview
- FlowOrchestrationInstance
- FlowOrchestrationLog
- FlowOrchestrationStageInstance
- FlowOrchestrationStepInstance
- FlowOrchestrationWorkItem
- ForecastingCustomData
- ForecastingFact
- ForecastingOwnerAdjustment
- ForecastingQuota
- ForecastingType
- FrgtHaulingEmssnFctr
- FrgtHaulingEnrgyUse
- FtestConcrete
- FtestConcrete6
- FtestConcrete7
- FtestConcrete8
- FtestZosUiPrototypeChild1
- FtestZosUiPrototypeChild2
- FtestZosUiPrototypeParent
- FulfillmentOrder
- FulfillmentOrderLineItem
- GeneratedDocument
- GeneratedDocumentSection
- GeneratedWaste
- GenericVisitTask
- GenericVisitTaskContext
- GeoCountry
- GeoState
- GnrcVstKeyPerformanceInd
- GnrcVstTaskContextRelation
- GoalDefinition
- GoalLink
- GroundTravelEmssnFctr
- GroundTravelEnrgyUse
- Group
- GroupCensus
- GroupCensusMember
- GroupClass
- GroupClassContribution
- GroupMember
- GuestBuyerProfile
- HealthCareDiagnosis
- HealthCareProcedure
- HealthCondition
- HealthConditionDetail
- HealthcareFacility
- HealthcareFacilityNetwork
- HealthcarePayerNetwork
- HealthcarePractitionerFacility
- HealthcareProvider
- HealthcareProviderNpi
- HealthcareProviderSpecialty
- HealthcareProviderTaxonomy
- Holiday
- HotelStayEmssnFctr
- HotelStayEnrgyUse
- IPAddressRange
- Identifier
- IdentityDocument
- Image
- Incident
- IncludedLicenseDefinition
- Individual
- IndividualApplication
- IndividualCrisisAssessment
- InflationRate
- InfoAuthRequestForm
- InfoAuthorizationRequest
- InsightsExternalData
- InsightsExternalDataPart
- InspectionAssessmentInd
- InspectionType
- InStoreLocation
- InsuranceClaimAsset
- InsuranceContract
- InsurancePolicy
- InsurancePolicyAsset
- InsurancePolicyCoverage
- InsurancePolicyMemberAsset
- InsurancePolicyParticipant
- InsurancePolicySurcharge
- InsurancePolicyTransaction
- InsuranceProfile
- IntegrationProviderDef
- Interaction
- InteractionAttendee
- InteractionParticipant
- InteractionSumDiscussedAccount
- InteractionSummary
- InteractionSummaryParticipant
- InterestTag
- InternalOrganizationUnit
- InventoryItemReservation
- InventoryReservation
- Invoice
- InvoiceAddressGroup
- InvoiceLine
- JobFamily
- JobPosition
- JobProfile
- JobRole
- JournalReason
- JournalSubType
- JournalType
- KnowledgeArticleVersion—See [Salesforce Knowledge Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.knowledge_dev.meta/knowledge_dev/knowledge_development_uiapi_limitations.htm) for UI API limitations.
- Lead
- LeadLineItemLeadPreferredSeller
- LearningItem
- LearningItemAssignment
- LearningItemProgress
- LegalEntity
- LicensingError
- LicensingRequest
- LicensingRequestOrderItem
- LicensingSnapshotRequest
- LinkedArticle—See [Salesforce Knowledge Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.knowledge_dev.meta/knowledge_dev/knowledge_development_uiapi_limitations.htm) for UI API limitations.
- ListEmail
- LiveAgentSession
- LiveChatSensitiveDataRule
- LiveChatTranscript
- LiveChatVisitor
- LoanApplicant
- LoanApplicantAddress
- LoanApplicantAsset
- LoanApplicantDeclaration
- LoanApplicantEmployment
- LoanApplicantIncome
- LoanApplicantLiability
- LoanApplicationAsset
- LoanApplicationFinancial
- LoanApplicationLiability
- LoanApplicationProperty
- LoanApplicationTitleHolder
- LocWaitlistMsgTemplate
- Location
- LocationGroupAssignment
- LocationTrustMeasure
- LocationWaitlist
- LocationWaitlistedParty
- LoyaltyAggrPointExprtLedger
- LoyaltyLedger
- LoyaltyMemberCurrency
- LoyaltyMemberTier
- LoyaltyPartnerProduct
- LoyaltyPgmGroupMbrRlnsp
- LoyaltyPgmMbrAttributeVal
- LoyaltyPgmPartnerCurrency
- LoyaltyPgmPartnerPromotion
- LoyaltyPgmPtnrLdgrSummary
- LoyaltyPgmPtnrPrepaidPack
- LoyaltyProgram
- LoyaltyProgramCurrency
- LoyaltyProgramMbrPromotion
- LoyaltyProgramMember
- LoyaltyProgramMemberCase
- LoyaltyProgramPartner
- LoyaltyProgramPartnerLedger
- LoyaltyProgramProcess
- LoyaltyProgramProcessRule
- LoyaltyTier
- LoyaltyTierBenefit
- LoyaltyTierGroup
- Macro
- ManufacturingProgram
- MaintenanceAsset
- MaintenancePlan
- MaintenanceWorkRule
- ManagedContent
- ManagedContentVariant
- MarketSegmentActivation
- MarketingAction
- MarketingAppExtAction
- MarketingAppExtActivity
- MarketingAppExtAssignment
- MarketingAppExtension
- MarketingForm
- MarketingLink
- MarketingLinkContent
- MarketingResource
- MediaChannel
- MediaContentTitle
- Medication
- MedicationDispense
- MedicationReconciliation
- MedicationRequest
- MedicationStatement
- MedicationStatementDetail
- MedicinalIngredient
- MedReconRecommendation
- MedReconStmtRecommendation
- MemberBenefit
- MemberPlan
- MessagingChannel
- MessagingDeliveryError
- MessagingEndUser
- MessagingSession
- Metric
- MilestoneType
- MktCalculatedInsight
- MktDataTransform
- MktMLModel
- MobileSettingsAssignment
- MsgChannelLanguageKeyword
- MultipartyInfoAuthRequest
- NamespaceRegistry
- Network
- NetworkReferencedObject
- Note
- ObjectPermissions
- ObjectStateDefinition
- ObjectStateTransition
- ObjectStateValue
- OcrDocumentScanResult
- OmniDataPack
- OmniDataTransform
- OmniDataTransformItem
- OmniESignatureTemplate
- OmniInteractionConfig
- OmniProcess
- OmniProcessAsmtQuestionVer
- OmniProcessCompilation
- OmniProcessElement
- OmniProcessTransientData
- OmniScriptSavedSession
- OmniUiCard
- OperatingHours
- OperatingHoursHoliday
- Opportunity
- OpportunityContactRole
- OpportunityHistory
- OpportunityLineItem
- OpportunityLineItemSplit
- OpptyLineItemSplitType
- OpportunityLineItemSchedule
- OpportunityParticipant
- OpportunityPartner
- OpportunityPreferredSeller
- OpportunitySplit
- OpportunityTeamMember
- Order
- OrderAction
- OrderAdjustmentGroup
- OrderChangeLog
- OrderDeliveryGroup
- OrderDeliveryMethod
- OrderItem
- OrderItemAdjustmentLineItem
- OrderItemRelationship
- OrderItemRelationshipChangeEvent
- OrderItemRelationshipFeed
- OrderItemRelationshipHistory
- OrderItemRelationshipShare
- OrderItemSummaryChange
- OrderItemTaxLineItem
- OrderItemTaxLineItemSummary
- OrderSummary
- OrderSummaryRoutingSchedule
- OrgMetric
- OrgMetricScanResult
- OrgMetricScanSummary
- Organization
- OtherComponentTask
- OtherEmssnFctrSet
- OtherEmssnFctrSetItem
- ParticipantRole
- Partner
- PartnerFundAllocation
- PartnerFundClaim
- PartnerFundRequest
- PartnerMarketingBudget
- PartyConsent
- PartyIncome
- PatientHealthReaction
- PatientImmunization
- PatientMedicalProcedure
- PatientMedicalProcedureDetail
- PatientMedicationDosage
- Payment
- PaymentApplicationMethod
- PaymentAuthorization
- PaymentAuthAdjustment
- PaymentBatchRun
- PaymentBatchRunCriteria
- PaymentGateway
- PaymentGatewayLog
- PaymentGatewayProvider
- PaymentIntent
- PaymentLineInvoice
- PaymentPolicy
- PaymentRequest
- PaymentRequestLine
- PaymentSchedule
- PaymentScheduleItem
- PaymentTreatment
- PcmtEmssnFctrSet
- PcmtEmssnFctrSetItem
- PercentileBsdCareFeeAgreement
- PermissionSet
- PermissionSetGroup
- PermissionSetLicense
- PersonAccount
- PersonEducation
- PersonEmployment
- PersonExamination
- PersonLanguage
- PersonLifeEvent
- PersonName
- PersonTraining
- PersonalDevelopmentPlan
- PersonalDevelopmentPlanItem
- PgmRebateTypBnftMapping
- PlanBenefit
- PlanBenefitItem
- PlatformLicenseDefinition
- Polygon
- PreliminaryApplicationRef
- PreventiveCareAgreement
- PriceAdjustmentGroupShape
- PriceAdjustmentItemShape
- PriceAdjustmentSchedule
- PriceAdjustmentTier
- Pricebook2
- PricebookEntry
- PriceRule
- PriceRuleAction
- PriceRuleActionItem
- PriceRuleCondition
- PriceRuleConditionFilter
- PriceRuleExecutionStage
- PrivacyJobSession
- PrivacyPolicy
- PrivacyRequest
- Problem
- ProblemIncident
- ProcessDefinition
- ProcessException
- ProcessInstance
- Producer
- ProducerCommission
- ProducerPolicyAssignment
- Product2
- Product2DataTranslation
- ProductAttribute
- ProductAttributeDefinition
- ProductAttributeSet
- ProductAttributeSetItem
- ProductAttributeSetProduct
- ProductAvailabilityProjection
- ProductCatalog
- ProductCategory
- ProductCategoryAttribute
- ProductCategoryDataTranslation
- ProductCategoryMedia
- ProductCategoryProduct
- ProductComponentGroup
- ProductConsumed
- ProductConsumedState
- ProductConsumptionSchedule
- ProductCoverage
- ProductEmissionsFactor
- ProductFulfillmentLocation
- ProductItem
- ProductItemTransaction
- ProductLicenseMap
- ProductMedia
- ProductQuantityRule
- ProductRelatedComponent
- ProductRelationshipType
- ProductRequest
- ProductRequestLineItem
- ProductRequired
- ProductSellingModel
- ProductSellingModelOption
- ProductServiceCampaign
- ProductServiceCampaignItem
- ProductSpecificationType
- ProductTaxPolicy
- ProductTransfer
- ProductTransferState
- ProductWarrantyTerm
- Profile
- ProfileSkill
- ProfileSkillEndorsement
- ProfileSkillUser
- ProgramRebateTypPayoutSrc
- ProgramRebateType
- ProgramRebateTypeBenefit
- ProgramRebateTypeFilter
- ProgramRebateTypePayout
- ProgramRebateTypeProduct
- ProgramRebateTypeReference
- Promotion
- PromotionChannel
- PromotionDataTranslation
- PromotionLoyaltyPtnrProdt
- PromotionMarketSegment
- PromotionProduct
- PromotionProductCategory
- PromotionQualifier
- PromotionSegment
- PromotionSegmentBuyerGroup
- PromotionSegmentSalesStore
- PromotionTarget
- ProrationPolicy
- ProviderNetworkTier
- ProviderSearchSyncLog
- ProvisioningRun
- ProvisioningRunEvent
- ProvisioningTargetGroup
- ProvisioningTargetItem
- ProvisioningTargetRole
- PublicApplicationParticipant
- PublicComplaint
- PublicProgram
- PublicServiceGoal
- PurchaseQuantityRule
- PurchaserPlan
- PurchaserPlanAssn
- QuickText
- Quote
- QuoteDocument
- QuoteItemTaxItem
- QuoteLineItem
- QuoteLineItemAttribute
- QuoteLinePriceAdjustment
- RebateMemberAggregateItem
- RebateMemberProductAggregate
- RebatePayment
- RebatePayoutAdjustment
- RebateProgram
- RebateProgramMember
- RebateProgramMemberPayout
- RebateProgramPayoutPeriod
- ReceivedDocument
- ReceivedDocumentType
- Recommendation
- RecordAction
- RecordAlert
- RecordType
- RecordsetFilterCriteria
- RecordsetFilterCriteriaRule
- RefrigerantEmssnFctr
- RefundLinePayment
- RegAuthorizationTypeProduct
- RegulatoryAuthority
- RegulatoryAuthorizationType
- RegulatoryCode
- RegulatoryCodeAssessmentInd
- RegulatoryCodeViolation
- RegulatoryTrxnFee
- RegulatoryTrxnFeeItem
- RentalCarEmssnFctr
- RentalCarEnrgyUse
- ReplyText
- ReportAnomalyEventStore
- ResidentialLoanApplication
- ResourceAbsence
- ResourcePreference
- RetailLocationGroup
- RetailStore
- RetailStoreGroupAssignment
- RetailStoreKpi
- RetailVisitKpi
- ReturnOrder
- ReturnOrderLineItem
- RevRecogTreatmentItemGroup
- RevenueDistributionMethod
- RevenueElement
- RevenueElementDistribution
- RevenueRecogTreatmentItem
- RevenueRecognitionPolicy
- RevenueRecognitionTreatment
- RevenueTransactionErrorLog
- SalesAgreement
- SalesAgreementProduct
- SalesAgreementProductSchedule
- SalesContractLine
- SalesforceContract
- SalesforceInvoice
- SalesforceQuote
- SalesTransactionItemShape
- SalesTransactionShape
- SalesTrxnItemRelationship
- SchedulingConstraint
- Scope3CrbnFtprnt
- Scope3EmssnSrc
- Scope3PcmtItem
- Scope3PcmtSummary
- Scorecard
- ScorecardAssociation
- ScorecardMetric
- SearchPromotionRule
- SecuritiesHolding
- Seller
- SerializedProduct
- SerializedProductTransaction
- ServiceAppointment
- ServiceAppointmentCapacityUsage
- ServiceAppointmentStatus
- ServiceContract
- ServiceCrew
- ServiceCrewMember
- ServicePlanTemplate
- ServicePlanTemplateBenefit
- ServicePlanTemplateGoal
- ServiceReport
- ServiceReportLayout
- ServiceResource
- ServiceResourceCapacity
- ServiceResourcePreference
- ServiceResourceSkill
- ServiceTerritory
- ServiceTerritoryLocation
- ServiceTerritoryMember
- ServiceTerritoryWorkType
- SessionHijackingEventStore
- SettingUsageDefinition
- SettingUsageMap
- SetupAssistantStep
- SharedSavingPaymentAgreement
- SharingRecordCollection
- SharingRecordCollectionItem
- Shift
- ShiftPattern
- ShiftPatternEntry
- ShiftTemplate
- Shipment
- SignatureTask
- SignatureTaskLineItem
- Skill
- SkillLevelDefinition
- SkillRequirement
- Snippet
- SocialPersona
- SocialPost
- StandardCareFeeAgreement
- StandardPermissionSet
- StaticResource
- StnryAssetCrbnFtprnt
- StnryAssetCrbnFtprntItm
- StnryAssetEnrgyUse
- StnryAssetEnvrSrc
- StnryAssetWaterActvty
- StnryAssetWaterFtprnt
- StoreActionPlanTemplate
- StoreAssortment
- StoreIntegratedService
- StoreProduct
- StreamingChannel
- Survey
- SurveyEmailBranding
- SurveyInvitation
- SurveyQuestion
- SurveyQuestionChoice
- SurveyQuestionResponse
- SurveyResponse
- SurveySubject
- SurveyVersion
- SvcCatalogCategory
- SvcCatalogCategoryItem
- SvcCatalogCategoryItemDef
- SvcCatalogReqRelatedItem
- Swarm
- SwarmMember
- TagCategory
- TagCategoryAssignment
- Task
- TaxEngine
- TaxEngineInteractionLog
- TaxEngineProvider
- TaxPolicy
- TaxTreatment
- TaxRate
- Tenant
- TenantParameterMap
- TenantSecurityNotificationRule
- Territory2
- ThreatDetectionFeedback
- TimeSheet
- TimeSheetEntry
- TimeSlot
- TimelineObjectDefinition
- Topic
- TopicAssignment
- TrainingCourseParticipant
- TransactionJournal
- Translation
- TravelMode
- TrialEnvironmentSignup
- TrnCourse
- UnitOfMeasure
- UnitOfMeasureConversion
- UsageEntitlement
- UsageEntitlementPeriod
- UsageEntitlementUsage
- UsageFactor
- User
- UserAccessPolicy
- UserAppMenuItem
- UserDefinedLabel
- UserDefinedLabelAssignment
- UserEsignVendorIdentifier
- UserLicenseDefinition
- UserRole
- UserTerritory2AssocLog
- UserUiPreference
- VehicleAssetCrbnFtprnt
- VehicleAssetEmssnSrc
- VehicleAssetEnrgyUse
- VehicleUserAssignment
- VideoCall
- VideoCallParticipant
- VideoRecording
- ViolationEnforcementAction
- ViolationType
- ViolationTypeAssessmentInd
- Visit
- VisitedParty
- Visitor
- VoiceCall
- VolunteerProject
- Voucher
- VoucherDefinition
- WarrantyTerm
- WasteFootprint
- WasteFootprintItem
- WaveAutoInstallRequest
- WebCart
- WebStore
- WebStoreBuyerGroup
- WebStoreCatalog
- WebStorePricebook
- WebStoreSearchProdSettings
- WorkCapacityLimit
- WorkCapacityUsage
- WorkCoaching
- WorkContract
- WorkforceCapacity
- WorkforceCapacityPlan
- WorkOrder
- WorkOrderLineItem
- WorkPlan
- WorkPlanSelectionRule
- WorkPlanTemplate
- WorkPlanTemplateEntry
- WorkRewardFund
- WorkRewardFundType
- WorkStep
- WorkStepStatus
- WorkStepTemplate
- WorkType
- WorkTypeCareSpecialty
- WorkTypeCodeSetBundle
- WorkTypeGroup
- WorkTypeGroupMember
- WorkerCompCoverageClass
- WstDispoEmssnFctrSet
- WstDispoEmssnFctrSetItm

<!-- document id=0eea94cdf438020e042a56b7e5f1cb775527a8ac7f62f52436ba8736cf06f8fd url=/legacydeveloper/current/en-us/uiapi/api_ui_eol.md -->

# API End-of-Life Policy

Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. To mature and improve the quality and performance of the API, versions that are more than three years old sometimes are no longer supported.

Salesforce notifies customers who use an API version scheduled for deprecation at least one year before support for the version ends.

| Salesforce API Versions | Version Support Status | Version Retirement Info |
| --- | --- | --- |
| Versions 31.0 through 68.0 | Supported. | [Salesforce Platform API Versions 31.0 through 40.0 Retirement](https://help.salesforce.com/s/articleView?id=005321531&type=1&language=en_US) |
| Versions 21.0 through 30.0 | As of Summer ’25, these versions are retired and unavailable. | [Salesforce Platform API Versions 21.0 through 30.0 Retirement](https://help.salesforce.com/s/articleView?id=000389618&type=1&language=en_US) |
| Versions 7.0 through 20.0 | As of Summer ’22, these versions are retired and unavailable. | [Salesforce Platform API Versions 7.0 through 20.0 Retirement](https://help.salesforce.com/s/articleView?id=000380623&type=1&language=en_US) |

If you request any resource or use an operation from a retired API version, REST API returns the 410:GONE error code.

To identify requests made from old or unsupported API versions, use the [API Total Usage](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventlogfile_apitotalusage.htm) event type.

<!-- document id=7cd2bc86c2b1cb70ee20be70574469555370a701d1ac6ed77b2ec629dc27d3d7 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_app.md -->

# App

The metadata for a single app.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d94983e42">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d94983e45">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d94983e48">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d94983e51">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d94983e54">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">appId</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The unique ID of the app.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">description</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">A description of the app.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">developerName</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The API name of the app.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">formFactors</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String[]</td>

              <td class="entry" headers="d94983e48" data-title="Description">The form factor of the app. One or more of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Large</samp>—App supports the desktop
                    display size.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Medium</samp>—App supports the tablet
                    display size.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Small</samp>—App supports the phone
                    display size.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Medium, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">headerColor</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The primary color for the app as selected by an admin. For example, <samp class="codeph nolang">#0070D2</samp>.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">iconUrl</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The URL for the app’s icon.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">isNavAutoTempTabsDisabled</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">Boolean</td>

              <td class="entry" headers="d94983e48" data-title="Description">If <samp class="codeph nolang">true</samp>, the navigation automatically
                creates temporary tabs settings.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">isNavPersonalizationDisabled</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">Boolean</td>

              <td class="entry" headers="d94983e48" data-title="Description">If <samp class="codeph nolang">true</samp>, navigation personalization is
                disabled.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">isNavTabPersistenceDisabled</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">Boolean</td>

              <td class="entry" headers="d94983e48" data-title="Description">If <samp class="codeph nolang">true</samp>, workspace tabs are cleared for
                each new console session.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 54.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">54.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">isOmniPinnedViewEnabled</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">Boolean</td>

              <td class="entry" headers="d94983e48" data-title="Description">If <samp class="codeph nolang">true</samp>, the Omni-Channel sidebar is
                enabled.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 60.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The label of the app.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">logoUrl</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The logo URL of the app as selected by the admin.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Medium, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">mobileStartUrl</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The mobile launch URL for the app. This field is used with client apps and
                Experience Builder sites. For sites only, this location is a fully qualified domain
                name. For other apps, it’s a relative URL.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Medium, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">navItems</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_item.htm#ui_api_responses_nav_item" title="The metadata for a single navigation item (tab).">Navigation Item</a>[]
              </td>

              <td class="entry" headers="d94983e48" data-title="Description">The metadata for the navigation tabs of the app. <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.uiapi.meta/uiapi/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>Only <samp class="codeph nolang">navItems</samp> with supported <samp class="codeph nolang">formFactors</samp> values are returned.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Big, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">selected</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">Boolean</td>

              <td class="entry" headers="d94983e48" data-title="Description">If <samp class="codeph nolang">true</samp>, this app is the default app for
                the user.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Big, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">startUrl</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The launch URL of the app. </td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Medium, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">type</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The type of the app. One of these values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Classic</samp></li>

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

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 47.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">47.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">uiType</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">String</td>

              <td class="entry" headers="d94983e48" data-title="Description">The UI type for the app. One of these values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Salesforce Classic</samp></li>

                  <li class="li"><samp class="codeph nolang">Lightning Experience</samp></li>

                </ul>
                <p class="p">This property was deprecated in API version 47.0. In API version 47.0 and
                  later, use <samp class="codeph nolang">type</samp> instead.</p>
              </td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Small, 43.0–46.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0–46.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d94983e42" data-title="Property Name"><samp class="codeph nolang">userNavItems</samp></td>

              <td class="entry" headers="d94983e45" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_item.htm#ui_api_responses_nav_item" title="The metadata for a single navigation item (tab).">Navigation Item</a>[]
              </td>

              <td class="entry" headers="d94983e48" data-title="Description">The user's navigation tabs for the app.</td>

              <td class="entry" headers="d94983e51" data-title="Filter Group and Version">Big, 43.0</td>

              <td class="entry" headers="d94983e54" data-title="Available Version">43.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_apps.htm "A list of apps that the current user has access to.")
- [Get an App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_id.htm "Get the metadata for an app.")
- [Get Last Selected App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_selected.htm "Retrieves the app the current user last selected or the app the user sees by default.")
- [Manage Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_apps.htm "An app is a collection of items that work together to serve a particular function. Salesforce apps come in two flavors: Classic apps and Lightning apps. Classic apps are created and managed in Salesforce Classic. Lightning apps are created and managed in Lightning Experience. Admins customize both types of apps to match the way users work.")

<!-- document id=f32abfecb78774b79d7eb03bbebaf8af41bb2bd2fa9c06ca1d10c79dd699d934 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_apps_overview.md -->

# Apps

Use these resources to get data and metadata for apps displayed in the Salesforce UI.

- **[Get Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps.htm)**  
    Get metadata for all the apps a user has access to. Metadata for the selected app includes tabs on the app’s navigation bar. Metadata for other apps doesn’t include tabs on the navigation bar.
- **[Get an App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_id.htm)**  
    Get the metadata for an app.
- **[Update Last Selected App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_id_update.htm)**  
    Returns metadata for an app, and saves an app as the last selected for a user.
- **[Get Last Selected App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_selected.htm)**  
    Retrieves the app the current user last selected or the app the user sees by default.
- **[Get Personalized Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_user_nav_items.htm)**  
    Get a user’s personalized navigation items (tabs).
- **[Get All Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_all_nav_items.htm)**  
    Gets all navigation items (tabs) that the user has access to.
- **[Update Personalized Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_update_nav_items.htm)**  
    Updates the order of a user’s personalized navigation items (tabs) and adds a navigation item to the list in the order specified.

<!-- document id=8a7ae6a1c6f5d3dbb58c9aedee939d136677fbd22402699f74f8d9bc23e5a14a url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_apps.md -->

# Apps

A list of apps that the current user has access to.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apps | [App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_app.htm#ui_api_responses_app "The metadata for a single app.")\[\] | Metadata for an app. | Small, 43.0 | 43.0 |

#### See Also

- [Get Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps.htm "Get metadata for all the apps a user has access to. Metadata for the selected app includes tabs on the app’s navigation bar. Metadata for other apps doesn’t include tabs on the navigation bar.")
- [App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_app.htm "The metadata for a single app.")
- [Manage Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_apps.htm "An app is a collection of items that work together to serve a particular function. Salesforce apps come in two flavors: Classic apps and Lightning apps. Classic apps are created and managed in Salesforce Classic. Lightning apps are created and managed in Lightning Experience. Admins customize both types of apps to match the way users work.")

<!-- document id=b84be6d3977532dd63312d59f74aeadc0c44e2e92c30734a103ced26b23b8e4e url=/legacydeveloper/current/en-us/uiapi/ui_api_get_started_intro.md -->

# Authentication, Versioning, Limits, ETag, and More

Learn the high-level facts about how to use User Interface API. How do you authenticate? How is the API versioned? What are the rate limits? All the information you need, available at a glance.

Authentication

Like other Salesforce REST APIs, User Interface API uses OAuth 2.0. To specify OAuth settings, create an [external client app](https://help.salesforce.com/s/articleView?id=xcloud.create_a_local_external_client_app.htm&type=5&language=en_US "HTML (New Window)") in Salesforce.

Case Sensitivity

When writing a User Interface API client, assume case sensitivity. Some parts of the API aren’t case-sensitive, but some are, so it’s best to assume case sensitivity.

Dates

Dates are represented in [ISO 8601](https://www.w3.org/TR/NOTE-datetime "HTML (New Window)") format.

Experience Cloud Site User Access

Users with a Customer Community or Partner Community [User License](https://help.salesforce.com/articleView?id=users_license_types_communities.htm&type=0&language=en_US "HTML (New Window)") can access User Interface API.

Lightning components on Experience Cloud site pages request UI API resources in the context of a site user. Even if an Experience Cloud site user doesn't have the API Enabled permission, these requests can count towards Salesforce API limits. For example, if you add the <lightning-record-view-form\> component to an Experience Cloud site page, requests from that component to UI API resources are made in the context of a site user. These requests can count towards API limits, even if the user doesn't have the API Enabled permission.

HTTP Caching with ETag

[Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm "The field data, API name, child relationship data, and record type information for a record.") responses include a weakEtag property that you can use to compare whether a record is a newer, older, or the same as a record in a previous response.

In addition, to take advantage of browser caching, User Interface API responses include an [ETag](https://tools.ietf.org/html/rfc7232#section-2.3 "HTML (New Window)") field. To reduce network traffic and increase your app’s response time, make conditional HTTP requests. If the browser cache holds the latest version of a representation, the web server returns only HTTP headers.

The ETag (or Entity Tag) contains a hash that identifies a representation: ETag: "b9a5cd4fbfcf1b65b03d95a4d9ffa8f4--gzip". When a representation changes, the web server generates a new ETag.

GET /ui-api/object-info/account

HTTP/1.1 200 OK
Date: Tue, 07 Nov 2017 04:27:43 GMT
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Content-Security-Policy: upgrade-insecure-requests 
X-Robots-Tag: none
Cache-Control: no-cache,must-revalidate,max-age=0,no-store,private
Set-Cookie: BrowserId=GHrCS0saRl64DgVv-NrLjA;Path=/;Domain=.salesforce.com;Expires=Sat, 06-Jan-2018 04:27:45 GMT;Max-Age=5184000
Expires: Thu, 01 Jan 1970 00:00:00 GMT
**ETag: "b9a5cd4fbfcf1b65b03d95a4d9ffa8f4--gzip"**
Content-Type: application/json;charset=UTF-8
Vary: Accept-Encoding
Content-Encoding: gzip
Transfer-Encoding: chunked


{
  "apiName" : "Account",
  "childRelationships" : \[ {
    "childObjectApiName" : "Account",
    "fieldName" : "ParentId",
    "junctionIdListNames" : \[ \],
    "junctionReferenceTo" : \[ \],
    "relationshipName" : "ChildAccounts"
    ... response shortened ...
    \]}
    ...
}

The client saves the ETag and sends it in a header in subsequent requests for the resource: If-None-Match: “b9a5cd4fbfcf1b65b03d95a4d9ffa8f4”. The web server compares this ETag value with the ETag value of the current version of the representation. If the values are the same, the browser cache holds the latest version and the web server returns an HTTP status of 304 Not Modified.

If-Modified-Since

PATCH requests support the [If-Modified-Since](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since "HTML (New Window)") HTTP header.

Integers

We support integers less than 1018. Integers greater than or equal to 231 must be in quotes.

JSON Support

The JavaScript Object Notation (JSON) format is supported with UTF-8.

Limits

The User Interface API uses the [Salesforce API limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm "HTML (New Window)") and the [Connect REST API limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_rate_limits.htm "HTML (New Window)"). When you exceed the rate limit, all User Interface API resources return a 503 Service Unavailable error code.

Versioning

User Interface API is versioned. Specify the API version number in each request.

GET https://MyDomainName.my.salesforce.com/services/data/v68.0/ui-api

#### See Also

- [_Salesforce Help_: Set Up OAuth Flows](https://help.salesforce.com/s/articleView?id=xcloud.external_client_apps_oauth_flow_config.htm&type=5&language=en_US "Salesforce Help: Set Up OAuth Flows - HTML (New Window)")

<!-- document id=28218d70237e04a04effcca16d3a7b16c52047a02763fe3cac7941dfc353fd67 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_batch_operation_input.md -->

# Batch Operation Input

Represents the operation type and record data to create, update, and delete in a batch.

JSON example

"operations": \[
    {
      "type": "CREATE",
      "records": \[
        {
          "apiName": "Account",
          "fields": {
            "Name": "Global Media"
          }
        },
        {
          "apiName": "Contact",
          "fields": {
            "LastName": "Smith"
          }
        }
      \]
    },
    {
      "type": "UPDATE",
      "records": \[
        {
          "fields": {
            "Id": "001xx000003Gaf9AAC",
            "NumberOfEmployees": 1000
          }
        }
      \]
    },
    {
      "type": "DELETE",
      "records": \[
        {
          "fields": {
            "Id": "001xx000003GanDAAS"
          }
        }
      \]
    }
  \]

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d21104e71">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d21104e74">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d21104e77">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d21104e80">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d21104e83">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d21104e71" data-title="Name"><samp class="codeph nolang">type</samp></td>

                  <td class="entry" headers="d21104e74" data-title="Type">String</td>

                  <td class="entry" headers="d21104e77" data-title="Description">The type of record operation. Valid values include:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CREATE</samp>—<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_post.htm" title="Create multiple records. You can create, update, and delete up to 200 records in a single request.">Create a record or multiple records</a>.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">UPDATE</samp>—<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_update.htm" title="Update multiple records. You can create, update, and delete up to 200 records in a single request.">Update a record or multiple records</a>.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">DELETE</samp>—<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_delete.htm" title="Delete multiple records. You can create, update, and delete up to 200 records in a single request.">Delete a record or multiple records</a>.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d21104e80" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d21104e83" data-title="Available Version">59.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d21104e71" data-title="Name"><samp class="codeph nolang">records</samp></td>

                  <td class="entry" headers="d21104e74" data-title="Type">
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_record_input.htm" title="A description of a record to use in a request to create or update a record or in a request to check for duplicate records.">Record
                      Input</a> []
                  </td>

                  <td class="entry" headers="d21104e77" data-title="Description">A description of a record or multiple records to create, update, and
                    delete.</td>

                  <td class="entry" headers="d21104e80" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d21104e83" data-title="Available Version">59.0</td>

                </tr>

              </tbody>

            </table>

<!-- document id=5bb2bcc3f13d9480c79b383e1fd937dbb86c1745d79ff14ed43b4ea5e9baa4f1 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_batch_input.md -->

# Batch Record Input

A description of multiple operations for a request to create, update, or delete a batch of records.

Example

POST /ui-api/records/batch

{
  "allOrNone": false,
  "operations": \[
    {
      "type": "CREATE",
      "records": \[
        {
          "apiName": "Account",
          "fields": {
            "Name": "ACCOUNT 1"
          }
        },
        {
          "apiName": "Contact",
          "fields": {
            "LastName": "Smith"
          }
        }
      \]
    },
    {
      "type": "Update",
      "records": \[
        {
          "fields": {
            "Id": "001xx000003Gaf9AAC",
            "NumberOfEmployees": 1000
          }
        }
      \]
    },
    {
      "type": "Delete",
      "records": \[
        {
          "fields": {
            "Id": "001xx000003GanDAAS"
          }
        }
      \]
    }
  \]
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| allOrNone | Boolean | Specifies whether to stop processing the request and rollback any changes when the request encounters an error. The default is true. | Optional | 59.0 |
| operations | [Batch Operation Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_operation_input.htm "Represents the operation type and record data to create, update, and delete in a batch.") \[\] | A description of records and operation types. | Required | 59.0 |

<!-- document id=5a5ea0ba6b3fa1662956085c36acc80cdbdf37535c4d98a94defa238abf60592 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_batch_result.md -->

# Batch Result Item

The results of one subrequest in a batch request.

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





        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader vertical-align-top " id="d97833e48">Property</th>

            <th class="featureTableHeader vertical-align-top " id="d97833e51">Type</th>

            <th class="featureTableHeader vertical-align-top " id="d97833e54">Description</th>

            <th class="featureTableHeader vertical-align-top " id="d97833e57">Filter Group and Version</th>

            <th class="featureTableHeader vertical-align-top " id="d97833e60">Available Version</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d97833e48" data-title="Property"><samp class="codeph nolang">result</samp></td>

            <td class="entry" headers="d97833e51" data-title="Type">One of these types: <ul class="ul bulletList">
                <li class="li">
                  <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_error_message.htm#ui_api_responses_error_message" title="An error code and error message.">Error Message</a>
                  <p class="p">If the result is an error, the type is a collection of
                    error messages.</p>
                </li>

                <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record" title="The field data, API name, child relationship data, and record type information for a record.">Record</a></li>

                <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm" title="Metadata that describes a related list.">Related List Info</a></li>

                <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_record_count.htm" title="The number of records in a given related list.">Related List Record Count</a></li>

              </ul>
            </td>

            <td class="entry" headers="d97833e54" data-title="Description">A response body for a record or related list.</td>

            <td class="entry" headers="d97833e57" data-title="Filter Group and Version">Small, 41.0</td>

            <td class="entry" headers="d97833e60" data-title="Available Version">41.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d97833e48" data-title="Property"><samp class="codeph nolang">statusCode</samp></td>

            <td class="entry" headers="d97833e51" data-title="Type">Integer</td>

            <td class="entry" headers="d97833e54" data-title="Description">An HTTP status code indicating the status of this individual request in the
              batch.</td>

            <td class="entry" headers="d97833e57" data-title="Filter Group and Version">Small, 41.0</td>

            <td class="entry" headers="d97833e60" data-title="Available Version">41.0</td>

          </tr>

        </tbody>

      </table>

#### See Also

- [Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results.htm "The results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=f775501613d37a74faef3dc85b79e3057c370a45bf8c961af26dd93d3f1dcb6f url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_batch_results.md -->

# Batch Results

The results from a request to a batch resource. Results include information for each subrequest in the batch.

| Property | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| hasErrors | Boolean | true if at least one of the results in the result set is an HTTP status code in the 400 or 500 range; false otherwise | Small, 41.0 | 41.0 |
| results | [Batch Result Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_result.htm#ui_api_responses_batch_result "The results of one subrequest in a batch request.")\[\] | Collection of batch result items | Small, 41.0 | 41.0 |

#### See Also

- [Get a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch.htm "Get data for a batch of records.")

<!-- document id=1eb41fe8a42d4230b0715fd6feffa1cdfed1cccbc6fa7151f53f681812dfcb45 url=/legacydeveloper/current/en-us/uiapi/ui_api_features_records_dependent_picklist.md -->

# Build UI for Picklists

User Interface API exposes properties and resources that make it easy for a client to build picklists and dependent picklists.

Picklists are complicated UI elements, and dependent picklists are especially tricky. The values in a dependent picklist field are filtered based on the selection in another field, called a controlling field. A controlling field can be a picklist field or a checkbox field. For example, imagine a Continents picklist that controls a Countries picklist that controls a Cities picklist and a Languages picklist field.

Dependent picklists exist in a field dependency tree that shows a hierarchy of controlling and dependent fields. Each node in the tree can have any number of child nodes. To build UI, you need to know the complete hierarchy.![Field dependency tree diagram](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/api_ui/images/field_dependency_tree.png)

An object can have any number of field dependency trees. User Interface API exposes the collection of field dependency trees in a single property on each object called dependentFields. Each dependent field has a controllingFields property that lists the fields that control it. User Interface API also provides a batch resource to get all picklist values for a record type: [/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm#ui_api_resources_picklist_values_collection "Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request.").

## Check for Picklists

To build UI to create, display, edit, and delete records, make a request to one of the User Interface API resources. The response from each of these resources includes an [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.") response body, which contains the object metadata, including information about picklists.

- [Get Record Data and Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui "Get layout information, metadata, and data to build UI for a single record or for a collection of records.")
- [Get Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info.htm#ui_api_resources_object_info "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.")
- [Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm#ui_api_resources_record_defaults_create "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm#ui_api_resources_record_defaults_clone "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.")

1. Parse the response for each field’s dataType. If the dataType is Picklist or MultiPicklist, the field is a picklist.
2. If you find a picklist, grab the recordTypeId, you’ll use it in a request to get the picklist values.
3. Parse the response for dependent picklists. If the field is a picklist and if the controllingFields property is non-null, the field is a dependent picklist.
4. If the field is a dependent picklist, look at the dependentFields property on the object to see the tree structure of the object’s dependent and controlling fields. A dependent picklist can depend on (be controlled by) standard or and custom picklists and checkboxes.

{
  ...
  "dependentFields" : {
    "Continents\_\_c" : {
      "Countries\_\_c" : {
        "Cities\_\_c" : { },
        "Languages\_\_c" : { },
      }
    }
  },
  ...
 "fields" : {
     "AccountSource" : {
      ...
      "controllingFields" : \[ \],
      ...
      "dataType" : "Picklist",
      ...
     },
    "Cities\_\_c" : {
      ...
      "controllingFields" : \[ "Countries\_\_c", "Continents\_\_c" \],
      ...
      "dataType" : "Picklist",
      ...
    },
    "Continents\_\_c" : {
      ...
      "controllingFields" : \[ \],
      ...
      "dataType" : "Picklist",
      ...
    },
    "Countries\_\_c" : {
      ...
      "controllingFields" : \[ "Continents\_\_c" \],
      ...
      "dataType" : "Picklist",
      ...
    },
    "Languages\_\_c" : {
      ...
      "controllingFields" : \[ "Countries\_\_c", "Continents\_\_c" \],
      ...
      "dataType" : "Picklist",
      ...
    },  
...   
  "recordTypeInfos" : {
    "012000000000000AAA" : {
      ...
      "recordTypeId" : "012000000000000AAA"
    }
  },
  ...
}

Here’s a bit more info about the dependent and controlling fields properties.

- {Object}.dependentFields—A map of the dependent fields tree structure. Each nested object is another Map<String, Object>. When the object is empty, it indicates a leaf of the tree, which is a field that doesn’t control other fields. An object can have multiple independent trees, which means this property can have multiple root objects.
    
    Imagine an object with the picklists Continents\_\_c, Countries\_\_c, and Cities\_\_c. Continents\_\_c is the root. Cities\_\_c is a leaf. Continents\_\_c and Countries\_\_c are controlling fields. Countries\_\_c and Cities\_\_c are dependent picklists.
- {Field}.controllingFields—If this field is a dependent picklist, this property is a collection of fields that control the values in the picklist. When there’s a hierarchy of controlling fields, the collection starts with the immediate parent and moves up the tree.

## Get Picklist Values

You know that the object has picklists, you know whether it has dependent picklists, and you know how the dependent picklists are controlled. It’s time to get the picklist values.

1. Do one of the following:
    - To retrieve the values for all picklists of a record type, make a request to [GET /ui-api/object-info/${objectApiName}/picklist-values/${recordTypeId}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm#ui_api_resources_picklist_values_collection "Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request."). It’s handy to retrieve the values in a batch instead of requesting them for each field.
    - To get the values for a single picklist, make a request to [GET /ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values.htm#ui_api_resources_picklist_values "If a field’s dataType property is equal to Picklist or MultiPicklist, use this resource to get its values.").
2. Get the values for independent picklists.
    1. To determine whether a picklist is independent, look at the {Field}.controllingFields property. If the property is empty, the picklist is independent.
        
        ![Tip](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note_tip.png)
        
        #### Tip
        
        If the controllerValues property is empty, like it is for the AccountSource field in the following example, the field isn’t necessarily independent. If the controlling field is protected by field-level security (FLS), it doesn’t appear in the controllerValues property.
    2. To populate a picklist in the UI, use the field’s label and value properties.
3. Get the values for dependent picklists.
    1. If a picklist is dependent, its controllerValues property lists the values and indexes of its controlling field (except when the immediate controlling field is protected by FLS). The indexes are used in the validFor property to indicate which controlling field values map to which picklist value. For example, in controllerValues, Italy has index 5. In the values.validFor property, you see that Rome is valid for index 5.
    2. To populate a picklist in the UI, use the field’s label and value properties.

{
  "picklistFieldValues" : {
    "AccountSource" : {
      "controllerValues" : { },
      "defaultValue" : null,
      "url" : "/services/data/v68.0/ui-api/object-info/account/picklist-values/012000000000000AAA/AccountSource",
      "values" : \[ {
        "attributes" : null,
        "label" : "Advertisement",
        "validFor" : \[ \],
        "value" : "Advertisement"
      }, {
        "attributes" : null,
        "label" : "Employee Referral",
        "validFor" : \[ \],
        "value" : "Employee Referral"
      },
     ...
    }
    "Cities\_\_c" : {
      "controllerValues" : {
        "Australia" : 0,
        "Brazil" : 1,
        "China" : 2,
        "Colombia" : 3,
        "France" : 4,
        "Italy" : 5,
        "Mexico" : 6,
        "New Zealand" : 7,
        "Nigeria" : 8,
        "Senegal" : 9,
        "South Korea" : 10,
        "US" : 11
      },
      "defaultValue" : null,
      "url" : "/services/data/v68.0/ui-api/object-info/account/picklist-values/012000000000000AAA/Cities\_\_c",
      "values" : \[ {
        "attributes" : null,
        "label" : "Cali",
        "validFor" : \[ 3 \],
        "value" : "Cali"
      }, {
        "attributes" : null,
        "label" : "Chicago",
        "validFor" : \[ 11 \],
        "value" : "Chicago"
      }, {
        "attributes" : null,
        "label" : "Dakar",
        "validFor" : \[ 9 \],
        "value" : "Dakar"
      }, {
        "attributes" : null,
        "label" : "Lagos",
        "validFor" : \[ 8 \],
        "value" : "Lagos"
      }, {
        "attributes" : null,
        "label" : "Los Angeles",
        "validFor" : \[ 11 \],
        "value" : "Los Angeles"
      }, {
        "attributes" : null,
        "label" : "Oaxaca",
        "validFor" : \[ 6 \],
        "value" : "Oaxaca"
      }, {
        "attributes" : null,
        "label" : "Wellington",
        "validFor" : \[ 7 \],
        "value" : "Wellington"
      } \]
    },
    

## Record Viewer Sample App

To view sample code that parses a response and displays dependent picklists, check out the [Record Viewer](https://github.com/forcedotcom/RecordViewer "HTML (New Window)") sample app on GitHub. To contribute to the app, fork it and submit a pull request. We love to see what people do with User Interface API.

#### See Also

- [User Interface API Sample Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_sample_apps.htm "We’ve built two sample apps that use User Interface API to create, read, update, and delete records. The apps are open-source and available on GitHub.")
- [Get Values for a Picklist Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values.htm "If a field’s dataType property is equal to Picklist or MultiPicklist, use this resource to get its values.")
- [Get Values for All Picklist Fields of a Record Type](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm "Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request.")

<!-- document id=9e04ea95e9db4452ce283b7272231f4028f8df9ab243e7cfb23a9468a2fb09d7 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_canvas_layout_component.md -->

# Canvas Layout Component

A canvas component on a record page layout.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d98978e30">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d98978e32">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d98978e34">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d98978e36">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d98978e38">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d98978e30" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d98978e32" data-title="Type">String</td>

              <td class="entry" headers="d98978e34" data-title="Description">The API name of the canvas app.</td>

              <td class="entry" headers="d98978e36" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d98978e38" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d98978e30" data-title="Property Name"><samp class="codeph nolang">componentType</samp></td>

              <td class="entry" headers="d98978e32" data-title="Type">String</td>

              <td class="entry" headers="d98978e34" data-title="Description">The value is <samp class="codeph nolang">Canvas</samp>.</td>

              <td class="entry" headers="d98978e36" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d98978e38" data-title="Available Version">41.0</td>

            </tr>
            <tr>
              <td class="entry" headers="d98978e30" data-title="Property Name"><samp class="codeph nolang">displayLocation</samp></td>
              <td class="entry" headers="d98978e32" data-title="Type">String</td>
              <td class="entry" headers="d98978e34" data-title="Description">The location in the application where the canvas app is being called from. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Chatter</samp>—The canvas app was called from
                    the Chatter tab.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ChatterFeed</samp>—The canvas app was called
                    from a Chatter canvas feed item.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MobileNav</samp>—The canvas app was called from
                    the navigation menu in the Salesforce mobile app.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OpenCTI</samp>—The canvas app was called from an
                    Open CTI component.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PageLayout</samp>—The canvas app was called from
                    an element within a page layout. If the <samp class="codeph nolang">displayLocation</samp> is <samp class="codeph nolang">PageLayout</samp>,
                    one of the <samp class="codeph nolang">subLocation</samp> values can be
                    returned.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Publisher</samp>—The canvas app was called from
                    a canvas custom quick action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ServiceDesk</samp>—The canvas app was called
                    from a Salesforce Console component.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Visualforce</samp>—The canvas app was called
                    from a Visualforce page.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">None</samp>—The canvas app was called from the
                    Canvas App Previewer.
                  </li>

                </ul>
                <p class="p">The <samp class="codeph nolang">sublocation</samp> in the application
                  where the canvas app was called from when the canvas app is loaded in a mobile
                  device. The possible values are: </p>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">S1MobileCardFullview</samp>—The canvas
                    app was called from a mobile card.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">S1MobileCardPreview</samp>—The canvas app
                    was called from a mobile card preview.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">S1RecordHomePreview</samp>—The canvas app
                    was called from a record detail page preview.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">S1RecordHomeFullview</samp>—The canvas
                    app was called from a page layout.
                  </li>

                </ul>
              </td>
              <td class="entry" headers="d98978e36" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d98978e38" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d98978e30" data-title="Property Name"><samp class="codeph nolang">height</samp></td>
              <td class="entry" headers="d98978e32" data-title="Type">String</td>
              <td class="entry" headers="d98978e34" data-title="Description">The height of the component.</td>
              <td class="entry" headers="d98978e36" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d98978e38" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d98978e30" data-title="Property Name"><samp class="codeph nolang">referenceId</samp></td>
              <td class="entry" headers="d98978e32" data-title="Type">String</td>
              <td class="entry" headers="d98978e34" data-title="Description">The unique ID of the canvas app definition.</td>
              <td class="entry" headers="d98978e36" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d98978e38" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d98978e30" data-title="Property Name"><samp class="codeph nolang">showScroll</samp></td>
              <td class="entry" headers="d98978e32" data-title="Type">Boolean</td>

              <td class="entry" headers="d98978e34" data-title="Description">Indicates whether to show the scroll bar on the canvas component (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>
              <td class="entry" headers="d98978e36" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d98978e38" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d98978e30" data-title="Property Name"><samp class="codeph nolang">width</samp></td>
              <td class="entry" headers="d98978e32" data-title="Type">String</td>
              <td class="entry" headers="d98978e34" data-title="Description">The width of the component.</td>
              <td class="entry" headers="d98978e36" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d98978e38" data-title="Available Version">41.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.")

<!-- document id=8b682ca129cc5adeb1703542a96730b03982322dfa2be48ab0ef9158a894594b url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_case_status_picklist_values.md -->

# Case Status Picklist Value Attributes

Additional picklist value attributes for case statuses.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d100080e51">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d100080e54">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d100080e57">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d100080e60">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d100080e63">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d100080e51" data-title="Property Name"><samp class="codeph nolang">closed</samp></td>

              <td class="entry" headers="d100080e54" data-title="Type">Boolean</td>

              <td class="entry" headers="d100080e57" data-title="Description">If this status indicates the case has been closed, the value is <samp class="codeph nolang">true</samp>, otherwise <samp class="codeph nolang">false</samp>.</td>

              <td class="entry" headers="d100080e60" data-title="Filter Group and Version">Small, 48.0</td>

              <td class="entry" headers="d100080e63" data-title="Available Version">48.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d100080e51" data-title="Property Name"><samp class="codeph nolang">picklistAtrributes​ValueType</samp></td>

              <td class="entry" headers="d100080e54" data-title="Type">String</td>

              <td class="entry" headers="d100080e57" data-title="Description">The value is <samp class="codeph nolang">CaseStatus</samp>. Indicates that
                these value attributes are associated with the status of a case.<p class="p">For more
                  information, see the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_casestatus.htm" target="_blank">CaseStatus object documentation</a>.</p>
                <p class="p">The
                  property <samp class="codeph nolang">picklistAtrributes​ValueType</samp>
                  contains a typographical error.</p>
              </td>

              <td class="entry" headers="d100080e60" data-title="Filter Group and Version">Small, 48.0</td>

              <td class="entry" headers="d100080e63" data-title="Available Version">48.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Picklist Value](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_value.htm "A single picklist value.")

<!-- document id=3569ffb880e25bf587eeff88075ac5e779d13a5615929e0ddfafee956bdb5d3f url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_predupe_create.md -->

# Check for Duplicate Records

Before updating or creating a record, you can check whether a duplicate record exists. Use the response to learn whether to block or allow the action, and whether to warn the user.

![Tip](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note_tip.png)

#### Tip

To learn more about when to check for duplicate records, see [Get Duplicate Management Configuration for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_duplicates_get.htm "Learn whether duplicate management is configured for the specified object. If duplicate management is configured, learn about the object's duplicate rules and matching rules. Use the information in the response to know when to check for duplicate records.").

Resource

/ui-api/predupe

Available Version

50.0

HTTP Method

POST

Example

Use the following request to check whether a duplicate record for the movie "Aliens" exists.

ui-api/predupe{
"apiName" : "Movie\_\_c",
"fields" :
{"Name": "Aliens",
  "Year\_\_c": "1986"
}

Request Body

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d66995e115">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d66995e118">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d66995e121">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d66995e124">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d66995e127">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d66995e115" data-title="Name"><samp class="codeph nolang">allowSaveOnDuplicate</samp></td>

                  <td class="entry" headers="d66995e118" data-title="Type">Boolean</td>

                  <td class="entry" headers="d66995e121" data-title="Description">Specifies whether to save a duplicate record (<samp class="codeph nolang">true</samp>), or not (<samp class="codeph nolang">false</samp>). The
                    default value is <samp class="codeph nolang">false</samp>.<p class="p">Don’t specify
                      this property when checking for duplicate records.</p>
                  </td>

                  <td class="entry" headers="d66995e124" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d66995e127" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d66995e115" data-title="Name"><samp class="codeph nolang">apiName</samp></td>

                  <td class="entry" headers="d66995e118" data-title="Type">String</td>

                  <td class="entry" headers="d66995e121" data-title="Description">To create a record, specify the API name of an Object from which to
                    create the record. To update a record, use <samp class="codeph nolang">null</samp> or don’t pass this property. To check for duplicate records,
                    specify the API name of the object for which you’re performing the duplicate
                    check.</td>

                  <td class="entry" headers="d66995e124" data-title="Required or Optional">Required to create a record.<p class="p">Required to check for duplicate
                      records.</p>
                  </td>

                  <td class="entry" headers="d66995e127" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d66995e115" data-title="Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d66995e118" data-title="Type">Map&lt;String, Object&gt;</td>

                  <td class="entry" headers="d66995e121" data-title="Description">Map of field names to field values.<p class="p">Format data types according to
                      these rules: </p>
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Address</samp>—JSON String.
                        Addresses are compound fields and must be broken up into their constituent
                        fields. See the previous example.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Boolean</samp>—JSON Boolean,
                        <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Currency</samp>—JSON Number (for
                        example, <samp class="codeph nolang">67.54</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Date</samp>—JSON string (for
                        example, <samp class="codeph nolang">2020-04-20</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">DateTime</samp>—JSON string in ISO
                        8601 format (for example, <samp class="codeph nolang">2012-02-18T06:40:41.000Z</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Double</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Email</samp>—JSON String (for
                        example, <samp class="codeph nolang">joe@smith.com</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">EncryptedString</samp>—JSON
                        String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Int</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Location</samp>—JSON String.
                        Location fields are compound fields and must be broken up into their
                        constituent fields.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">MultiPicklist</samp>—JSON String
                        (for example, <samp class="codeph nolang">Dog;Cat;Fish)</samp>.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Percent</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Phone</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Picklist</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Reference</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">String</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">TextArea</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Time</samp>—JSON String in format
                        <samp class="codeph nolang">HH:MM:SS</samp>
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Url</samp>—JSON String
                      </li>

                    </ul>
                    <p class="p">To specify the main record type, either don’t specify the <samp class="codeph nolang">RecordTypeId</samp> field, or set it to <samp class="codeph nolang">null</samp>.</p>
                  </td>

                  <td class="entry" headers="d66995e124" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d66995e127" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Duplicates](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicates.htm "The results of a check for duplicate records.")

#### See Also

- [Get Duplicate Management Configuration for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_duplicates_get.htm "Learn whether duplicate management is configured for the specified object. If duplicate management is configured, learn about the object's duplicate rules and matching rules. Use the information in the response to know when to check for duplicate records.")

<!-- document id=b0c5574b75c3f28fc71ac352a784652c1e075191036c6eeac7c2800c48b98adf url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_child_relationship.md -->

# Child Relationship

The child relationship on a parent object. Relationships are connections between records. Use relationships to display data about related object records on a record's detail page.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d100467e51">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d100467e54">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d100467e57">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d100467e60">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d100467e63">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d100467e51" data-title="Property Name"><samp class="codeph nolang">childObjectApiName</samp></td>

              <td class="entry" headers="d100467e54" data-title="Type">String</td>

              <td class="entry" headers="d100467e57" data-title="Description">The API name of the child object.</td>

              <td class="entry" headers="d100467e60" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d100467e63" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d100467e51" data-title="Property Name"><samp class="codeph nolang">fieldName</samp></td>

              <td class="entry" headers="d100467e54" data-title="Type">String</td>

              <td class="entry" headers="d100467e57" data-title="Description">The field on the child object that contains the reference to the parent
                object.<p class="p"> Instead of defining relationships through primary keys and foreign
                  keys, the Salesforce database uses reference fields. A reference field stores the
                  ID of the related parent record.</p>
              </td>

              <td class="entry" headers="d100467e60" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d100467e63" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d100467e51" data-title="Property Name"><samp class="codeph nolang">junctionIdListNames</samp></td>

              <td class="entry" headers="d100467e54" data-title="Type">String[]</td>

              <td class="entry" headers="d100467e57" data-title="Description">The names of the <samp class="codeph nolang">JunctionIdList</samp> fields
                associated with an object. Each ID is a polymorphic key, which is an ID that can
                refer to more than one type of object.</td>

              <td class="entry" headers="d100467e60" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d100467e63" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d100467e51" data-title="Property Name"><samp class="codeph nolang">junctionReferenceTo</samp></td>

              <td class="entry" headers="d100467e54" data-title="Type">String[]</td>

              <td class="entry" headers="d100467e57" data-title="Description">A collection of object names that the polymorphic keys in the <samp class="codeph nolang">junctionIdListNames</samp> property can reference. <p class="p">You
                  can query these object names.</p>
              </td>

              <td class="entry" headers="d100467e60" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d100467e63" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d100467e51" data-title="Property Name"><samp class="codeph nolang">relationshipName</samp></td>

              <td class="entry" headers="d100467e54" data-title="Type">String</td>

              <td class="entry" headers="d100467e57" data-title="Description">The name of the relationship. <p class="p">A name for the child relationship that is
                  unique to the parent. The name is the plural form of the child object name. For
                  example, Account has child relationships to Assets, Cases, and Contacts, among
                  other objects. Account has a <samp class="codeph nolang">relationshipName</samp>
                  for each object: <samp class="codeph nolang">Assets</samp>, <samp class="codeph nolang">Cases</samp>, and <samp class="codeph nolang">Contacts</samp>.</p>
              </td>

              <td class="entry" headers="d100467e60" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d100467e63" data-title="Available Version">41.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm "The metadata for an object.")

<!-- document id=cafffec754daabe585d43e98f96ae0b2b653e4c2cfbe98ce6177732c41ea0ea9 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_contentdocumentcomposite.md -->

# Content Document Composite

The file and its relationship to a record.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| contentDocument | [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm "The field data, API name, child relationship data, and record type information for a record.") | The record associated with the content document. | Small, 56.0 | 56.0 |
| contentDocumentLinks | [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm "The field data, API name, child relationship data, and record type information for a record.")\[\] | The relationship between a record and a content document. | Small, 56.0 | 56.0 |
| contentVersion | [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm "The field data, API name, child relationship data, and record type information for a record.") | The record associated with the content document. Creating a new content version also creates a content document. | Small, 56.0 | 56.0 |

#### See Also

- [Upload a File](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_contentversion.htm "Upload a file such as a document or image.")
- [Upload a New File Version](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_contentdocument.htm "Upload a new document or image version.")

<!-- document id=f54b59bb54c67ae44bd1c607c501f75efded1805e2ee07d89da391c1d8e6bd27 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_content_input.md -->

# Content Input

Upload a file or a new file version.

To upload a file or a new file version, provide the binary file in a multipart/form-data body part where name="fileData". See [Upload Binary Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_binary_upload.htm "If a record has a Base64 field, you can upload binary data to the field when you create or update a record.") and [Upload Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm "Upload documents and images or update the file with a new version.").

Example for Uploading a File

POST /ui-api/records/content-documents/content-versions

{
  "description": "A description of the product",
  "title": "product\_image"
}

Example for Uploading a New Version of a File

POST /ui-api/records/content-documents/0692L00000BDVevQAH/content-versions

{
  "description": "Version 2 of the product image",
  "title": "product\_image"
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| description | String | A description of the document or image to be uploaded. | Optional | 56.0 |
| title | String | The title of the document or image to be uploaded. | Optional | 56.0 |

#### See Also

- [Upload a New File Version](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_contentdocument.htm "Upload a new document or image version.")
- [Upload a File](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_contentversion.htm "Upload a file such as a document or image.")

<!-- document id=3bc4ddaebd3b1d395a6825313155393a103f335de6550b3a912f7c02333a442a url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_records_batch_post.md -->

# Create a Batch of Records

Create multiple records. You can create, update, and delete up to 200 records in a single request.

Resource

/ui-api/records/batch

Available Version

59.0

HTTP Method

POST

Example

This example creates an account and a contact, and updates a record.

POST /ui-api/records/batch

{
  "allOrNone": false,
  "operations": \[
    {
      "type": "CREATE",
      "records": \[
        {
          "apiName": "Account",
          "fields": {
            "Name": "Global Media"
          }
        },
        {
          "apiName": "Contact",
          "fields": {
            "LastName": "Smith"
          }
        }
      \]
    },
    {
      "type": "Update",
      "records": \[
        {
          "fields": {
            "Id": "001xx000003Gaf9AAC",
            "NumberOfEmployees": 1000
          }
        }
      \]
    }
  \]
}

Request Body

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| recordInput | [Batch Record Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_input.htm "A description of multiple operations for a request to create, update, or delete a batch of records.") | The batch of record input. | Required | 59.0 |

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d78783e177">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d78783e180">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d78783e183">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d78783e186">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d78783e189">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d78783e177" data-title="Name"><samp class="codeph nolang">useDefaultRule</samp></td>

                  <td class="entry" headers="d78783e180" data-title="Type">Boolean</td>

                  <td class="entry" headers="d78783e183" data-title="Description">
                    <p class="p">For a Case or Lead, specifies whether to use the default (<samp class="codeph nolang">active</samp>) assignment rule. If you specify
                      <samp class="codeph nolang">useDefaultRule</samp>, don’t specify an
                      <samp class="codeph nolang">assignmentRuleId</samp>.
                    </p>

                    <p class="p">For an Account, specifies whether to apply the default territory assignment
                      rules. </p>

                    <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

                    <p class="p">See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_header_assignmentruleheader.htm" target="_blank" title="HTML (New Window)">AssignmentRuleHeader</a> in <em class="ph i">SOAP API Developer Guide</em>.</p>

                  </td>

                  <td class="entry" headers="d78783e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d78783e189" data-title="Available Version">64.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results.htm#ui_api_responses_batch_results "The results from a request to a batch resource. Results include information for each subrequest in the batch.")

Usage

When creating a batch of records, you must include the required apiName field in [Batch Operation Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_operation_input.htm "Represents the operation type and record data to create, update, and delete in a batch."). Don’t include the Id field. Otherwise, a 400 HTTP status code with an INVALID\_BATCH\_REQUEST error is returned.

Receiving a 400 HTTP status code with an INVALID\_INPUT error can be caused by one of these reasons.

- The operations field is missing or empty.
- The operation type is missing.
- The operations field doesn’t contain a records field or the records field is empty.

#### See Also

- [Update a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_update.htm "Update multiple records. You can create, update, and delete up to 200 records in a single request.")
- [Delete a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_delete.htm "Delete multiple records. You can create, update, and delete up to 200 records in a single request.")

<!-- document id=be72481ff214a1b604276a712353251b3a1b0169b4a1c7d6397f9a12528f53e9 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorites_create.md -->

# Create a Favorite

Create a favorite.

Resource

/ui-api/favorites

Available Version

41.0

HTTP Method

POST

Example

POST /ui-api/favorites/

{
  name: "Most Important Accounts",
  sortOrder: 1
  target: "00BR0000000tTTwMAM",
  targetType: "ListView"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d43950e105">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d43950e108">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d43950e111">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d43950e114">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d43950e117">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d43950e105" data-title="Name"><samp class="codeph nolang">name</samp></td>

                  <td class="entry" headers="d43950e108" data-title="Type">String</td>

                  <td class="entry" headers="d43950e111" data-title="Description">The name of the favorite.</td>

                  <td class="entry" headers="d43950e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d43950e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d43950e105" data-title="Name"><samp class="codeph nolang">sortOrder</samp></td>

                  <td class="entry" headers="d43950e108" data-title="Type">Integer</td>

                  <td class="entry" headers="d43950e111" data-title="Description">The sort order of the favorite, from 1 to N.</td>

                  <td class="entry" headers="d43950e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d43950e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d43950e105" data-title="Name"><samp class="codeph nolang">target</samp></td>

                  <td class="entry" headers="d43950e108" data-title="Type">String</td>

                  <td class="entry" headers="d43950e111" data-title="Description">The record, API name, or content being favorited.</td>

                  <td class="entry" headers="d43950e114" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d43950e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d43950e105" data-title="Name"><samp class="codeph nolang">targetType</samp></td>

                  <td class="entry" headers="d43950e108" data-title="Type">String</td>

                  <td class="entry" headers="d43950e111" data-title="Description">The type of favorite. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">ListView</samp>—A favorited list
                        view.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ObjectHome</samp>—A favorited object
                        home.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Record</samp>—A favorited record.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Tab</samp>—A favorited tab.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d43950e114" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d43950e117" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Request Body

[Favorite Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_input.htm "A favorite to create or update.")

Response Body

[Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite.htm#ui_api_responses_favorite "A single favorite.")

<!-- document id=819f92105d7d533cf33b6b1417ee89eece8d0ab89f399757553bd3ed5fc5cac9 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_lists_object_post.md -->

# Create a List View for an Object

Create a list view associated with an object.

Resource

/ui-api/list-info/${objectApiName}

Available version

61.0

HTTP methods

POST

Example

This example uses a request body to create the metadata for an account list view.

POST /services/data/v68.0/ui-api/list-info/Account

{
"listViewApiName": "MyAccountListView",
"filteredByInfo": \[
  {
  "fieldApiName": "Name",
  "operandLabels": \[ "This", "That"\],
  "operator": "Equals"
  },
  {
  "fieldApiName": "Phone",
  "operandLabels": \[ "919"\],
  "operator": "StartsWith"
  },
{
  "fieldApiName": "AnnualRevenue",
  "operandLabels": \[ "1000000"\],
  "operator": "GreaterThan"
  }
\],
"filterLogicString" : "(1 OR 2) AND 3",
"label": "Accounts opened this year",
"scope": {
  "apiName": "entity",
  "entityId": "00Gxx000000sjI8",
  "relatedEntityId": "701xx000003HZ7X"
},
"visibility": "Public"
}

Request parameters for POST

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| listInfoInput | [List Info Post Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_info_post_input.htm "Info to create a list.") | Info to create a list. | Required | 61.0 |

Response body for POST

[List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")

<!-- document id=b642fdfef6d02fa53f9694a4767e53457e5088fed277c57bfe786c7f22e53434 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_records_create.md -->

# Create or Clone a Record

Create or clone a record.

## Usage

To create or clone a record, pass a [Record Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_record_input.htm "A description of a record to use in a request to create or update a record or in a request to check for duplicate records.") request body to the POST /ui-api/records resource. To create the request body, you must know the fields, required fields, and default values for that object. You may also want layout information. If you don’t want layout information, use the lightweight resources.

To find the required fields, fields, and default values, make a request to one of these resources.

- [Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Create a Record—Lightweight](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_template_create.htm "Get the default values for fields for a new record of a specified object and optional record type. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Clone a Record—Lightweight](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_template_clone.htm "Get the default values for fields for cloning a record. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.")

The response from these resources includes [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm "The metadata for an object."), including all fields and a required property for each field.

To find the values for lookup fields, picklist fields, and multi-select picklist fields, use these resources.

- [Get Lookup Field Suggestions for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_object_get.htm "When a user edits a lookup field, use this resource to search for and display suggestions for a specified object. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.")
- [Get Lookup Field Suggestions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_get.htm "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.")
- [Get Values for a Picklist Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values.htm "If a field’s dataType property is equal to Picklist or MultiPicklist, use this resource to get its values.")
- [Get Values for All Picklist Fields of a Record Type](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm "Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request.")

As of API version 43.0, if you pass read-only fields in a request body, the response is an [Error with Output](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_error_with_output.htm#ui_api_responses_error_with_output "Contains extra information about errors. In rare cases, an error message isn't enough to describe the reason for a failure. For example, when a conflicting precondition exists, the error result can include the information about the cause of the conflict.").

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

#### Note

ProductMedia records can’t be created with this resource. Use the [ProductMedia object API](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productmedia.htm) instead.

Resource

/ui-api/records

Available Version

41.0

HTTP Method

POST

Example

POST /ui-api/records

{
  "apiName": "Account",
  "fields": {
    "Name": "Universal Containers"
  }
}

To provide an address, provide the individual fields as separate inputs. The compound field is only available in the response.

{
  "apiName": "Account",
  "fields" : {
    "Name": "Local Boxes",
    "BillingState": "WA",
    "BillingStreet" : "123 Main Street",
    "BillingCountry" : "USA"
  }
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d81601e270">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d81601e273">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d81601e276">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d81601e279">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d81601e282">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d81601e270" data-title="Parameter Name"><samp class="codeph nolang">allowSaveOnDuplicate</samp></td>

                  <td class="entry" headers="d81601e273" data-title="Type">Boolean</td>

                  <td class="entry" headers="d81601e276" data-title="Description">Specifies whether to save a duplicate record. The default value is
                    <samp class="codeph nolang">false</samp>.
                  </td>

                  <td class="entry" headers="d81601e279" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d81601e282" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d81601e270" data-title="Parameter Name"><samp class="codeph nolang">handleOwnerChange</samp></td>

                  <td class="entry" headers="d81601e273" data-title="Type">Boolean</td>

                  <td class="entry" headers="d81601e276" data-title="Description">Specifies whether to return a <samp class="codeph nolang">204 No
                      Content</samp> HTTP status code if the context user loses access to the
                    record during creation. The default value is <samp class="codeph nolang">false</samp>. When <samp class="codeph nolang">false</samp>, if the
                    context user loses access to the record during creation, creation completes
                    successfully, however the resource returns an incorrect <samp class="codeph nolang">404 Not found</samp> HTTP status code.</td>

                  <td class="entry" headers="d81601e279" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d81601e282" data-title="Available Version">60.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d81601e270" data-title="Parameter Name">
                    <samp class="codeph nolang">triggerOtherEmail</samp>
                  </td>

                  <td class="entry" headers="d81601e273" data-title="Type">Boolean</td>

                  <td class="entry" headers="d81601e276" data-title="Description">For a Case, specifies whether to send email to users outside the
                    organization. In the Salesforce user interface, this email can be
                    automatically triggered by creating, editing, or deleting a contact for a
                    Case.<p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>
                    <p class="p">See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_header_emailheader.htm" target="_blank" title="HTML (New Window)">EmailHeader</a>
                      in <em class="ph i">SOAP API Developer Guide</em>.</p>
                  </td>

                  <td class="entry" headers="d81601e279" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d81601e282" data-title="Available Version">51.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d81601e270" data-title="Parameter Name"><samp class="codeph nolang">triggerUserEmail</samp></td>

                  <td class="entry" headers="d81601e273" data-title="Type">Boolean</td>

                  <td class="entry" headers="d81601e276" data-title="Description">For a Case or a Lead, specifies whether to send email to users in the
                    organization. In the Salesforce user interface, this email can be
                    automatically triggered by various events: resetting a password, creating a
                    user, changing the Case owner, or adding comments to a Case.<p class="p">For Case owner
                      changes, also set <samp class="codeph nolang">useDefaultRule=true</samp>,
                      or no email is sent. </p>
                    <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>
                    <p class="p">See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_header_emailheader.htm" target="_blank" title="HTML (New Window)">EmailHeader</a>
                      in <em class="ph i">SOAP API Developer Guide</em>.</p>
                  </td>

                  <td class="entry" headers="d81601e279" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d81601e282" data-title="Available Version">51.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d81601e270" data-title="Parameter Name"><samp class="codeph nolang">useDefaultRule</samp></td>

                  <td class="entry" headers="d81601e273" data-title="Type">Boolean</td>

                  <td class="entry" headers="d81601e276" data-title="Description">
                    <p class="p">For a Case or Lead, specifies whether to use the default (<samp class="codeph nolang">active</samp>) assignment rule. If you specify
                      <samp class="codeph nolang">useDefaultRule</samp>, don’t specify an
                      <samp class="codeph nolang">assignmentRuleId</samp>.
                    </p>

                    <p class="p">When you create an Account, as long as the account matches any filter for a
                      territory, the Account is assigned to that territory regardless of how
                      <samp class="codeph nolang">useDefaultRule</samp> is set.
                    </p>

                    <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

                    <p class="p">See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_header_assignmentruleheader.htm" target="_blank" title="HTML (New Window)">AssignmentRuleHeader</a> in <em class="ph i">SOAP API Developer Guide</em>.</p>

                  </td>

                  <td class="entry" headers="d81601e279" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d81601e282" data-title="Available Version">51.0</td>

                </tr>

              </tbody>

            </table>

Request Body

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d81601e499">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d81601e502">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d81601e505">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d81601e508">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d81601e511">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d81601e499" data-title="Name"><samp class="codeph nolang">allowSaveOnDuplicate</samp></td>

                  <td class="entry" headers="d81601e502" data-title="Type">Boolean</td>

                  <td class="entry" headers="d81601e505" data-title="Description">Specifies whether to save a duplicate record (<samp class="codeph nolang">true</samp>), or not (<samp class="codeph nolang">false</samp>). The
                    default value is <samp class="codeph nolang">false</samp>.<p class="p">Don’t specify
                      this property when checking for duplicate records.</p>
                  </td>

                  <td class="entry" headers="d81601e508" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d81601e511" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d81601e499" data-title="Name"><samp class="codeph nolang">apiName</samp></td>

                  <td class="entry" headers="d81601e502" data-title="Type">String</td>

                  <td class="entry" headers="d81601e505" data-title="Description">To create a record, specify the API name of an Object from which to
                    create the record. To update a record, use <samp class="codeph nolang">null</samp> or don’t pass this property. To check for duplicate records,
                    specify the API name of the object for which you’re performing the duplicate
                    check.</td>

                  <td class="entry" headers="d81601e508" data-title="Required or Optional">Required to create a record.<p class="p">Required to check for duplicate
                      records.</p>
                  </td>

                  <td class="entry" headers="d81601e511" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d81601e499" data-title="Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d81601e502" data-title="Type">Map&lt;String, Object&gt;</td>

                  <td class="entry" headers="d81601e505" data-title="Description">Map of field names to field values.<p class="p">Format data types according to
                      these rules: </p>
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Address</samp>—JSON String.
                        Addresses are compound fields and must be broken up into their constituent
                        fields. See the previous example.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Boolean</samp>—JSON Boolean,
                        <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Currency</samp>—JSON Number (for
                        example, <samp class="codeph nolang">67.54</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Date</samp>—JSON string (for
                        example, <samp class="codeph nolang">2020-04-20</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">DateTime</samp>—JSON string in ISO
                        8601 format (for example, <samp class="codeph nolang">2012-02-18T06:40:41.000Z</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Double</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Email</samp>—JSON String (for
                        example, <samp class="codeph nolang">joe@smith.com</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">EncryptedString</samp>—JSON
                        String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Int</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Location</samp>—JSON String.
                        Location fields are compound fields and must be broken up into their
                        constituent fields.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">MultiPicklist</samp>—JSON String
                        (for example, <samp class="codeph nolang">Dog;Cat;Fish)</samp>.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Percent</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Phone</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Picklist</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Reference</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">String</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">TextArea</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Time</samp>—JSON String in format
                        <samp class="codeph nolang">HH:MM:SS</samp>
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Url</samp>—JSON String
                      </li>

                    </ul>
                    <p class="p">To specify the main record type, either don’t specify the <samp class="codeph nolang">RecordTypeId</samp> field, or set it to <samp class="codeph nolang">null</samp>.</p>
                  </td>

                  <td class="entry" headers="d81601e508" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d81601e511" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.")

#### See Also

- [Upload Binary Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_binary_upload.htm "If a record has a Base64 field, you can upload binary data to the field when you create or update a record.")

<!-- document id=dfa9c926f4e2108a4499de6cf188e483168877546f27a3dbd31b36efc96200b1 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_csrf_token.md -->

# CSRF Token

Cross-Site Request Forgery (CSRF) token.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| csrfToken | String | CSRF token string. | Big, 67.0 | 67.0 |

#### See Also

- [Session CSRF Token](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_session_csrf.htm "Get the Cross-Site Request Forgery (CSRF) token for your session to protect requests from malicious third-party sites forgeries.")

<!-- document id=eba519739be96a5619501245ec711718e773aaf07ae2312a24e11da286cefd5f url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_custom_link_layout_component.md -->

# Custom Link Layout Component

A custom link component on a record page layout.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d101951e28">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d101951e30">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d101951e32">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d101951e34">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d101951e36">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d101951e30" data-title="Type">String</td>

              <td class="entry" headers="d101951e32" data-title="Description">If a field powers this component, this property contains the API name of the field.</td>

              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">behavior</samp></td>
              <td class="entry" headers="d101951e30" data-title="Type">String</td>
              <td class="entry" headers="d101951e32" data-title="Description">Indicates how a link behaves on open. One of these values: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">NewWindow</samp>—Open a new window.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NoSidebar</samp>—No sidebar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OnClickJavaScript</samp>—When the link is
                    clicked, run JavaScript.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Replace</samp>—Replace the current page.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Sidebar</samp>—Sidebar
                  </li>

                </ul>
              </td>
              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>
            </tr>


            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">componentType</samp></td>

              <td class="entry" headers="d101951e30" data-title="Type">String</td>

              <td class="entry" headers="d101951e32" data-title="Description">The component type. The value is <samp class="codeph nolang">CustomLink</samp>.</td>

              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>

            </tr>
            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">customLinkUrl</samp></td>
              <td class="entry" headers="d101951e30" data-title="Type">String</td>
              <td class="entry" headers="d101951e32" data-title="Description">The custom link URL.</td>
              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">label</samp></td>
              <td class="entry" headers="d101951e30" data-title="Type">String</td>
              <td class="entry" headers="d101951e32" data-title="Description">The custom link label.</td>
              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.")

<!-- document id=86b45c862743edbb4893ad908f2429a84965d51270080ab7dcf109911f3b6bf3 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_records_batch_delete.md -->

# Delete a Batch of Records

Delete multiple records. You can create, update, and delete up to 200 records in a single request.

Resource

/ui-api/records/batch

Available Version

59.0

HTTP Method

POST

Example

This example deletes multiple records.

POST /ui-api/records/batch

{
  "allOrNone": false,
  "operations": \[
    {
      "type": "Delete",
      "records": \[
        {
          "fields": {
            "Id": "001xx000003GanDAAS"
          }
        },
        {
          "fields": {
            "Id": "001xx000003Gaf9AAC"
          }
        }
      \]
    }
  \]
}

Request Body

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| recordInput | [Batch Record Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_input.htm "A description of multiple operations for a request to create, update, or delete a batch of records.") | The batch of record input. | Required | 59.0 |

Response Body

[Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results.htm#ui_api_responses_batch_results "The results from a request to a batch resource. Results include information for each subrequest in the batch.")

Usage

When deleting a batch of records, you must include the required Id field. Don’t include the apiName field in [Batch Operation Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_operation_input.htm "Represents the operation type and record data to create, update, and delete in a batch.").

You can’t perform multiple operations on the same record in one request. A delete operation using an Id value that’s used in another update or delete operation can’t be processed. Otherwise, a 400 HTTP status code with an INVALID\_BATCH\_REQUEST error is returned.

Receiving a 400 HTTP status code with an INVALID\_INPUT error can be caused by one of these reasons.

- The operations field is missing or empty.
- The operation type is missing.
- The operations field doesn’t contain a records field or the records field is empty.

#### See Also

- [Create a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_post.htm "Create multiple records. You can create, update, and delete up to 200 records in a single request.")
- [Update a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_update.htm "Update multiple records. You can create, update, and delete up to 200 records in a single request.")

<!-- document id=fff88460770ed7757b0667867f7871d1e5dcb208aed16390d551af23ad3006bd url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorite_delete.md -->

# Delete a Favorite

Delete a favorite.

Resource

/ui-api/favorites/${favoriteId}

favoriteId—The ID of a favorite.

Available Version

41.0

HTTP Method

DELETE

Response Body

Deleting a record returns a 200 HTTP status code.

<!-- document id=94fc520fdd12b0cdebe707349373d1d6605f327a13262996d961af90ca2d25f1 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_delete.md -->

# Delete a Record

Delete a record.

/ui-api/records/{recordId}

Available Version

41.0

HTTP Method

DELETE

Delete a record

Deleting a record returns a 200 HTTP status code.

DELETE /ui-api/records/001R0000003Gjrt

<!-- document id=786069305cdc1936f45f10fb5d41f003f53268be77a92b884f61e009d4d2167d url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_views_md_delete.md -->

# Delete List View Metadata

Delete list view metadata.

Resource

/ui-api/list-info/${objectApiName}/${listViewApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- listViewApiName—The API name of a list view, such as AllAccounts.

Available Version

61.0

HTTP Method

DELETE

Example

This example deletes the metadata for a list view. The object API name is Account and the list view API name is AllAccounts.

DELETE /services/data/v68.0/ui-api/list-info/Account/AllAccounts

Response

Deleting list view metadata returns a 204 HTTP status code.

<!-- document id=4462d393c9e96832a864469bc2c6cf10ed17cfb5c408b487532e2a4210c6168b url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_display_layout.md -->

# Display Layout

Search lookups target display layout metadata.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| displayFields | String\[\] | Fields to display in lookup results. | Small, 57.0 | 57.0 |

<!-- document id=3e8b6f7b10afd3fea342b19cecee452207f31a0f209a62ffb15cfafcd805371c url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_display_layout_and_matching_info.md -->

# Display Layout and Matching Info

Search lookups target display layout and matching information.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| displayLayout | [Display Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_display_layout.htm "Search lookups target display layout metadata.") | Display information for lookup results. | Small, 57.0 | 57.0 |
| matchingInfo | [Matching Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_matching_info.htm "Search lookups target matching information.") | Information about matching fields. | Small, 57.0 | 57.0 |

<!-- document id=6fbc464616d7a44ee5d3b984a31ae6eb12f9acc9861fbc88b8e614682de98e59 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_duplicate_record_error.md -->

# Duplicate Record Error

Information about duplicate record errors. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| matchResults | [Match Result](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_match_result.htm#ui_api_responses_match_result "A duplicate rule match. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record. Each duplicate rule requires at least one matching rule to identify which existing records are possible duplicates.")\[\] | A collection of duplicate rule match results. Each duplicate rule requires at least one matching rule to identify which existing records are possible duplicates. | Small, 41.0 | 41.0 |

#### See Also

- [Record Exception Error](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_exception_error.htm "Information about a record exception error.")

<!-- document id=7ae898ec290e9da56bfd96e6608e82b2926a8299942a74fd13ca07175eaf07c3 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_duplicate_result_info.md -->

# Duplicate Result Info

The result of the check for duplicate records. If duplicate records exist, returns the records' IDs and the duplicate rule that was used to match the records.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| allowSave | Boolean | Whether the duplicate record can be saved (true) or not (false). | Small, 50.0 | 50.0 |
| matchResultInfo | [Match Result Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_match_result_info.htm "Information about the results of a match.") | Information about the match result. | Small, 50.0 | 50.0 |
| rule | String | Name of the duplicate rule. | Small, 50.0 | 50.0 |

<!-- document id=23826c476b0eb44686b272560da2fd805bab21510004b181e0800aeb0fa18bfc url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_duplicate_rule.md -->

# Duplicate Rule

Describes a duplicate rule.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d103965e51">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d103965e54">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d103965e57">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d103965e60">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d103965e63">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d103965e51" data-title="Property Name"><samp class="codeph nolang">actionOnInsert</samp></td>

              <td class="entry" headers="d103965e54" data-title="Type">String</td>

              <td class="entry" headers="d103965e57" data-title="Description">Whether users can create a duplicate record. Possible values are: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Allow</samp>—duplicate records can be
                    created
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Block</samp>—duplicate records can't be
                    created
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d103965e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d103965e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d103965e51" data-title="Property Name"><samp class="codeph nolang">actionOnUpdate</samp></td>

              <td class="entry" headers="d103965e54" data-title="Type">String</td>

              <td class="entry" headers="d103965e57" data-title="Description">Whether users can create a duplicate record while editing an existing record.
                Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Allow</samp>—users can create a duplicate
                    record while editing an existing record
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Block</samp>—users can't create a
                    duplicate record while editing an existing record
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d103965e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d103965e63" data-title="Available Version">50.0</td>

            </tr>


            <tr>
              <td class="entry" headers="d103965e51" data-title="Property Name"><samp class="codeph nolang">active</samp></td>

              <td class="entry" headers="d103965e54" data-title="Type">Boolean</td>

              <td class="entry" headers="d103965e57" data-title="Description">Indicates whether the duplicate rule is active (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d103965e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d103965e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d103965e51" data-title="Property Name"><samp class="codeph nolang">duplicateRuleFilters</samp></td>

              <td class="entry" headers="d103965e54" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_rule_filter.htm" title="A duplicate rule filter.">Duplicate Rule Filter</a>[]
              </td>

              <td class="entry" headers="d103965e57" data-title="Description">A list of filters that are used by the duplicate rule.</td>

              <td class="entry" headers="d103965e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d103965e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d103965e51" data-title="Property Name"><samp class="codeph nolang">matchRules</samp></td>

              <td class="entry" headers="d103965e54" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_match_rule.htm" title="A match rule defines how duplicate records are identified in duplicate rules and duplicate jobs. Learn about one of the match rules for the specified object, including the match rule's name and the fields that the match rule checks.">Match Rule</a>[]
              </td>

              <td class="entry" headers="d103965e57" data-title="Description">A list of the match rules that are used by the duplicate rule.</td>

              <td class="entry" headers="d103965e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d103965e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d103965e51" data-title="Property Name"><samp class="codeph nolang">name</samp></td>

              <td class="entry" headers="d103965e54" data-title="Type">String</td>

              <td class="entry" headers="d103965e57" data-title="Description">The name of the duplicate rule.</td>

              <td class="entry" headers="d103965e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d103965e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d103965e51" data-title="Property Name"><samp class="codeph nolang">operationsOnInsert</samp></td>

              <td class="entry" headers="d103965e54" data-title="Type">String[]</td>

              <td class="entry" headers="d103965e57" data-title="Description">Actions to take when a user creates a duplicate record. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Alert</samp></li>

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

                </ul>
              </td>

              <td class="entry" headers="d103965e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d103965e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d103965e51" data-title="Property Name"><samp class="codeph nolang">operationsOnUpdate</samp></td>

              <td class="entry" headers="d103965e54" data-title="Type">String[]</td>

              <td class="entry" headers="d103965e57" data-title="Description">Actions to take when the edits to a record cause it to become a duplicate
                record. Possible values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Alert</samp></li>

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

                </ul>
              </td>

              <td class="entry" headers="d103965e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d103965e63" data-title="Available Version">50.0</td>

            </tr>

          </tbody>

        </table>

<!-- document id=1dbf55835e460d22beffaf7614f16b5e0957a843fc5c8959faf74bdc09a5303a url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_duplicate_rule_filter.md -->

# Duplicate Rule Filter

A duplicate rule filter.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| booleanFilter | String | The filter's boolean logic. | Small, 50.0 | 50.0 |
| filterItems | [Duplicate Rule Filter Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_rule_filter_item.htm "A filter, or condition, for a duplicate rule. For example, a condition can specify that this rule applies only to movies that were produced in the United States.")\[\] | A list of filter items. | Small, 50.0 | 50.0 |
| ruleCritera | String | The rule criteria. | Small, 50.0 | 50.0 |

<!-- document id=a5a325345d6c67dc5b8b9cd66d09568871281bc23eea05baf704517a93bf5666 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_duplicate_rule_filter_item.md -->

# Duplicate Rule Filter Item

A filter, or condition, for a duplicate rule. For example, a condition can specify that this rule applies only to movies that were produced in the United States.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| field | String | The name of the field on which the condition is evaluated. | Small, 50.0 | 50.0 |
| operation | String | The condition operator. For example, equals or includes. | Small, 50.0 | 50.0 |
| sortOrder | Integer | Conditions are applied in the specified order. The order of the condition, starting with 1. | Small, 50.0 | 50.0 |
| value | String | The value of field that matches the condition. For example, to specify that a rule applies only to movies produced in the United States, set the value to United States. | Small, 50.0 | 50.0 |

<!-- document id=5268654e2cc3d645f8e24c544a9c58e57fffa1a63569b627bddfbbb9001acb20 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_duplicates.md -->

# Duplicates

The results of a check for duplicate records.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| allowSave | Boolean | Indicates whether this duplicate record can be saved (true) or not (false). | Small, 50.0 | 50.0 |
| duplicateError | Boolean | Indicates whether duplicate records exist (true) or not (false). | Small, 50.0 | 50.0 |
| duplicateRules | String\[\] | A list of the duplicate rules that were used to determine whether duplicate records exist. | Small, 50.0 | 50.0 |
| matches | [Match](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_match.htm "A group of records that match the duplicate rules.")\[\] | The IDs of the duplicate records. | Small, 50.0 | 50.0 |

<!-- document id=b9ec68db482460811fc2c1274cc8655e9af30fbb7ed975da252382096027a691 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_duplicates_configuration.md -->

# Duplicates Configuration

Contains information about duplicate management configuration for an object. Learn whether duplicate management is configured, which fields are used to determine whether duplicate records exist, and which duplicate rules are active.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | The API name of the object. | Small, 50.0 | 50.0 |
| dedupeEnabled | Boolean | Indicates whether any duplicate rules are active for the object (true) or not (false). | Small, 50.0 | 50.0 |
| dedupeFields | String\[\] | The fields used to determine whether a record is a duplicate. Lists all fields that are used in all matching rules that are currently active. | Small, 50.0 | 50.0 |
| duplicateRules | [Duplicate Rule](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_rule.htm "Describes a duplicate rule.")\[\] | The duplicate rules that are active for the object. | Small, 50.0 | 50.0 |
| predupeEnabled | Boolean | Indicates whether matching rules are active for the object (true) or not (false). | Small, 50.0 | 50.0 |

#### See Also

- [Get Duplicate Management Configuration for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_duplicates_get.htm "Learn whether duplicate management is configured for the specified object. If duplicate management is configured, learn about the object's duplicate rules and matching rules. Use the information in the response to know when to check for duplicate records.")

<!-- document id=bc9d534b42c5add94f4d55941d5be6c5fc098bb2adc99ceb3b98687be9001fc2 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_error_message.md -->

# Error Message

An error code and error message.

| Property | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| errorCode | String | An error code with information about the error, for example, INSUFFICIENT\_PRIVILEGES | Small, 41.0 | 41.0 |
| message | String | Description of error | Small, 41.0 | 41.0 |

#### See Also

- [Batch Result Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_result.htm "The results of one subrequest in a batch request.")

<!-- document id=45aadd5db378f02dc315e0d910dbaf90fd5f5d2db19cc0d786dbc4b0280d1272 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_error_with_output.md -->

# Error with Output

Contains extra information about errors. In rare cases, an error message isn't enough to describe the reason for a failure. For example, when a conflicting precondition exists, the error result can include the information about the cause of the conflict.

User Interface API enforces Salesforce validation rules. If a validation rule fails, the error is reported here.

<table class="featureTable sort_table" summary="">
        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader vertical-align-top " id="d107814e45">Property</th>

            <th class="featureTableHeader vertical-align-top " id="d107814e48">Type</th>

            <th class="featureTableHeader vertical-align-top " id="d107814e51">Description</th>

            <th class="featureTableHeader vertical-align-top " id="d107814e54">Filter Group and Version</th>

            <th class="featureTableHeader vertical-align-top " id="d107814e57">Available Version</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d107814e45" data-title="Property"><samp class="codeph nolang">enhancedErrorType</samp></td>

            <td class="entry" headers="d107814e48" data-title="Type">String</td>

            <td class="entry" headers="d107814e51" data-title="Description">Indicates the type of the <samp class="codeph nolang">output</samp> property. The
              value is either <samp class="codeph nolang">null</samp> or <samp class="codeph nolang">RecordError</samp>.</td>

            <td class="entry" headers="d107814e54" data-title="Filter Group and Version">Small, 41.0</td>

            <td class="entry" headers="d107814e57" data-title="Available Version">41.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d107814e45" data-title="Property"><samp class="codeph nolang">message</samp></td>

            <td class="entry" headers="d107814e48" data-title="Type">String</td>

            <td class="entry" headers="d107814e51" data-title="Description">Description of the error.</td>

            <td class="entry" headers="d107814e54" data-title="Filter Group and Version">Small, 41.0</td>

            <td class="entry" headers="d107814e57" data-title="Available Version">41.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d107814e45" data-title="Property"><samp class="codeph nolang">output</samp></td>

            <td class="entry" headers="d107814e48" data-title="Type">Any response body</td>

            <td class="entry" headers="d107814e51" data-title="Description">The response body returned by the requested resource. For example, if a successful request
              returns a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info" title="The metadata for an object.">Object Info</a> response body but an
              error triggers the Error with Output response body, the value of the <samp class="codeph nolang">output</samp> property is an Object Info response body.<p class="p">When an
                error occurs related to record create or update, this value is <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_exception.htm#ui_api_responses_record_exception" title="A collection of record exception errors.">Record Exceptions</a>.</p>
            </td>

            <td class="entry" headers="d107814e54" data-title="Filter Group and Version">Small, 41.0</td>

            <td class="entry" headers="d107814e57" data-title="Available Version">41.0</td>

          </tr>

        </tbody>

      </table>

<!-- document id=03e2f692c0f4fa11851e675513011fa790d6ead36a6b4f25dcaf7802d8a664ec url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_favorite.md -->

# Favorite

A single favorite.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d108313e33">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d108313e35">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d108313e37">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d108313e39">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d108313e41">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">accessCount</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">Integer</td>
              <td class="entry" headers="d108313e37" data-title="Description">The number of times this favorite has been used.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Big, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">iconColor</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The color of the icon for this favorite, usually the related object’s color.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Big, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">iconUrl</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The URL of the icon for the favorite, usually the related object’s icon.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Big, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">id</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The ID of the favorite.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">lastAccessDate</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The last time this favorite was used. The value is in <a class="xref" href="https://www.w3.org/TR/NOTE-datetime" target="_blank" title="HTML (New Window)">ISO 8061</a> date and time format.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Big, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">name</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The name of the favorite.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">objectType</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The developer name of the entity associated with this favorite, if any.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Medium, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">sortOrder</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">Integer</td>
              <td class="entry" headers="d108313e37" data-title="Description">The sort order of the favorite, from 1 to N.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">subtitle</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The subtitle of the favorite, usually the object’s label. Provides additional information
                about the type of record or content being favorited.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Medium, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">target</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The record, API name, or content being favorited.</td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d108313e33" data-title="Property Name"><samp class="codeph nolang">targetType</samp></td>
              <td class="entry" headers="d108313e35" data-title="Type">String</td>
              <td class="entry" headers="d108313e37" data-title="Description">The type of record or content being favorited. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ListView</samp>—A favorited list view.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ObjectHome</samp>—A favorited object home.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Record</samp>—A favorited record.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Tab</samp>—A favorited tab.
                  </li>

                </ul>
              </td>
              <td class="entry" headers="d108313e39" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d108313e41" data-title="Available Version">41.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [Create a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_create.htm "Create a favorite.")
- [Get Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_get.htm "Get all of a user’s favorites.")
- [Update a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorite_update.htm "Update a favorite.")
- [Update Usage of a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_usage_update.htm "Update the usage of an individual favorite. Increments the accessCount and sets the lastAccessDate to the current system time.")

<!-- document id=adb7b5d868c902545b5f8569ee742bf0155294b119109130dce7bc141c631372 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_favorite_batch_collection_input.md -->

# Favorite Batch Collection Input

A collection of all the favorites in a batch. Pass this request body to update a batch of favorites.

JSON example

{
  favorites: \[
  {
    id: "0MVR00000004DhnOAE",
    name: "Q4 Perf"
  }, { 
    id: "0MVR00000004DhsOAE"
  }, {
    id: "0MVR00000004DiGOAU"
  }, {
    id: "0MVR000000001e2OAA",
    name: "Office Group"
  }, {
    id: "0MVR00000004GGlOAM"
  }}\]
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| favorites | [Favorite Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_batch_input.htm#ui_api_requests_favorite_batch_input "Represents a single favorite when updating favorites in batch.")\[\] | The list of favorites to keep and update. | Required | 41.0 |

#### See Also

- [Update a Batch of Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_batch_update.htm "Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted.")

<!-- document id=7ab9c1bbf7ac8bc9ae76d19b861ee5ca3f1421ed78928672e9f8906317d876ee url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_favorite_batch_input.md -->

# Favorite Batch Input

Represents a single favorite when updating favorites in batch.

JSON example

{
  favorites: \[
  {
    id: "0MVR00000004DhnOAE",
    name: "Q4 Perf"
  }, { 
    id: "0MVR00000004DhsOAE"
  }, {
    id: "0MVR00000004DiGOAU"
  }, {
    id: "0MVR000000001e2OAA",
    name: "Office Group"
  }, {
    id: "0MVR00000004GGlOAM"
  }}\]
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| id | String | The ID of the favorite. | Required | 41.0 |
| name | String | The name of the favorite. | Required | 41.0 |

#### See Also

- [Update a Batch of Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_batch_update.htm "Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted.")

<!-- document id=761aafa532a0563d8f153e3430481794cdd637e6de3435b093287a0c24f9aef8 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_favorite_collection.md -->

# Favorite Collection

A list of favorites.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| favorites | [Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite.htm#ui_api_responses_favorite "A single favorite.")\[\] | A list of favorites. | Small, 41.0 | 41.0 |

#### See Also

- [Update a Batch of Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_batch_update.htm "Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted.")

<!-- document id=35c58ed4b708f99d378d07ae2c6b7414043aa73c83bf2264cd0ac2ec2c0b8dc3 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_favorite_input.md -->

# Favorite Input

A favorite to create or update.

JSON example

{
  name: "Most Important Accounts",
  sortOrder: 1
  target: "00BR0000000tTTwMAM",
  targetType: "ListView"
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d22661e59">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d22661e62">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d22661e65">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d22661e68">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d22661e71">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d22661e59" data-title="Name"><samp class="codeph nolang">name</samp></td>

                  <td class="entry" headers="d22661e62" data-title="Type">String</td>

                  <td class="entry" headers="d22661e65" data-title="Description">The name of the favorite.</td>

                  <td class="entry" headers="d22661e68" data-title="Required or Optional">Required for PATCH if <samp class="codeph nolang">sortOrder</samp>
                    isn't specified. You may specify both.</td>

                  <td class="entry" headers="d22661e71" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d22661e59" data-title="Name"><samp class="codeph nolang">sortOrder</samp></td>

                  <td class="entry" headers="d22661e62" data-title="Type">Integer</td>

                  <td class="entry" headers="d22661e65" data-title="Description">The sort order of the favorite, from 1 to N.</td>

                  <td class="entry" headers="d22661e68" data-title="Required or Optional">Required for PATCH if <samp class="codeph nolang">name</samp> is
                    unspecified. You may specify both.</td>

                  <td class="entry" headers="d22661e71" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d22661e59" data-title="Name"><samp class="codeph nolang">target</samp></td>

                  <td class="entry" headers="d22661e62" data-title="Type">String</td>

                  <td class="entry" headers="d22661e65" data-title="Description">The record, API name, or content being favorited.</td>

                  <td class="entry" headers="d22661e68" data-title="Required or Optional">Required in a POST request. Do not specify in a PATCH request.</td>

                  <td class="entry" headers="d22661e71" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d22661e59" data-title="Name"><samp class="codeph nolang">targetType</samp></td>

                  <td class="entry" headers="d22661e62" data-title="Type">String</td>

                  <td class="entry" headers="d22661e65" data-title="Description">The type of favorite. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">ListView</samp>—A favorited list
                        view.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ObjectHome</samp>—A favorited object
                        home.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Record</samp>—A favorited record.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Tab</samp>—A favorited tab.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d22661e68" data-title="Required or Optional">Required in a POST request. Do not specify in a PATCH request.</td>

                  <td class="entry" headers="d22661e71" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Create a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_create.htm "Create a favorite.")
- [Update a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorite_update.htm "Update a favorite.")

<!-- document id=fee809999f5af52061c560de83a153a20c35ef239d7e612b0d802ed620485d3f url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorites.md -->

# Favorites

Use these resources to create and update a single favorite or a collection of favorites, and to get favorites usage information. These resources make it easy to build UI for favorites.

- **[Create a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_create.htm)**  
    Create a favorite.
- **[Get a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorite_get.htm)**  
    Get a favorite.
- **[Get Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_get.htm)**  
    Get all of a user’s favorites.
- **[Update a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorite_update.htm)**  
    Update a favorite.
- **[Update a Batch of Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_batch_update.htm)**  
    Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted.
- **[Delete a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorite_delete.htm)**  
    Delete a favorite.
- **[Update Usage of a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_usage_update.htm)**  
    Update the usage of an individual favorite. Increments the accessCount and sets the lastAccessDate to the current system time.

<!-- document id=4ce40816de1cd45b26a535c8bddf187df54d45b227fc85406ad32128c2975b6b url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_field.md -->

# Field

A field's metadata.

![Important](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing the often-used term master-detail can break customer implementations, we maintained this reference.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d110045e35">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d110045e37">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d110045e39">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d110045e41">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d110045e43">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">The API name for this field.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">calculated</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is a custom formula field.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">compound</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is a top-level compound field. <p class="p">If the <samp class="codeph nolang">dataType</samp> is <samp class="codeph nolang">Location</samp>, this value is usually <samp class="codeph nolang">false</samp>.</p>
              </td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">compoundComponentName</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">If this field is a component field of a compound field, the value is the
                normalized component name, otherwise the value is <samp class="codeph nolang">null</samp>. For example, if the field represents <samp class="codeph nolang">"BillingStreet"</samp> of an Address compound field, this property contains
                <samp class="codeph nolang">"Street"</samp>.
              </td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">compoundFieldName</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">If this field is a component field of a compound field, this property contains
                the top-level compound field. Otherwise, the value of this property is <samp class="codeph nolang">null</samp>.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">controllerName</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">If this field is a dependent picklist, this property is the name of the field
                that controls the values of the picklist.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">controllingFields</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String[]</td>

              <td class="entry" headers="d110045e39" data-title="Description"><span class="ph" id="controllingFields"><a name="controllingFields"><!-- --></a>If this field is a dependent picklist, this property
                  is a collection of fields that control the values in the picklist. When there’s a
                  hierarchy of controlling fields, the collection starts with the immediate parent
                  and moves up the tree.</span></td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">createable</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field can be created.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">custom</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is custom.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">dataType</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">Field type. One of these values:<a name="RecordFieldDataType"><!-- --></a>
                <ul class="ul bulletList" id="RecordFieldDataType">
                  <li class="li">
                    <samp class="codeph nolang">Address</samp>
                  </li>

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

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

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

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

                  <li class="li">
                    <samp class="codeph nolang">ComplexValue</samp>—Complex Value Type
                    (CVT).
                  </li>

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

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

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

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

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

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

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

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

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

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

                  <li class="li">
                    <samp class="codeph nolang">MultiPicklist</samp>—To populate the
                    multi-select picklist, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_resources_picklist_values.htm" target="_blank">Get Values
                      for a Picklist Field</a> or <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm" target="_blank">Get Values
                      for All Picklist Fields of a Record Type</a>.
                  </li>

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

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

                  <li class="li">
                    <samp class="codeph nolang">Picklist</samp>—To populate the picklist,
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_resources_picklist_values.htm" target="_blank">Get Values
                      for a Picklist Field</a> or <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm" target="_blank">Get Values
                      for All Picklist Fields of a Record Type</a>.
                  </li>

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

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">defaultValue</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">Default value for the field.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 66.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">66.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">defaultedOnCreate</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is automatically assigned a default value when a
                record is created.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 66.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">66.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">digits</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Integer</td>

              <td class="entry" headers="d110045e39" data-title="Description">For integer fields, the maximum number of digits that an integer can
                have.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 65.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">externalId</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">External ID of the field.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 60.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">extraTypeInfo</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">More data type information. One of these values:<a name="ExtraTypeInfo"><!-- --></a>
                <ul class="ul bulletList" id="ExtraTypeInfo">
                  <li class="li">
                    <samp class="codeph nolang">ExternalLookup</samp>—External lookup
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ImageUrl</samp>—Image url
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">IndirectLookup</samp>—Indirect lookup
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PersonName</samp>—Person name
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PlainTextArea</samp>—Plain text area
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RichTextArea</samp>—Rich text area
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SwitchablePersonName</samp>—Switchable person
                    name
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">filterable</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is filterable. If <samp class="codeph nolang">true</samp>, then this field can be specified in the <samp class="codeph nolang">WHERE</samp> clause of a SOQL statement.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">filteredLookupInfo</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_responses_filtered_lookup_info.htm" target="_blank">Filtered Lookup
                  Info</a></td>

              <td class="entry" headers="d110045e39" data-title="Description">If the field is a reference field type with a lookup filter, this value
                contains the lookup information.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">highScaleNumber</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field stores numbers to 8 decimal places regardless of
                what's specified in the field details.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">htmlFormatted</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is formatted for HTML and should be encoded for
                display in HTML. Also indicates whether a field is a custom formula field that has
                an IMAGE text function.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">inlineHelpText</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">The text that appears in the field-level help hover text.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">Text label that appears next to the field in the Salesforce user interface.
                This label may be localized.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">length</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Integer</td>

              <td class="entry" headers="d110045e39" data-title="Description">For string fields, the maximum number of Unicode characters.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">maskType</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">Mask type of the field.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 60.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">nameField</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is a name field.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">polymorphicForeignKey</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is a foreign key over a domain of multiple
                objects.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">precision</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Integer</td>

              <td class="entry" headers="d110045e39" data-title="Description">For double fields, indicates the maximum number of digits that can be stored,
                on both sides of the decimal point.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">reference</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is a foreign key to another record. <p class="p">A reference
                  field contains an ID value that points to a unique record (usually the parent
                  record) on another object.</p>
              </td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">referenceTargetField</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">For indirect lookup relationships on external objects, this property is the
                target custom field of the referenced object.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">referenceToInfos</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_responses_reference_to_info.htm" target="_blank">Reference to
                  Info</a>[]
              </td>

              <td class="entry" headers="d110045e39" data-title="Description">For fields that refer to other objects, this list includes information about
                the object types and name fields of the referenced objects.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">relationshipName</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">String</td>

              <td class="entry" headers="d110045e39" data-title="Description">The name of the relationship, if this relationship is a master-detail
                relationship field. </td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">required</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is required when creating or editing a record.<p class="p">To
                  determine which fields are required in a layout, use the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm" target="_blank"><samp class="codeph nolang">RecordLayoutItem.required</samp></a>
                  property.</p>
              </td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">scale</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Integer</td>

              <td class="entry" headers="d110045e39" data-title="Description">For double fields, indicates the number of digits to the right of the decimal
                point.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">searchPrefilterable</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description"><span class="ph" id="searchPrefilterable"><a name="searchPrefilterable"><!-- --></a>Indicates whether a foreign key (relationship
                  field) can be included in a SOSL <samp class="codeph soql">WHERE</samp>
                  clause.</span></td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Big, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">sortable</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field is sortable. If <samp class="codeph nolang">true</samp>, then this field can be specified in a SOQL <samp class="codeph nolang">ORDER BY</samp> clause.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">unique</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description"><span class="ph" id="unique"><a name="unique"><!-- --></a>Indicates whether a field’s value must be unique.</span></td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d110045e35" data-title="Property Name"><samp class="codeph nolang">updateable</samp></td>

              <td class="entry" headers="d110045e37" data-title="Type">Boolean</td>

              <td class="entry" headers="d110045e39" data-title="Description">Indicates whether the field can be edited.</td>

              <td class="entry" headers="d110045e41" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d110045e43" data-title="Available Version">41.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm "The metadata for an object.")

<!-- document id=c86c3dcc53f0d3fd9996e8c575e85fb260f651cc12d175bc11e49135a784a2c1 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_field_layout_component.md -->

# Field Layout Component

A field in a record layout.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | The API name of the field. | Small, 41.0 | 41.0 |
| componentType | String | The value is Field. | Small, 41.0 | 41.0 |
| label | String | The label of the field. | Small, 41.0 | 41.0 |

#### See Also

- [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.")

<!-- document id=c2071db27574bb639451f6d154c9c66e3b8e1b7c114dbbafff5e5d09b5f7e756 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_field_value.md -->

# Field Value

The raw and displayable field values for a field in a record.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d115275e28">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d115275e30">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d115275e32">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d115275e34">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d115275e36">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d115275e28" data-title="Property Name"><samp class="codeph nolang">displayValue</samp></td>
              <td class="entry" headers="d115275e30" data-title="Type">String</td>
              <td class="entry" headers="d115275e32" data-title="Description">The displayable value for a field.<p class="p">This field is non-null in these cases.</p>
                <ul class="ul bulletList">
                  <li class="li">The <samp class="codeph nolang">value</samp> property can be localized to
                    the context user’s language.</li>

                  <li class="li">The <samp class="codeph nolang">value</samp> property is a date or currency
                    that can be formatted for display. <p class="p">If the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field.htm" title="A field's metadata."><samp class="codeph javascript">dataType</samp></a> of a field is <samp class="codeph javascript"><span class="dataType">Date</span></samp> or <samp class="codeph javascript">DateTime</samp>, it uses the short format in this <a class="xref" href="https://help.salesforce.com/articleView?id=admin_supported_date_time_format.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">table</a>.</p>
                    <p class="p">If
                      the <samp class="codeph nolang">dataType</samp> of a field is <samp class="codeph nolang">Currency</samp>, it uses the format in this <a class="xref" href="https://help.salesforce.com/articleView?id=admin_supported_currencies.htm&amp;type=5&amp;language=en_US" target="_blank" title="HTML (New Window)">table</a>.</p>
                  </li>

                  <li class="li">The <samp class="codeph nolang">value</samp> property is a related
                    record.</li>

                </ul>
              </td>
              <td class="entry" headers="d115275e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d115275e36" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d115275e28" data-title="Property Name"><samp class="codeph nolang">value</samp></td>
              <td class="entry" headers="d115275e30" data-title="Type">Object</td>
              <td class="entry" headers="d115275e32" data-title="Description">The value of a field in its raw data form. <p class="p">If the field is a related record, the raw value
                  contains a nested <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record" title="The field data, API name, child relationship data, and record type information for a record.">Record</a>
                  response body.</p>
                <p class="p">If this value is <samp class="codeph nolang">null</samp>,
                  the <samp class="codeph nolang">displayValue</samp> is also <samp class="codeph nolang">null</samp>.</p>
                <p class="p">Date and time information is in ISO
                  8601 format.</p>
              </td>
              <td class="entry" headers="d115275e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d115275e36" data-title="Available Version">41.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm "The field data, API name, child relationship data, and record type information for a record.")
- [Record Template Clone](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_template_clone.htm "A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records.")
- [Record Template Create](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_template_create.htm "A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records.")

<!-- document id=63770b08646f69ba0c8fac7b6769455e79f35237de6f0899690f38906a148583 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_filtered_lookup_info.md -->

# Filtered Lookup Info

Metadata for a lookup filter.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| controllingFields | String\[\] | A collection of controlling fields when the lookup filter is dependent on the source object. | Small, 41.0 | 41.0 |
| dependent | Boolean | Indicates whether the lookup filter is dependent on the source object. | Small, 41.0 | 41.0 |
| optionalFilter | Boolean | Indicates whether the lookup filter is optional. | Small, 41.0 | 41.0 |

#### See Also

- [Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field.htm "A field's metadata.")

<!-- document id=e048b399b883225ee3ac7b8f5a0fe00240eabea78a9e9747bade48dd66d6649c url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_views_md_batch.md -->

# Get a Batch of List View Metadata

Get metadata for a batch of list views.

Resource

/ui-api/list-info/batch?ids=<id>

Available Version

55.0

HTTP Methods

GET

Example

This example gets metadata for a batch of list views by ID:

GET /services/data/v68.0/ui-api/list-info/batch?ids=00Bxx0000029Y0OEAU,00Bxx0000029Y0NEAU

This example gets metadata for a batch of list views by name:

GET /services/data/v68.0/ui-api/list-info/batch?names=Account.AllAccounts,Accounts,Account.NewLastWeek

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| ids | ID | A comma-delimited list of list view IDs. A list view ID starts with 00B, like 00Bxx0000029Y0NEAU | Either ids or names is required. | 55.0 |
| names | String | A comma-delimited list of list view names. A list view name starts with an entity name, a dot, and then the name of the list view, like Account.AllAccounts. | Either ids or names is required. | 55.0 |

Response Body

[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=fbfe4a5f97e3489835e76972234f10cc741e03d9d789be2960afb247b651fc25 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_object_info_batch.md -->

# Get a Batch of Object Metadata

Get metadata about specific objects. The response includes a batch of metadata describing fields, child relationships, record type, and theme. You can request up to 2,000 objects in an object metadata request.

Resource

/ui-api/object-info/batch/{objectApiNames}

objectApiNames—A comma-delimited list of up to 2,000 [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") objects.

Available Version

49.0

HTTP Method

GET

Response Body

[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=1f62b7a7a74c6ff347096b90586f9791eac886d188cd2a39b9c93abe7c224b42 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_records_batch.md -->

# Get a Batch of Records

Get data for a batch of records.

Resource

GET /ui-api/records/batch/{recordIds}

recordIds—A comma-delimited list of custom object and [supported object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") records.

Available Version

41.0

Example for GET

This example gets the Account.Name field and Account.Contacts child records for two accounts.

GET /ui-api/records/batch/001R0000003I6CeIAK,001R0000003I6CgIAK?
  fields=Account.Name&childRelationships=Account.Contacts

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d76682e105">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d76682e108">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d76682e111">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d76682e114">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d76682e117">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d76682e105" data-title="Parameter Name"><samp class="codeph nolang">childRelationships</samp></td>

                  <td class="entry" headers="d76682e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d76682e111" data-title="Description">A collection of child relationship names. The records with those child
                    relationship names are included in the response. Specify names in the format
                    <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">ChildRelationshipName</var></samp>
                    or <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">ChildRelationshipName</var>.<var class="keyword varname">FieldApiName</var></samp>.
                    For example, to specify the Contacts relationship on an Account, use <samp class="codeph nolang">Account.Contacts</samp>. You can get child
                    relationships one level deep.<p class="p">To get a relationship name, look in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info" title="The metadata for an object.">Object Info</a> response body.</p>
                  </td>

                  <td class="entry" headers="d76682e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d76682e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d76682e105" data-title="Parameter Name"><samp class="codeph nolang">includeFieldsInBody</samp></td>

                  <td class="entry" headers="d76682e108" data-title="Type">Boolean</td>

                  <td class="entry" headers="d76682e111" data-title="Description">Specifies whether to return a field that’s defined in the request body
                    but not in the layout. The default value is <samp class="codeph nolang">false</samp>. When set to <samp class="codeph nolang">true</samp>,
                    fields that are not in the layout are also included in the response
                    body.</td>

                  <td class="entry" headers="d76682e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d76682e117" data-title="Available Version">59.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d76682e105" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d76682e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d76682e111" data-title="Description">Specifies the fields to return. If this property is specified, the
                    response is a union of <samp class="codeph nolang">fields</samp> and <samp class="codeph nolang">optionalFields</samp>. <p class="p">If the context user doesn’t
                      have access to a field, or if the field doesn’t exist, an error is returned.
                    </p>
                    <p class="p">If you’re not sure whether the context user has access to a field and
                      you don’t want the request to fail if they don’t, use the <samp class="codeph nolang">optionalFields</samp> parameter.</p>
                    <p class="p">Specify
                      names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record.
                      There’s no limit to the number of fields you can specify.</p>
                    <p class="p">Child
                      relationship records don’t have layouts. To get more fields for these
                      records, specify them in the <samp class="codeph nolang">fields</samp>
                      parameter.</p>
                    <p class="p">To return a field whose type is <samp class="codeph nolang">base64</samp>, specify the field in the <samp class="codeph nolang">optionalFields</samp> parameter.</p>
                    <p class="p"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_and_polymorph_keys.htm" target="_blank">Polymorphic fields</a> aren't supported.
                      Including a polymorphic field in <samp class="codeph javascript">fields</samp> can result in an invalid field error.</p>
                  </td>

                  <td class="entry" headers="d76682e114" data-title="Required or Optional">In API versions 45.0 and later, either <samp class="codeph nolang">fields</samp>, <samp class="codeph nolang">optionalFields</samp>, or
                    <samp class="codeph nolang">layoutTypes</samp> is required.<p class="p">In earlier
                      API versions, either <samp class="codeph nolang">fields</samp> or <samp class="codeph nolang">layoutTypes</samp> is required.</p>
                    In all API
                    versions, to specify both <samp class="codeph nolang">fields</samp> and
                    <samp class="codeph nolang">layoutTypes</samp>, you must specify <samp class="codeph nolang">childRelationships</samp>.
                  </td>

                  <td class="entry" headers="d76682e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d76682e105" data-title="Parameter Name"><samp class="codeph nolang">layoutTypes</samp></td>

                  <td class="entry" headers="d76682e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d76682e111" data-title="Description">Specifies the fields to return. If this property is specified, the
                    response is a union of <samp class="codeph nolang">layoutTypes</samp>,
                    <samp class="codeph nolang">modes</samp>, and <samp class="codeph nolang">optionalFields</samp>.<p class="p">A collection containing any of these values:</p>
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Compact</samp>—Use this value to get a
                        layout that contains a record’s key fields.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Full</samp>—(Default) Use this value to
                        get a full layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d76682e114" data-title="Required or Optional">In API versions 45.0 and later, either <samp class="codeph nolang">fields</samp>, <samp class="codeph nolang">optionalFields</samp>, or
                    <samp class="codeph nolang">layoutTypes</samp> is required.<p class="p">In earlier
                      API versions, either <samp class="codeph nolang">fields</samp> or <samp class="codeph nolang">layoutTypes</samp> is required.</p>
                    In all API
                    versions, to specify both <samp class="codeph nolang">fields</samp> and
                    <samp class="codeph nolang">layoutTypes</samp>, you must specify <samp class="codeph nolang">childRelationships</samp>.
                  </td>

                  <td class="entry" headers="d76682e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d76682e105" data-title="Parameter Name"><samp class="codeph nolang">modes</samp></td>

                  <td class="entry" headers="d76682e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d76682e111" data-title="Description">The access mode for the record. This value determines which fields to get
                    from a layout. Layouts have different fields for create, edit, and view modes.
                    For example, formula fields are rendered in view mode, but not in create mode
                    because they’re calculated at run time, like formulas in a spreadsheet. A
                    collection containing any of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Create</samp>—Use this mode if you intend
                        to build UI that lets a user create a record. This mode is used by the
                        <samp class="codeph nolang">/ui-api/record-defaults/create/{apiName}</samp> resource.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Edit</samp>—Use this mode if you intend to
                        build UI that lets a user edit a record. This mode is used by the <samp class="codeph nolang">/ui-api/record-defaults/clone/{recordId}</samp>
                        resource.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">View</samp>—(Default) Use this mode to
                        build UI that displays a record.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d76682e114" data-title="Required or Optional">Optional if <samp class="codeph nolang">layoutTypes</samp> is
                    specified. If <samp class="codeph nolang">layoutTypes</samp> is not
                    specified, this parameter is ignored.</td>

                  <td class="entry" headers="d76682e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d76682e105" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d76682e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d76682e111" data-title="Description">A collection of optional field names. If a field is accessible to the
                    context user, it’s included in the response. If a field isn’t accessible to
                    the context user, it isn’t included in the response, but it doesn’t cause an
                    error. <p class="p">Specify names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record. There’s
                      no limit to the number of fields you can specify.</p>
                    <p class="p">To return a field
                      whose type is <samp class="codeph nolang">base64</samp>, specify the field
                      in the <samp class="codeph nolang">optionalFields</samp>
                      parameter.</p>
                  </td>

                  <td class="entry" headers="d76682e114" data-title="Required or Optional">In API versions 45.0 and later, either <samp class="codeph nolang">fields</samp>, <samp class="codeph nolang">optionalFields</samp>, or
                    <samp class="codeph nolang">layoutTypes</samp> is required.<p class="p">In earlier
                      API versions, <samp class="codeph nolang">optionalFields</samp> is
                      optional.</p>
                  </td>

                  <td class="entry" headers="d76682e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d76682e105" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d76682e108" data-title="Type">Integer</td>

                  <td class="entry" headers="d76682e111" data-title="Description"> The maximum number of child records to return on a page. </td>

                  <td class="entry" headers="d76682e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d76682e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d76682e105" data-title="Parameter Name"><samp class="codeph nolang">updateMru</samp></td>

                  <td class="entry" headers="d76682e108" data-title="Type">Boolean</td>

                  <td class="entry" headers="d76682e111" data-title="Description">To add to the most recently used (MRU) list view, set to <samp class="codeph nolang">true</samp>. The default value is <samp class="codeph nolang">false</samp>.</td>

                  <td class="entry" headers="d76682e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d76682e117" data-title="Available Version">47.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results.htm#ui_api_responses_batch_results "The results from a request to a batch resource. Results include information for each subrequest in the batch.")

#### See Also

- [Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Child Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_child_relationships.htm "User Interface API has several resources that include child records in their responses. If a record has many child relationships, a response can be huge and have a negative effect on performance. To get only the records you need, request records for specific child relationships and set the page size of the results.")
- [User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm "Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.")
- [Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results.htm "The results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=2e8fda96117891e49025efd893070e7d2a507784fe2a4294a2965b1df4b832b4 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_actions_batch_get.md -->

# Get a Batch of Related List Actions with a Request Body

Get the actions on a batch of related lists for a record. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.

Resources

/ui-api/actions/record/${recordIds}/related-list/batch

- recordIds—The 15 or 18 character ID of a record.

Available Version

57.0

HTTP Method

POST

Example

To get information about the actions for the Contacts and Opportunities related lists on an Account record page, use this request with parameters in a request body.

POST /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list/batch

{
  "relatedListsActionParameters":
  \[
    {
      "relatedListId": "Contacts",
      "apiNames": \[ "New" \],
      "retrievalMode": "All"
    },
    {
      "relatedListId": "Opportunities",
      "apiNames": \["New" \],
      "retrievalMode": "All"
    }
  \]
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| listRecordActionsQuery | [Action Related Lists Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_action_related_list_batch_input.htm "Get the actions on a batch of related lists for a record.") | The data for a batch of related list actions. | Optional | 57.0 |

Response Body

[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=57b40ec121b8aa16a502b458cc208805b1c507f57d53d73e8b38d64c27981d02 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_lists_batch.md -->

# Get a Batch of Related List Actions with URL Parameters

Get the actions on a batch of related lists for a record via URL parameters.

Resources

/ui-api/actions/record/${recordIds}/related-list/batch/${relatedListIds}

- recordIds—The 15 or 18 character ID of a record.
- relatedListIds—(Optional) A comma-delimited list of related list IDs. When this parameter isn’t specified, the request returns all related list actions for the specified record.

Available Version

50.0

HTTP Method

GET

Example

As an example, let’s say we have an Account record detail page with a record ID of 001R0000003IDlwIAG. The page has some related lists, including tasks and events. To get information about all the related list actions on this page, make this request.

GET /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list/batch

The request returns a list of related list actions on the page and the URLs of the request and subrequests.

{
  "actions" : {
    "001R0000003IDlwIAG" : {
      "actions" : \[ {
        "actionListContext" : "RelatedList",
        "actionTarget" : null,
        "actionTargetType" : "Invoke",
        "apiName" : "NewTask",
        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RelatedList:Phone:StandardButton:NewTask",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new\_task\_120.png",
        "id" : "0JVR00000000036OAA",
        "isMassAction" : "false",
        "label" : "New Task",
        "primaryColor" : "4BC076",
        "relatedListRecordId" : null,
        "relatedSourceObject" : "OpenActivities",
        "section" : "Page",
        "sourceObject" : "001R0000003IDlwIAG",
        "subtype" : null,
        "targetObject" : "Task",
        "targetUrl" : null,
        "type" : "StandardButton"
      }, {
        "actionListContext" : "RelatedList",
        "actionTarget" : null,
        "actionTargetType" : "Invoke",
        "apiName" : "NewEvent",
        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RelatedList:Phone:StandardButton:NewEvent",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new\_event\_120.png",
        "id" : "0JVR00000000037OAA",
        "isMassAction" : "false",
        "label" : "New Event",
        "primaryColor" : "EB7092",
        "relatedListRecordId" : null,
        "relatedSourceObject" : "OpenActivities",
        "section" : "Page",
        "sourceObject" : "001R0000003IDlwIAG",
        "subtype" : null,
        "targetObject" : "Event",
        "targetUrl" : null,
        "type" : "StandardButton"
      }

... Additional actions removed for brevity ...

\],
      "links" : \[ \],
      "url" : "/services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list"
    }
  },
  "url" : "/services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d92165e137">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d92165e140">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d92165e143">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d92165e146">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d92165e149">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d92165e137" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d92165e140" data-title="Type">String[]</td>

                  <td class="entry" headers="d92165e143" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d92165e146" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d92165e149" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d92165e137" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d92165e140" data-title="Type">String[]</td>

                  <td class="entry" headers="d92165e143" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d92165e146" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d92165e149" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d92165e137" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d92165e140" data-title="Type">String</td>

                  <td class="entry" headers="d92165e143" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d92165e146" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d92165e149" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d92165e137" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d92165e140" data-title="Type">String</td>

                  <td class="entry" headers="d92165e143" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d92165e146" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d92165e149" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d92165e137" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d92165e140" data-title="Type">String[]</td>

                  <td class="entry" headers="d92165e143" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d92165e146" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d92165e149" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=145addbf0540995edd762181b0cfa0bf93b388bc67b44603bdc7684877b9a0c0 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_info_batch.md -->

# Get a Batch of Related List Metadata

Returns metadata for a batch of related lists in a page layout.

Resource

/ui-api/related-list-info/batch/${parentObjectApiName}/${relatedListNames}

- parentObjectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- relatedListNames—Comma-separated IDs of supported related lists for that object.

Available Version

50.0

HTTP Method

GET

Example

To get information about the Contracts and Work Orders related lists for the Account object, make this request.

GET /services/data/v68.0/ui-api/related-list-info/batch/Account/Contracts,WorkOrders

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| recordTypeId | Id | The ID of the record type (RecordType object) for the record. If not provided, the default record type is used. | Optional | 50.0 |

Response Body

[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=ae009d5419d1b3f125ec3c1e0b4a14e692e8b02214b78a9422768a6cb585cd3b url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_count_batch.md -->

# Get a Batch of Related List Record Counts

Returns the record count for a batch of related lists.

Resource

/ui-api/related-list-count/batch/${parentRecordId}/${relatedListIds}

- parentRecordId—The ID of the record you want to get related lists for.
- relatedListIds—Comma-separated IDs of supported related lists for that object.

Available Version

50.0

HTTP Method

GET

Example

To get the number of records in the Contracts related list for the account 001RM000003UNu6YAG, make this request.

/services/data/v68.0/ui-api/related-list-count/batch/001RM000003UNu6YAG/Contracts,WorkOrders

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| maxCount | Integer | The maximum number of records to return. The default value is 20. | Optional | 50.0 |

Response Body

[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=59e8314fd2610b8814abac8f1db41b7c3cce94f3765996dd881dad0ba927c6ff url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_records_batch_get.md -->

# Get a Batch of Related List Records with a Request Body

Returns record data for a batch of related lists. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.

Resources

/ui-api/related-list-records/batch/${parentRecordId}

- parentRecordId—The ID of the record you want to get a batch of related lists for.

Available Version

55.0

HTTP Method

POST

Example

To get record data for the Contacts and Opportunities related lists for the account record 001xx000003GYOpAAO, use the following request.

POST /ui-api/related-list-records/batch/001xx000003GYOpAAO

{
    "relatedListParameters":
    \[
        {
            "relatedListId": "Contacts",
            "fields": \["Name", "Id", "Birthdate"\],
            "optionalFields": \["Email"\],
            "sortBy": \["CreatedDate"\],
            "pageSize": 10,
            "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}"
        },
        {
            "relatedListId": "Opportunities",
            "fields": \["Name", "Id"\],
            "optionalFields": \["Email"\],
            "sortBy": \["CreatedDate"\],
            "pageSize": 10,
            "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}"
        }
    \]
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| listRecordsQuery | [Related List Records Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_record_batch_input.htm "Get record data for a batch of related lists.") | The record data for a batch of related lists. | Required | 55.0 |

Response Body

[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=0c5420ee3264fc59712edd7c65355a5aa9c9eabe547baf2de9b33fd04f3659e2 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_records_batch.md -->

# Get a Batch of Related List Records with URL Parameters

Returns record data for a batch of related lists via URL parameters.

Resources

/ui-api/related-list-records/batch/${parentRecordId}/${relatedListIds}

- parentRecordId—The ID of the record you want to get related lists for.
- relatedListIds—Comma-separated IDs of supported related lists for the specified record.

Available Version

50.0

HTTP Method

GET

Example

To get metadata for the Contracts related list for the account record 001RM000003UNu6YAG, make this request:

/services/data/v68.0/ui-api/related-list-records/batch/001RM000003UNu6YAG/Contracts,WorkOrders

Request Parameters

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

#### Note

To get record data for a batch of related lists without using complex URL parameters, you can use the POST method and enter request parameters in the request body. See [Get a Batch of Related List Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_batch_get.htm "Returns record data for a batch of related lists. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.").

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d90566e140">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d90566e143">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d90566e146">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d90566e149">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d90566e152">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d90566e140" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d90566e143" data-title="Type">String[]</td>

                  <td class="entry" headers="d90566e146" data-title="Description"><span class="ph" id="fields_param_desc"><a name="fields_param_desc"><!-- --></a>Fields queried for the records returned. These
                      fields are included in the response body and don’t create visible columns.
                      If the field isn’t available to the user, an error occurs.</span></td>

                  <td class="entry" headers="d90566e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d90566e152" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d90566e140" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d90566e143" data-title="Type">String[]</td>

                  <td class="entry" headers="d90566e146" data-title="Description"><span class="ph" id="optionalFields_param_desc"><a name="optionalFields_param_desc"><!-- --></a>Additional fields queried for the
                      records returned. These fields are included in the response body and don’t
                      create visible columns. If the field isn’t available to the user, no error
                      occurs and the field isn’t included in the records.</span></td>

                  <td class="entry" headers="d90566e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d90566e152" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d90566e140" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d90566e143" data-title="Type">Integer</td>

                  <td class="entry" headers="d90566e146" data-title="Description"><span class="ph" id="pageSize_param_desc"><a name="pageSize_param_desc"><!-- --></a>The number of records from all lists in the
                      request viewed at one time. The default value is 50. Value can be
                      1–1999.</span></td>

                  <td class="entry" headers="d90566e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d90566e152" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d90566e140" data-title="Parameter Name"><samp class="codeph nolang">sortBy</samp></td>

                  <td class="entry" headers="d90566e143" data-title="Type">String[]</td>

                  <td class="entry" headers="d90566e146" data-title="Description">
                    <span class="ph" id="sortBy_param_desc"><a name="sortBy_param_desc"><!-- --></a>The API names of the fields the related list
                      is sorted by. If the name is preceded with <samp class="codeph nolang">-</samp>, the sort order is descending. For example, <samp class="codeph nolang">Name</samp> sorts by name in ascending order.
                      <samp class="codeph nolang">-CreatedDate</samp> sorts by created date in
                      descending order.</span>
                    <p class="p">In API version 63.0 and later, you can sort by up
                      to five fields. If a field is invalid or isn’t accessible to the context
                      user, this parameter is ignored, but no error occurs.</p>
                  </td>

                  <td class="entry" headers="d90566e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d90566e152" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d90566e140" data-title="Parameter Name"><samp class="codeph nolang">where</samp></td>

                  <td class="entry" headers="d90566e143" data-title="Type">String</td>

                  <td class="entry" headers="d90566e146" data-title="Description">
                    <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.uiapi.meta/uiapi/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p>The <samp class="codeph nolang">where</samp> parameter isn’t supported
                                for GET requests.</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>

                  </td>

                  <td class="entry" headers="d90566e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d90566e152" data-title="Available Version">55.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Simplified Batch Representation](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=5a591d1dfba23e6d84fd2a816b44c5919366fe4a39c0076885c69459819bbb23 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_preferences_batch_get.md -->

# Get a Batch of Related List User Preferences

Returns a batch of user preferences for a related list.

Resource

/ui-api/related-list-preferences/batch/${preferencesIds}

- preferencesIds—A comma-delimited set of related list user preference IDs, such as Account.RelatedContactList.

Available Version

57.0

HTTP Method

GET

Example

To get user preferences for the Contact and Opportunity related lists on an Account, make this request.

GET /services/data/v68.0/ui-api/related-list-preferences/batch/Account.RelatedContactList,Account.RelatedOpportunityList

Response Body

[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm "The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.")

<!-- document id=4ccd55f69ec2eec57596b38c871f5ea11c3e6a646b4fdd55d856ca325fc5a96f url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_object_info_directory.md -->

# Get a Directory of Supported Objects

Get a directory of objects that are [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") by User Interface API and accessible to the context user. The directory includes a /ui-api/object-info/{objectApiName} resource for each supported object.

Resource

/ui-api/object-info/

Available Version

42.0

HTTP Method

GET

Response Body

[Object Info Directory](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info_directory.htm#ui_api_responses_object_info_directory "A directory of objects that are supported by User Interface API and available to the context user.")

#### See Also

- [Get Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info.htm "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.")

<!-- document id=536055ed6469fd2c3a2b40ae8e3e03e96e8a6356baafd186f24f8e3f7c61e347 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorite_get.md -->

# Get a Favorite

Get a favorite.

Resource

/ui-api/favorites/${favoriteId}

favoriteId—The ID of a favorite.

Available Version

41.0

HTTP Method

GET

Response Body

[Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite.htm#ui_api_responses_favorite "A single favorite.")

<!-- document id=68a27e6a05d4e95ae920937dbc50c3ac7b35ccf82b6f80d4daf33a0ee435e808 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_quick_action_layout.md -->

# Get a Quick Action Layout

Get information about the record layout used by a Create a Record or Update a Record quick action.

Resource

/ui-api/actions/layout/${actionApiName}

actionApiName—The API name of a quick action.

Available Version

58.0

HTTP Method

GET

Example

This example returns information about the record layout used by the Create Case quick action on the Account object.

GET /services/data/v68.0/ui-api/actions/layout/Account.CreateCase

Request parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| objectApiName | String | API name of the object. | Optional | 60.0 |
| recordTypeId | String | ID of the record type. | Optional | 60.0 |

Response Body

[Quick Action Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_quick_action_layout.htm "The record layout used by the quick action.")

<!-- document id=be0f53061861963ebcff30c653f48e2954d6b8b9670389b79fa29f03d32aae6c url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_get.md -->

# Get a Record

Get a record’s data.

GET /ui-api/records/{recordId}

recordId—A custom object record or a [supported object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") record.

Available Version

41.0

Example for GET

This example gets the data for fields in the compact layout for an opportunity record with ID 006R0000001rboIIAQ. The response includes OpportunityCompetitors and Partners child records.

GET /ui-api/records/006R0000001rboIIAQ?layoutTypes=Compact&childRelationships=Opportunity.OpportunityCompetitors,Opportunity.Partners

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d71168e105">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d71168e108">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d71168e111">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d71168e114">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d71168e117">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d71168e105" data-title="Parameter Name"><samp class="codeph nolang">childRelationships</samp></td>

                  <td class="entry" headers="d71168e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d71168e111" data-title="Description">A collection of child relationship names. The records with those child
                    relationship names are included in the response. Specify names in the format
                    <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">ChildRelationshipName</var></samp>
                    or <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">ChildRelationshipName</var>.<var class="keyword varname">FieldApiName</var></samp>.
                    For example, to specify the Contacts relationship on an Account, use <samp class="codeph nolang">Account.Contacts</samp>. You can get child
                    relationships one level deep.<p class="p">To get a relationship name, look in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info" title="The metadata for an object.">Object Info</a> response body.</p>
                  </td>

                  <td class="entry" headers="d71168e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d71168e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d71168e105" data-title="Parameter Name"><samp class="codeph nolang">includeFieldsInBody</samp></td>

                  <td class="entry" headers="d71168e108" data-title="Type">Boolean</td>

                  <td class="entry" headers="d71168e111" data-title="Description">Specifies whether to return a field that’s defined in the request body
                    but not in the layout. The default value is <samp class="codeph nolang">false</samp>. When set to <samp class="codeph nolang">true</samp>,
                    fields that are not in the layout are also included in the response
                    body.</td>

                  <td class="entry" headers="d71168e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d71168e117" data-title="Available Version">59.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d71168e105" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d71168e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d71168e111" data-title="Description">Specifies the fields to return. If this property is specified, the
                    response is a union of <samp class="codeph nolang">fields</samp> and <samp class="codeph nolang">optionalFields</samp>. <p class="p">If the context user doesn’t
                      have access to a field, or if the field doesn’t exist, an error is returned.
                    </p>
                    <p class="p">If you’re not sure whether the context user has access to a field and
                      you don’t want the request to fail if they don’t, use the <samp class="codeph nolang">optionalFields</samp> parameter.</p>
                    <p class="p">Specify
                      names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record.
                      There’s no limit to the number of fields you can specify.</p>
                    <p class="p">Child
                      relationship records don’t have layouts. To get more fields for these
                      records, specify them in the <samp class="codeph nolang">fields</samp>
                      parameter.</p>
                    <p class="p">To return a field whose type is <samp class="codeph nolang">base64</samp>, specify the field in the <samp class="codeph nolang">optionalFields</samp> parameter.</p>
                    <div class="box message info" id="polymorphic">
                      <a name="polymorphic"><!-- --></a>
                      <div class="inner">
                        <div class="bd">
                          <div class="media">
                            <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_relationships_and_polymorph_keys.htm" target="_blank">Polymorphic fields</a> aren't supported.
                                Including a polymorphic field in <samp class="codeph javascript">fields</samp> can result in an invalid field error.</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>
                  </td>

                  <td class="entry" headers="d71168e114" data-title="Required or Optional">In API versions 45.0 and later, either <samp class="codeph nolang">fields</samp>, <samp class="codeph nolang">optionalFields</samp>, or
                    <samp class="codeph nolang">layoutTypes</samp> is required.<p class="p">In earlier
                      API versions, either <samp class="codeph nolang">fields</samp> or <samp class="codeph nolang">layoutTypes</samp> is required.</p>
                    In all API
                    versions, to specify both <samp class="codeph nolang">fields</samp> and
                    <samp class="codeph nolang">layoutTypes</samp>, you must specify <samp class="codeph nolang">childRelationships</samp>.
                  </td>

                  <td class="entry" headers="d71168e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d71168e105" data-title="Parameter Name"><samp class="codeph nolang">layoutTypes</samp></td>

                  <td class="entry" headers="d71168e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d71168e111" data-title="Description">Specifies the fields to return. If this property is specified, the
                    response is a union of <samp class="codeph nolang">layoutTypes</samp>,
                    <samp class="codeph nolang">modes</samp>, and <samp class="codeph nolang">optionalFields</samp>.<p class="p">A collection containing any of these values:</p>
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Compact</samp>—Use this value to get a
                        layout that contains a record’s key fields.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Full</samp>—(Default) Use this value to
                        get a full layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d71168e114" data-title="Required or Optional">In API versions 45.0 and later, either <samp class="codeph nolang">fields</samp>, <samp class="codeph nolang">optionalFields</samp>, or
                    <samp class="codeph nolang">layoutTypes</samp> is required.<p class="p">In earlier
                      API versions, either <samp class="codeph nolang">fields</samp> or <samp class="codeph nolang">layoutTypes</samp> is required.</p>
                    In all API
                    versions, to specify both <samp class="codeph nolang">fields</samp> and
                    <samp class="codeph nolang">layoutTypes</samp>, you must specify <samp class="codeph nolang">childRelationships</samp>.
                  </td>

                  <td class="entry" headers="d71168e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d71168e105" data-title="Parameter Name"><samp class="codeph nolang">modes</samp></td>

                  <td class="entry" headers="d71168e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d71168e111" data-title="Description">The access mode for the record. This value determines which fields to get
                    from a layout. Layouts have different fields for create, edit, and view modes.
                    For example, formula fields are rendered in view mode, but not in create mode
                    because they’re calculated at run time, like formulas in a spreadsheet. A
                    collection containing any of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Create</samp>—Use this mode if you intend
                        to build UI that lets a user create a record. This mode is used by the
                        <samp class="codeph nolang">/ui-api/record-defaults/create/{apiName}</samp> resource.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Edit</samp>—Use this mode if you intend to
                        build UI that lets a user edit a record. This mode is used by the <samp class="codeph nolang">/ui-api/record-defaults/clone/{recordId}</samp>
                        resource.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">View</samp>—(Default) Use this mode to
                        build UI that displays a record.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d71168e114" data-title="Required or Optional">Optional if <samp class="codeph nolang">layoutTypes</samp> is
                    specified. If <samp class="codeph nolang">layoutTypes</samp> is not
                    specified, this parameter is ignored.</td>

                  <td class="entry" headers="d71168e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d71168e105" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d71168e108" data-title="Type">String[]</td>

                  <td class="entry" headers="d71168e111" data-title="Description">A collection of optional field names. If a field is accessible to the
                    context user, it’s included in the response. If a field isn’t accessible to
                    the context user, it isn’t included in the response, but it doesn’t cause an
                    error. <p class="p">Specify names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record. There’s
                      no limit to the number of fields you can specify.</p>
                    <p class="p">To return a field
                      whose type is <samp class="codeph nolang">base64</samp>, specify the field
                      in the <samp class="codeph nolang">optionalFields</samp>
                      parameter.</p>
                  </td>

                  <td class="entry" headers="d71168e114" data-title="Required or Optional">In API versions 45.0 and later, either <samp class="codeph nolang">fields</samp>, <samp class="codeph nolang">optionalFields</samp>, or
                    <samp class="codeph nolang">layoutTypes</samp> is required.<p class="p">In earlier
                      API versions, <samp class="codeph nolang">optionalFields</samp> is
                      optional.</p>
                  </td>

                  <td class="entry" headers="d71168e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d71168e105" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d71168e108" data-title="Type">Integer</td>

                  <td class="entry" headers="d71168e111" data-title="Description"> The maximum number of child records to return on a page. </td>

                  <td class="entry" headers="d71168e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d71168e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d71168e105" data-title="Parameter Name"><samp class="codeph nolang">updateMru</samp></td>

                  <td class="entry" headers="d71168e108" data-title="Type">Boolean</td>

                  <td class="entry" headers="d71168e111" data-title="Description">To add to the most recently used (MRU) list view, set to <samp class="codeph nolang">true</samp>. The default value is <samp class="codeph nolang">false</samp>.</td>

                  <td class="entry" headers="d71168e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d71168e117" data-title="Available Version">47.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.")

#### See Also

- [Get Child Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_child_relationships.htm "User Interface API has several resources that include child records in their responses. If a record has many child relationships, a response can be huge and have a negative effect on performance. To get only the records you need, request records for specific child relationships and set the page size of the results.")

<!-- document id=2e14454dd8888989825d9009343346bb9cc16d60abb1f8e47ffa5c64d7b26dc4 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_themes_active.md -->

# Get Active Theme

Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection.

Resources

/ui-api/themes/active

Available Version

42.0

HTTP Methods

GET

Response Body

[Theme](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme.htm#ui_api_responses_theme "A set of images and banners that make up a theme. Banners display across the top of a page and have a higher aspect ratio than images.")

<!-- document id=0c08e9e12e549f2f82f31c3ba8582c98ee641c2f58a805d2935c97386e14d204 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_all_nav_items.md -->

# Get All Navigation Items

Gets all navigation items (tabs) that the user has access to.

Resource

/ui-api/nav-items

Available Version

45.0

HTTP Method

GET

Example

To get all navigation tabs for an app, make this request:

GET /services/data/v68.0/ui-api/nav-items?page=3&pageSize=2

The request returns metadata for all navigation tabs associated with this app.

{
  "currentPageUrl": "/services/data/v68.0/ui-api/nav-items?page=3&pageSize=2"
  "navItems": \[{
    "availableInClassic": true,
    "availableInLightning": true,
    "color": "EF7EAD",
    "content": "home\_\_desktopDefault",
    "custom": false,
    "developerName": "standard-home",
    "iconUrl": "https://yourInstance.salesforce.com/img/icon/t4v35/standard/home\_120.png",
    "id": null,
    "itemType": "Standard",
    "label": "Home",
    "objectApiName": "Home",
    "pageReference": {
      "attributes": {
        "pageName": "home"
      },
      "state": {},
      "type": "standard\_\_namedPage"
    },
    "standardType": "Home"
  }, {
    "availableInClassic": false,
    "availableInLightning": true,
    "color": "489DD0",
    "content": null,
    "custom": false,
    "developerName": "standard-Feed",
    "iconUrl": "https://yourInstance.salesforce.com/img/icon/t4v35/standard/feed\_120.png",
    "id": null,
    "itemType": "Standard",
    "label": "Chatter",
    "objectApiName": "Feed",
    "pageReference": {
      "attributes": {
        "pageName": "chatter"
      },
      "state": {},
      "type": "standard\_\_namedPage"
    },
    "standardType": "Feed"
  }\],
  "nextPageUrl": "/services/data/v68.0/ui-api/nav-items?page=4&pageSize=2"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d38079e128">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d38079e131">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d38079e134">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d38079e137">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d38079e140">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d38079e128" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d38079e131" data-title="Type">String</td>

                  <td class="entry" headers="d38079e134" data-title="Description">The response includes navigation items that support this form factor. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—Desktop display
                        size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Tablet display
                        size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Phone display
                        size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d38079e137" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d38079e140" data-title="Available Version">45.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d38079e128" data-title="Parameter Name"><samp class="codeph nolang">navItemNames</samp></td>

                  <td class="entry" headers="d38079e131" data-title="Type">String[]</td>

                  <td class="entry" headers="d38079e134" data-title="Description">A comma delimited list of <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_tabdefinition.htm" target="_blank" title="HTML (New Window)">TabDefinition</a>
                    name values to include in the response.</td>

                  <td class="entry" headers="d38079e137" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d38079e140" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d38079e128" data-title="Parameter Name"><samp class="codeph nolang">page</samp></td>

                  <td class="entry" headers="d38079e131" data-title="Type">Int</td>

                  <td class="entry" headers="d38079e134" data-title="Description">The page offset form which to begin returning nav items. The default
                    value is 0, which returns nav items from the first page. For example, for
                    <samp class="codeph nolang">page=2</samp> and <samp class="codeph nolang">pageSize=10</samp>, the first nav item returned is the 21st nav item in
                    the list.
                  </td>

                  <td class="entry" headers="d38079e137" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d38079e140" data-title="Available Version">45.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d38079e128" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d38079e131" data-title="Type">Int</td>

                  <td class="entry" headers="d38079e134" data-title="Description">The maximum number of nav items to return on a page. The default value is
                    25.</td>

                  <td class="entry" headers="d38079e137" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d38079e140" data-title="Available Version">45.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_items.htm "An ordered list of navigation items (tabs) for the current user.")

<!-- document id=21fb430a05174cf69e6338f1c8b2ded617a7e55f51d5ce1d09ada3de6f5b76bf url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_apps_id.md -->

# Get an App

Get the metadata for an app.

Resource

/ui-api/apps/${appId}

Available Version

43.0

HTTP Method

GET

Example

As an example, let’s say that the user has an app with an ID of 06mRM000000AFIrYAO. To get metadata for this app, make this request:

GET /services/data/v68.0/ui-api/apps/06mRM000000AFIrYAO?formFactor=Large

The request returns metadata for the app and its associated navigation tabs.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d39347e114">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d39347e117">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d39347e120">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d39347e123">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d39347e126">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d39347e114" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d39347e117" data-title="Type">String</td>

                  <td class="entry" headers="d39347e120" data-title="Description">The form factor for each app that the user has access to.<a name="form_factor_values_ul"><!-- --></a>
                    <ul class="ul bulletList" id="form_factor_values_ul">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—App supports the
                        desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—App supports the
                        tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—App supports the phone
                        display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d39347e123" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d39347e126" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d39347e114" data-title="Parameter Name"><samp class="codeph nolang">userCustomizations</samp></td>

                  <td class="entry" headers="d39347e117" data-title="Type">Boolean</td>

                  <td class="entry" headers="d39347e120" data-title="Description">If <samp class="codeph nolang">true</samp>, gets custom and standard
                    navigation tabs. If false, gets only standard navigation tabs.</td>

                  <td class="entry" headers="d39347e123" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d39347e126" data-title="Available Version">43.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_app.htm#ui_api_responses_app "The metadata for a single app.")

<!-- document id=de6ee43be92e81c132bc56e6a43843dd5da87754c035cee6cdd96f8253165c0b url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_apps.md -->

# Get Apps

Get metadata for all the apps a user has access to. Metadata for the selected app includes tabs on the app’s navigation bar. Metadata for other apps doesn’t include tabs on the navigation bar.

Resource

/ui-api/apps

Available Version

43.0

HTTP Method

GET

Example

As an example, let’s say that the user has access to three apps: Service, Marketing, and Bolt Solutions. To get metadata for all the apps, make this request:

GET /services/data/v68.0/ui-api/apps?formFactor=Large

The request returns metadata for the apps and their associated navigation tabs.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d38824e112">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d38824e115">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d38824e118">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d38824e121">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d38824e124">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d38824e112" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d38824e115" data-title="Type">String</td>

                  <td class="entry" headers="d38824e118" data-title="Description">The form factor for each app that the user has
                    access to.<a name="form_factor_values_ul"><!-- --></a>
                    <ul class="ul bulletList" id="form_factor_values_ul">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—App supports the
                        desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—App supports the
                        tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—App supports the phone
                        display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d38824e121" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d38824e124" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d38824e112" data-title="Parameter Name"><samp class="codeph nolang">userCustomizations</samp></td>

                  <td class="entry" headers="d38824e115" data-title="Type">Boolean</td>

                  <td class="entry" headers="d38824e118" data-title="Description">If <samp class="codeph nolang">true</samp>,
                    gets custom and standard navigation tabs. If false, gets only standard
                    navigation tabs.</td>

                  <td class="entry" headers="d38824e121" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d38824e124" data-title="Available Version">43.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_apps.htm#ui_api_responses_apps "A list of apps that the current user has access to.")

#### See Also

- [App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_app.htm "The metadata for a single app.")
- [Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_apps.htm "A list of apps that the current user has access to.")
- [Manage Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_apps.htm "An app is a collection of items that work together to serve a particular function. Salesforce apps come in two flavors: Classic apps and Lightning apps. Classic apps are created and managed in Salesforce Classic. Lightning apps are created and managed in Lightning Experience. Admins customize both types of apps to match the way users work.")

<!-- document id=2dfe644c9c0c08474c481be009fa67c4797e212e43516be5e4b03046332c169d url=/legacydeveloper/current/en-us/uiapi/ui_api_features_records_child_relationships.md -->

# Get Child Records

User Interface API has several resources that include child records in their responses. If a record has many child relationships, a response can be huge and have a negative effect on performance. To get only the records you need, request records for specific child relationships and set the page size of the results.

There are multiple resources that return child records. All of them share some common functionality.

Specify a Child Relationship

Specify child relationships in the format ObjectApiName.ChildRelationshipName. For example, to specify the Contacts relationship on an account, use Account.Contacts.

Specify spanning relationships in the format ObjectApiName.ChildRelationshipName.FieldApiName. For example, to specify the account billing address for an opportunity, use Opportunity.Account.BillingAddress.

Paginated Responses

The child relationships records in the response are paginated and include URLs to get the next page and previous pages of child records. Use the pageSize parameter to specify the number of records per page. The default is 5.

Responses Include One Level of Child Relationships

User Interface API gets the first set of child relationships that it finds, it doesn’t get the next level of child relationships. For example, this request gets the Opportunities on an Account record. If an opportunity in the response has a child relationship with another object, the API doesn’t return that information.

GET /ui-api/record-ui/001R0000003IG0vIAG?childRelationships=Account.Opportunities

In this shortened response body, you see the first set of child relationships on the Account record, which in this case is three Opportunity records. The records in the next level of child relationships—on the Opportunity object—don’t appear because it would make the response body too large.

...response shortened...
"records" : {
    "001RM000003TXRbYAO" : {
      "apiName" : "Account",
      **"childRelationships" : {**
        "Opportunities" : {
          **"count" : 3,**
          "currentPageUrl" : "/services/data/v41.0/ui-api/records/001RM000003TXRbYAO/child-relationships/Opportunities?
              fields=%5BOpportunity.Name%2C%20Opportunity.Id%5D&page=1&pageSize=5",
          "nextPageUrl" : null,
          "previousPageUrl" : null,
          "records" : \[ {
            "apiName" : "Opportunity",
            **"childRelationships" : { },**
            "fields" : {
              "AccountId" : {
                "displayValue" : null,
                "value" : "001RM000003TXRbYAO"
              },
              "Id" : {
                "displayValue" : null,
                "value" : "006RM000002XCGxYAO"
              },
              "Name" : {
                "displayValue" : null,
                "value" : "Acme - 1,200 Widgets"
              }
            },
            "id" : "006RM000002XCGxYAO",
            "recordTypeId" : "012000000000000000",
            "recordTypeInfo" : null
          },

## Resources That Return Child Records

Get Child Records for a Specific Record and Child Relationship

This example returns all the Contacts related to the Account record 001R0000003I6CoIAK.

/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts

The response is paginated. Use the pageSize parameter to specify the number of records per page. The default is 5.

{   
    "count" : 5,
    "currentPageUrl" :
    "/services/data/v41.0/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts?page=1&pageSize=5",
    "nextPageUrl" :
    "/services/data/v41.0/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts?page=2&pageSize=5",
    "previousPageUrl" : null,
    "records" : \[ {
        "apiName" : "Contact",
        "childRelationships" : { },
        "fields" : {
            "AccountId" : {
                "displayValue" : null,
                "value" : "001R0000003I6CoIAK"
            },
            "Id" : { 
                "displayValue" : null,
                "value" : "003R0000007qXwQIAU"
            },
            "Name" : { 
                "displayValue" : null,
                "value" : "John Smith"
            }
        },
        "id" : "003R0000007qXwQIAU",
        "recordTypeId" : "012000000000000000",
        "recordTypeInfo" : null
    },
    ...
}

Get a Record and Include Child Records

This example gets the data for fields in the compact layout for an opportunity record with ID 006R0000001rboIIAQ. The response includes OpportunityCompetitors and Partners child records.

GET /ui-api/records/006R0000001rboIIAQ?layoutTypes=Compact&childRelationships=Opportunity.OpportunityCompetitors,Opportunity.Partners

Get a Batch of Records and Include Child Records

This example gets the Account.Name field and Account.Contacts child records for two accounts.

GET /ui-api/records/batch/001R0000003I6CeIAK,001R0000003I6CgIAK?
  fields=Account.Name&childRelationships=Account.Contacts

Get Record Data and Metadata and Include Child Records

The response for this request includes layout information, metadata, and record data. The record data includes child relationship data for Contacts and Opportunities.

GET /ui-api/record-ui/001R0000003I6CoIAK?childRelationships=Account.Contacts,Account.Opportunities

#### See Also

- [User Interface API Sample Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_sample_apps.htm "We’ve built two sample apps that use User Interface API to create, read, update, and delete records. The apps are open-source and available on GitHub.")
- [Get Child Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_child_relationships.htm "Get child records for a specified record and child relationship name. Relationships are connections between records. On a record detail page, each record in a related list has a child relationship to the parent record.")
- [Get a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_get.htm "Get a record’s data.")
- [Get a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch.htm "Get data for a batch of records.")
- [Get Record Data and Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm "Get layout information, metadata, and data to build UI for a single record or for a collection of records.")

<!-- document id=20301a5478accbcb5da40f450b720eb548ded56fdbaa5c8a2b35de12541c30c2 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_child_relationships.md -->

# Get Child Records

Get child records for a specified record and child relationship name. Relationships are connections between records. On a record detail page, each record in a related list has a child relationship to the parent record.

Resource

/ui-api/records/${recordId}/child-relationships/${relationshipName}

recordId—The ID of the record for which you want to get child relationships.

relationshipName—The name of the child relationship. This value is returned in the [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.") response body and is usually the plural form of the object name.

Available Version

41.0

HTTP Method

GET

Example

This example returns all the Contacts related to the Account record 001R0000003I6CoIAK.

/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts

The response is paginated. Use the pageSize parameter to specify the number of records per page. The default is 5.

{   
    "count" : 5,
    "currentPageUrl" :
    "/services/data/v41.0/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts?page=1&pageSize=5",
    "nextPageUrl" :
    "/services/data/v41.0/ui-api/records/001R0000003I6CoIAK/child-relationships/Contacts?page=2&pageSize=5",
    "previousPageUrl" : null,
    "records" : \[ {
        "apiName" : "Contact",
        "childRelationships" : { },
        "fields" : {
            "AccountId" : {
                "displayValue" : null,
                "value" : "001R0000003I6CoIAK"
            },
            "Id" : { 
                "displayValue" : null,
                "value" : "003R0000007qXwQIAU"
            },
            "Name" : { 
                "displayValue" : null,
                "value" : "John Smith"
            }
        },
        "id" : "003R0000007qXwQIAU",
        "recordTypeId" : "012000000000000000",
        "recordTypeInfo" : null
    },
    ...
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d41498e130">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d41498e133">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d41498e136">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d41498e139">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d41498e142">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d41498e130" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d41498e133" data-title="Type">String[]</td>

                  <td class="entry" headers="d41498e136" data-title="Description">Specifies the fields to return. If this property is specified, the
                    response is a union of <samp class="codeph nolang">fields</samp> and <samp class="codeph nolang">optionalFields</samp>. <p class="p">If the context user doesn’t
                      have access to a field, or if the field doesn’t exist, an error is returned.
                    </p>
                    <p class="p">If you’re not sure whether the context user has access to a field and
                      you don’t want the request to fail if they don’t, use the <samp class="codeph nolang">optionalFields</samp> parameter.</p>
                    <p class="p">Specify names
                      in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record. There’s
                      no limit to the number of fields you can specify.</p>
                  </td>

                  <td class="entry" headers="d41498e139" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d41498e142" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d41498e130" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d41498e133" data-title="Type">String[]</td>

                  <td class="entry" headers="d41498e136" data-title="Description"> A collection of optional field names. If a field is accessible to the
                    context user, it’s included in the response. If a field isn’t accessible to
                    the context user, it isn’t included in the response, but it doesn’t cause an
                    error. <p class="p">Specify names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record. There’s
                      no limit to the number of fields you can specify.</p>
                  </td>

                  <td class="entry" headers="d41498e139" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d41498e142" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d41498e130" data-title="Parameter Name"><samp class="codeph nolang">page</samp></td>

                  <td class="entry" headers="d41498e133" data-title="Type">Int</td>

                  <td class="entry" headers="d41498e136" data-title="Description">The page offset from which to begin returning records. The default value
                    is 0, which returns records from the first page. For example, for <samp class="codeph nolang">page=2</samp> and <samp class="codeph nolang">pageSize=10</samp>, the first record returned is the 21st record in the
                    list. </td>

                  <td class="entry" headers="d41498e139" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d41498e142" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d41498e130" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d41498e133" data-title="Type">Int</td>

                  <td class="entry" headers="d41498e136" data-title="Description">The maximum number of child records to return on a page. The default
                    value is 5.</td>

                  <td class="entry" headers="d41498e139" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d41498e142" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d41498e130" data-title="Parameter Name"><samp class="codeph nolang">pageToken</samp></td>

                  <td class="entry" headers="d41498e133" data-title="Type">String</td>

                  <td class="entry" headers="d41498e136" data-title="Description">A token that represents the page offset.</td>

                  <td class="entry" headers="d41498e139" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d41498e142" data-title="Available Version">44.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_collection.htm#ui_api_responses_record_collection "A paginated collection of Record response bodies.")

#### See Also

- [Get Child Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_child_relationships.htm "User Interface API has several resources that include child records in their responses. If a record has many child relationships, a response can be huge and have a negative effect on performance. To get only the records you need, request records for specific child relationships and set the page size of the results.")

<!-- document id=c97badf413a56c16c1cc9e2d2e82e6cb4bbd3a0c87f0c7a64750211cd02f06dd url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_defaults_clone.md -->

# Get Default Values to Clone a Record

Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.

The response contains the default field values for a record cloned from the record specified in {recordId}, optionally of the specified recordTypeId.

It also contains the corresponding layout information for edit mode. In the Salesforce user interface, an admin with “Customize Application” permission can mark a field as required in a layout. When you’re building UI, to determine which fields to mark as required in a layout for edit mode, use the [RecordLayoutItem.required](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.") property.

The response contains object metadata for the object type of the record specified in {recordId} and for any nested objects. For example, this request clones an Account record. It returns object metadata for Account and User, because the OwnerId field on the Account object contains a reference to the User object.

/ui-api/record-defaults/clone/001d000000AtfRIAAZ

Resource

/ui-api/record-defaults/clone/{recordId}

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

#### Note

To get default values with a lightweight response, use the [/ui-api/record-defaults/template/clone/{recordId}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_template_clone.htm "Get the default values for fields for cloning a record. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.") resource.

Available Version

41.0

HTTP Method

GET

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d68677e146">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d68677e149">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d68677e152">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d68677e155">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d68677e158">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d68677e146" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d68677e149" data-title="Type">String</td>

                  <td class="entry" headers="d68677e152" data-title="Description">The layout display size for the record. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d68677e155" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d68677e158" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d68677e146" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d68677e149" data-title="Type">String[]</td>

                  <td class="entry" headers="d68677e152" data-title="Description">A collection of optional field names. If a field is accessible to the
                    context user, it’s included in the response. If a field isn’t accessible to
                    the context user, it isn’t included in the response, but it doesn’t cause an
                    error. <p class="p">Specify names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record. There’s
                      no limit to the number of fields you can specify.</p>
                  </td>

                  <td class="entry" headers="d68677e155" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d68677e158" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d68677e146" data-title="Parameter Name"><samp class="codeph nolang">recordTypeId</samp></td>

                  <td class="entry" headers="d68677e149" data-title="Type">Id</td>

                  <td class="entry" headers="d68677e152" data-title="Description">The ID of the record type (RecordType object) for the new record. If not
                    provided, the default record type is used.</td>

                  <td class="entry" headers="d68677e155" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d68677e158" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record Defaults](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults.htm#ui_api_responses_record_defaults "The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records.")

#### See Also

- [User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm "Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.")

<!-- document id=ec91ab50d9e8fb897ddc5814ed6812c950ef62f8dd573b8d6017616a663e2e62 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_defaults_template_clone.md -->

# Get Default Values to Clone a Record—Lightweight

Get the default values for fields for cloning a record. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.

The response contains the default field values for the specified fields, optionally of the specified recordTypeId.

The response also contains object metadata for fields specified in the request. For example, this request clones an Account record. It returns object metadata for Account and User, because the OwnerId field on the Account object contains a reference to the User object.

GET /ui-api/record-defaults/template/clone/001d000000AtfRIAAZ?optionalFields=Account.OwnerId

Resource

/ui-api/record-defaults/template/clone/{recordId}

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

#### Note

To get default values based on a layout, use the [/ui-api/record-defaults/clone/{recordId}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.") resource.

Available Version

49.0

HTTP Method

GET

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d70079e129">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d70079e132">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d70079e135">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d70079e138">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d70079e141">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d70079e129" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d70079e132" data-title="Type">String[]</td>

                  <td class="entry" headers="d70079e135" data-title="Description">A collection of optional field names. If a field is accessible to the
                    context user, it’s included in the response. If a field isn’t accessible to
                    the context user, it isn’t included in the response, but it doesn’t cause an
                    error. <p class="p">Specify names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record. There’s
                      no limit to the number of fields you can specify.</p>
                    <p class="p">If you don’t pass
                      any fields, the response includes only the ID of the cloned record in a
                      field called <samp class="codeph nolang">CloneSourceId</samp>.</p>
                  </td>

                  <td class="entry" headers="d70079e138" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d70079e141" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d70079e129" data-title="Parameter Name"><samp class="codeph nolang">recordTypeId</samp></td>

                  <td class="entry" headers="d70079e132" data-title="Type">Id</td>

                  <td class="entry" headers="d70079e135" data-title="Description">The ID of the record type (RecordType object) for the new record. If not
                    provided, the default record type is used.</td>

                  <td class="entry" headers="d70079e138" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d70079e141" data-title="Available Version">49.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record Defaults Template Clone](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults_template_clone.htm "A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records.")

<!-- document id=287814f6899d1b6ac308d02fb1a314d40c623a2ce7ab04224da5ffdb2fe0b54d url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_defaults_create.md -->

# Get Default Values to Create a Record

Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.

The response contains the default field values for the Full layout type for a new record of the object type specified in {objectApiName}.

It also contains the corresponding layout for create mode. In the Salesforce user interface, an admin with “Customize Application” permission can mark a field as required in a layout. When you’re building UI, to determine which fields to mark as required in a layout for create mode, use the [RecordLayoutItem.required](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.") property.

The response contains object metadata for the object specified in {objectApiName} and for any nested objects. For example, this request returns object metadata for Account and User, because the OwnerId field on the Account object contains a reference to the User object.

/ui-api/record-defaults/create/Account

Resource

/ui-api/record-defaults/create/{objectApiName}

- objectApiName—The API name of the object type for the new record.

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

#### Note

To get default values with a more lightweight response, use the [/ui-api/record-defaults/template/create/{objectApiName}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_template_create.htm "Get the default values for fields for a new record of a specified object and optional record type. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.") resource.

Available Version

41.0

HTTP Method

GET

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d69369e157">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d69369e160">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d69369e163">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d69369e166">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d69369e169">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d69369e157" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d69369e160" data-title="Type">String</td>

                  <td class="entry" headers="d69369e163" data-title="Description">The layout display size for the record. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d69369e166" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d69369e169" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d69369e157" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d69369e160" data-title="Type">String[]</td>

                  <td class="entry" headers="d69369e163" data-title="Description">A collection of optional field names. If a field is accessible to the
                    context user, it’s included in the response. If a field isn’t accessible to
                    the context user, it isn’t included in the response, but it doesn’t cause an
                    error. <p class="p">Specify names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record. There’s
                      no limit to the number of fields you can specify.</p>
                  </td>

                  <td class="entry" headers="d69369e166" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d69369e169" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d69369e157" data-title="Parameter Name"><samp class="codeph nolang">recordTypeId</samp></td>

                  <td class="entry" headers="d69369e160" data-title="Type">Id</td>

                  <td class="entry" headers="d69369e163" data-title="Description">The ID of the record type (RecordType object) for the new record. If not
                    provided, the default record type is used.</td>

                  <td class="entry" headers="d69369e166" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d69369e169" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record Defaults](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults.htm#ui_api_responses_record_defaults "The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records.")

#### See Also

- [User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm "Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.")

<!-- document id=6b8b776df1b61cff033401883ac6486cc131fc5c2c8527ff6f1063712fff486c url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_defaults_template_create.md -->

# Get Default Values to Create a Record—Lightweight

Get the default values for fields for a new record of a specified object and optional record type. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.

The response contains object metadata for specified fields. For example, this request returns object metadata for Account and User, because the OwnerId field on the Account object contains a reference to the User object.

GET /ui-api/record-defaults/template/create/Account?optionalFields=Account.OwnerId

Resource

/ui-api/record-defaults/template/create/{objectApiName}

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

#### Note

To get default values based on a layout, use the [/ui-api/record-defaults/create/{objectApiName}](# "Get the default values for fields for a new record of a specified object and optional record type. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.") resource.

- objectApiName—The API name of the object type for the new record.

Available Version

49.0

HTTP Method

GET

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d70575e133">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d70575e136">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d70575e139">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d70575e142">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d70575e145">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d70575e133" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d70575e136" data-title="Type">String[]</td>

                  <td class="entry" headers="d70575e139" data-title="Description">A collection of optional field names. If a field is accessible to the
                    context user, it’s included in the response. If a field isn’t accessible to
                    the context user, it isn’t included in the response, but it doesn’t cause an
                    error. <p class="p">Specify names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record.
                      There’s no limit to the number of fields you can specify.</p>
                    <p class="p">If
                      you don’t pass any fields, the response doesn’t include any
                      fields.</p>
                  </td>

                  <td class="entry" headers="d70575e142" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d70575e145" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d70575e133" data-title="Parameter Name"><samp class="codeph nolang">recordTypeId</samp></td>

                  <td class="entry" headers="d70575e136" data-title="Type">Id</td>

                  <td class="entry" headers="d70575e139" data-title="Description">The ID of the record type (RecordType object) for the new record. If not
                    provided, the default record type is used.</td>

                  <td class="entry" headers="d70575e142" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d70575e145" data-title="Available Version">49.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record Defaults Template Create](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults_template_create.htm "A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records.")

<!-- document id=297f911b883ae754701a39e1d91709bfb503fd15a08f1727ed3cf3d4e7724358 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_duplicates_get.md -->

# Get Duplicate Management Configuration for a Specified Object

Learn whether duplicate management is configured for the specified object. If duplicate management is configured, learn about the object's duplicate rules and matching rules. Use the information in the response to know when to check for duplicate records.

Resource

/ui-api/duplicates/{objectApiName}

objectApiName—The API name of a [supported object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.").

Available Version

50.0

HTTP Method

GET

Example

Use the following request to learn what duplicate management is configured for the custom object Movie.

/ui-api/duplicates/Movie\_\_c

The response tells you that duplicate management is configured, and that the fields Name and Year are used to check for duplicates.

// duplicate rules and matching rules are configured for Movie
dedupeEnabled: true

// these fields are used to check for duplicate records
dedupeFields
0: Name
1: Year\_\_c
...

From the preceding response, you know to check the Name and Year fields when adding or updating a Movie record. For example, you can check if a movie with the name "Aliens" and the release year "1986" already exists.

ui-api/predupe{
"apiName" : "Movie\_\_c",
"fields" :
{"Name": "Aliens",
  "Year\_\_c": "1986"
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| recordTypeId | String | The record type ID (RecordType object) used to return the correct duplicate configuration. This field is optional, except for the Person Account object. If you’re searching for duplicate Person Account records, you must specify the Person Account record type ID here. | Optional | 52.0 |

Response Body

[Duplicates Configuration](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicates_configuration.htm "Contains information about duplicate management configuration for an object. Learn whether duplicate management is configured, which fields are used to determine whether duplicate records exist, and which duplicate rules are active.")

#### See Also

- [Check for Duplicate Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_predupe_create.htm "Before updating or creating a record, you can check whether a duplicate record exists. Use the response to learn whether to block or allow the action, and whether to warn the user.")

<!-- document id=5cbe88281f94b7656709561e865679ab840367907b600ac5a29952e7db42f24b url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorites_get.md -->

# Get Favorites

Get all of a user’s favorites.

Resource

/ui-api/favorites

Available Version

41.0

HTTP Method

GET

Response Body

[Favorite Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite_collection.htm#ui_api_responses_favorite_collection "A list of favorites.")

<!-- document id=9c8db9095c2f179ac0969b3b0db9303813ddc42a595d82cf32870d64725eb260 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_global.md -->

# Get Global Actions

Get the actions in the Global Actions menu.

Resource

/ui-api/actions/global

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have a **New Opportunity** global action, among other actions. To get information about global actions, make this request:

GET /services/data/v68.0/ui-api/actions/global

The request returns a list of global actions, including **New Opportunity**, and the URLs of the request and subrequests.

{
  "actions" : {
    "001R0000003IDlwIAG" : {
        "actionListContext" : "Global",
        "actionTarget" : "/services/data/v41.0/quickActions/NewOpportunity/describe",
        "actionTargetType" : "Describe",
        "apiName" : "NewOpportunity",
        "externalId" : "00DR00000008n7M:Global::Global:Phone:09DR00000000Snl",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new\_opportunity\_120.png",
        "id" : "0JVR00000000030OAA",
        "isMassAction" : "false",
        "label" : "New Opportunity",
        "primaryColor" : "FCB95B",
        "relatedListRecordId" : null,
        "relatedSourceObject" : null,
        "section" : "Page",
        "sourceObject" : "Global",
        "subtype" : "Create",
        "targetObject" : "Opportunity",
        "targetUrl" : null,
        "type" : "QuickAction"
      }

... Additional actions removed for brevity ...

\],
      "links" : \[ \],
      "url" : "/services/data/v41.0/ui-api/actions/global"
    }
  },
  "url" : "/services/data/v41.0/ui-api/actions/global"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d45894e121">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d45894e124">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d45894e127">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d45894e130">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d45894e133">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d45894e121" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d45894e124" data-title="Type">String[]</td>

                  <td class="entry" headers="d45894e127" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d45894e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d45894e133" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d45894e121" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d45894e124" data-title="Type">String[]</td>

                  <td class="entry" headers="d45894e127" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d45894e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d45894e133" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d45894e121" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d45894e124" data-title="Type">String</td>

                  <td class="entry" headers="d45894e127" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d45894e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d45894e133" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d45894e121" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d45894e124" data-title="Type">String</td>

                  <td class="entry" headers="d45894e127" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d45894e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d45894e133" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d45894e121" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d45894e124" data-title="Type">String[]</td>

                  <td class="entry" headers="d45894e127" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d45894e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d45894e133" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

<!-- document id=166b888b45ce04693b18d94d207f06c8dcf04ec976490a00c8169a4b8c62df00 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_apps_selected.md -->

# Get Last Selected App

Retrieves the app the current user last selected or the app the user sees by default.

Resource

/ui-api/apps/selected

Available Version

43.0

HTTP Method

GET

Example

To get metadata for the last selected app, make this request:

GET /services/data/v68.0/ui-api/apps/selected?formFactor=Large

The request returns metadata for the app and its associated navigation items.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d40292e111">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d40292e114">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d40292e117">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d40292e120">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d40292e123">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d40292e111" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d40292e114" data-title="Type">String</td>

                  <td class="entry" headers="d40292e117" data-title="Description">The form factor for each app that the user has access to.<a name="form_factor_values_ul"><!-- --></a>
                    <ul class="ul bulletList" id="form_factor_values_ul">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—App supports the
                        desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—App supports the
                        tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—App supports the phone
                        display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d40292e120" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d40292e123" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d40292e111" data-title="Parameter Name"><samp class="codeph nolang">userCustomizations</samp></td>

                  <td class="entry" headers="d40292e114" data-title="Type">Boolean</td>

                  <td class="entry" headers="d40292e117" data-title="Description">If <samp class="codeph nolang">true</samp>, gets custom and standard
                    navigation tabs. If false, gets only standard navigation tabs.</td>

                  <td class="entry" headers="d40292e120" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d40292e123" data-title="Available Version">43.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_app.htm "The metadata for a single app.")

<!-- document id=19695e3543aa0e0ebdaf134fca6404ef6d9d98fe7ce5188a0ff96c7df4e2c55f url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_flexipage.md -->

# Get Lightning Page Actions

Get the actions on Lightning pages (FlexiPages).

Resource

/ui-api/actions/flexipage/${flexipageNames}

flexipageNames—A Lightning page name, or a comma-delimited list of Lightning page names.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have a Lightning page named MyNewLightningPage. The page has quick actions for logging a call and creating an account. To get information about all the actions on this page, make this request:

GET /services/data/v68.0/ui-api/actions/flexipage/MyNewLightningPage

The request returns a list of actions on the Lightning page and the URLs of the request and subrequests.

{
  "actions" : {
    "MyNewLightningPage" : {
      "actions" : \[ {
        "actionListContext" : "Flexipage",
        "actionTarget" : "/services/data/v41.0/quickActions/LogACall/describe",
        "actionTargetType" : "Describe",
        "apiName" : "LogACall",
        "externalId" : "00DR00000008n7M:MyNewLightningPage::Flexipage:Desktop:09DR00000000Snt",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/log\_a\_call\_120.png",
        "id" : "0JVR00000000009OAA",
        "isMassAction" : "false",
        "label" : "Log a Call",
        "primaryColor" : "48C3CC",
        "relatedListRecordId" : null,
        "relatedSourceObject" : null,
        "section" : null,
        "sourceObject" : "MyNewLightningPage",
        "subtype" : "LogACall",
        "targetObject" : "Task",
        "targetUrl" : null,
        "type" : "QuickAction"
      }, {
        "actionListContext" : "Flexipage",
        "actionTarget" : "/services/data/v41.0/quickActions/NewAccount/describe",
        "actionTargetType" : "Describe",
        "apiName" : "NewAccount",
        "externalId" : "00DR00000008n7M:MyNewLightningPage::Flexipage:Desktop:09DR00000000Sni",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new\_account\_120.png",
        "id" : "0JVR00000000010OAA",
        "isMassAction" : "false",
        "label" : "New Account",
        "primaryColor" : "7F8DE1",
        "relatedListRecordId" : null,
        "relatedSourceObject" : null,
        "section" : null,
        "sourceObject" : "MyNewLightningPage",
        "subtype" : "Create",
        "targetObject" : "Account",
        "targetUrl" : null,
        "type" : "QuickAction"
      } \],
      "links" : \[ \],
      "url" : "/services/data/v41.0/ui-api/actions/flexipage/MyNewLightningPage"
    }
  },
  "url" : "/services/data/v41.0/ui-api/actions/flexipage/MyNewLightningPage"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d44912e123">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d44912e126">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d44912e129">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d44912e132">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d44912e135">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d44912e123" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d44912e126" data-title="Type">String[]</td>

                  <td class="entry" headers="d44912e129" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d44912e132" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d44912e135" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d44912e123" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d44912e126" data-title="Type">String[]</td>

                  <td class="entry" headers="d44912e129" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d44912e132" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d44912e135" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d44912e123" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d44912e126" data-title="Type">String</td>

                  <td class="entry" headers="d44912e129" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d44912e132" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d44912e135" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d44912e123" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d44912e126" data-title="Type">String</td>

                  <td class="entry" headers="d44912e129" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d44912e132" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d44912e135" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d44912e123" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d44912e126" data-title="Type">String[]</td>

                  <td class="entry" headers="d44912e129" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d44912e132" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d44912e135" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

<!-- document id=cc757b72f2b33efd9f805625e9ee6c7fe81a372a7bd624f77a045fd6ae0c7955 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_view_chart.md -->

# Get List View Chart Actions

Get the chart actions on list views.

Resource

/ui-api/actions/list-view-chart/${objectApiName}

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

#### Note

Currently, only ListViewChartInstance is valid for ${objectApiName}.

Available Version

41.0

HTTP Method

GET

Example

This example gets the chart actions on a list view.

GET /services/data/v68.0/ui-api/actions/list-view-chart/ListViewChartInstance

The request returns a list of chart actions on the list view and the URLs of the request and subrequests.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d48382e121">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d48382e124">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d48382e127">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d48382e130">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d48382e133">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d48382e121" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d48382e124" data-title="Type">String[]</td>

                  <td class="entry" headers="d48382e127" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d48382e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d48382e133" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d48382e121" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d48382e124" data-title="Type">String[]</td>

                  <td class="entry" headers="d48382e127" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d48382e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d48382e133" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d48382e121" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d48382e124" data-title="Type">String</td>

                  <td class="entry" headers="d48382e127" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d48382e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d48382e133" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d48382e121" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d48382e124" data-title="Type">String</td>

                  <td class="entry" headers="d48382e127" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d48382e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d48382e133" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d48382e121" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d48382e124" data-title="Type">String[]</td>

                  <td class="entry" headers="d48382e127" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d48382e130" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d48382e133" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm "The actions for a single record or a collection of records.")

<!-- document id=58effd456f824d4821bffadbfe09e762176c8dcae99b9d4211e1415529ad8bf1 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_view.md -->

# Get List View Header Actions

Get the header actions on list views.

Resource

/ui-api/actions/list-view/${listViewIds}

listViewIds—A single list view ID, or a comma-delimited list of list view IDs.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have an Accounts list view with an ID of 00BR0000000WYY9MAO. This list view has Sort and New header actions, among other actions. To get information about the header actions on this list view, make this request:

GET /services/data/v68.0ui-api/actions/list-view/00BR0000000WYY9MAO

The request returns a list of header actions on the list view and the URLs of the request and subrequests.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d47406e120">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d47406e123">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d47406e126">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d47406e129">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d47406e132">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d47406e120" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d47406e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d47406e126" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d47406e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d47406e132" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d47406e120" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d47406e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d47406e126" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d47406e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d47406e132" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d47406e120" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d47406e123" data-title="Type">String</td>

                  <td class="entry" headers="d47406e126" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d47406e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d47406e132" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d47406e120" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d47406e123" data-title="Type">String</td>

                  <td class="entry" headers="d47406e126" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d47406e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d47406e132" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d47406e120" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d47406e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d47406e126" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d47406e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d47406e132" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm "The actions for a single record or a collection of records.")

<!-- document id=375068538174b5556f69b6cfad09dccb13bfe8963e08cafa1e961033b8693d38 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_views_md.md -->

# Get List View Metadata

Get list view metadata.

Resource

/ui-api/list-info/${listViewId}

/ui-api/list-info/${objectApiName}/${listViewApiName}

- listViewId—The ID of a list view, such as 00BR0000000Wc0rMAC.
- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- listViewApiName—The API name of a list view, such as AllAccounts, \_\_Recent, or \_\_SearchResult.

Available Version

42.0

HTTP Method

GET

Example

As an example, let’s say we have a list view named All Accounts with a list view ID of 00BR0000000Wc0rMAC. To get information about the metadata for this list view, make this request:

GET /services/data/v68.0/ui-api/list-info/00BR0000000Wc0rMAC

You can also use the object API name and list view API name of the list view to make the same request:

GET /services/data/v68.0/ui-api/list-info/Account/AllAccounts

To get the most recently used (MRU) list view metadata for accounts, use the special \_\_Recent list view API name.

GET /services/data/v68.0/ui-api/list-info/Account/\_\_Recent

To get the search layout list view metadata for accounts, use the special \_\_SearchResult list view API name.

GET /services/data/v68.0/ui-api/list-info/Account/\_\_SearchResult

Response Body

[List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")

<!-- document id=5032f4254a3529616a27794a47e15c41b0701ed26179cc4bb6872a911e2d3aec url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_preferences_get.md -->

# Get List View Preferences

Get list view preferences.

Resource

/ui-api/list-preferences/${objectApiName}/${listViewApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- listViewApiName—The API name of a list view, such as AllAccounts.

Available version

61.0

HTTP methods

GET

Example

This example gets list preferences for the All Accounts list view.

GET /services/data/v68.0/ui-api/list-preferences/Account/AllAccounts

Response body for GET

[List Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_preferences.htm "List preferences.")

<!-- document id=f011b710ab2a944b9649584ce5aa19e3691b552f83fe4ec9bbbec03d107db5a9 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_view_record.md -->

# Get List View Record Actions

Get the record actions on list views.

Resource

/ui-api/actions/list-view-record/${recordIds}

recordIds—A single record ID, or a comma-delimited list of record IDs.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have an Account lists view containing several Account records. Each Account record has an Edit and Delete record action. In Lightning, these actions display in a drop-down list for each record. To get information about the actions on a particular record with an ID of 001R0000003IDlwIAG, make this request:

GET /services/data/v68.0/ui-api/actions/list-view-record/001R0000003IDlwIAG

The request returns a list of the record actions for the record and the URLs of the request and subrequests.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d49359e120">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d49359e123">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d49359e126">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d49359e129">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d49359e132">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d49359e120" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d49359e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d49359e126" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d49359e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d49359e132" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d49359e120" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d49359e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d49359e126" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d49359e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d49359e132" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d49359e120" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d49359e123" data-title="Type">String</td>

                  <td class="entry" headers="d49359e126" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d49359e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d49359e132" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d49359e120" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d49359e123" data-title="Type">String</td>

                  <td class="entry" headers="d49359e126" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d49359e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d49359e132" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d49359e120" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d49359e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d49359e126" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d49359e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d49359e132" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm "The actions for a single record or a collection of records.")

<!-- document id=c9f53748b62d6d954aaf4fba0032366fa772eb4d999f9f700c8166535d8347ab url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_views_records_md.md -->

# Get List View Records and Metadata (Deprecated)

Get record data and metadata for a list view.

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

#### Note

This resource is deprecated. To get list view records, use [Get List View Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records.htm "Get record data for a list view using URL parameters.") or [Get List View Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view_records_post.htm "Get record data for a list view using a request body."). To get list view metadata, use [Get List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md.htm "Get list view metadata.").

Resources

/ui-api/list-ui/${listViewId}

/ui-api/list-ui/${objectApiName}/${listViewApiName}

- listViewId—The ID of a list view, such as 00BR0000000Wc0rMAC.
- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- listViewApiName—The API name of a list view, such as AllAccounts or \_\_Recent.

Available Version

42.0

HTTP Method

GET

Example

As an example, let’s say we have a list view named All Accounts with a list view ID of 00BR0000000Wc0rMAC. To get information about all the records and metadata for this list view, make this request.

/services/data/v68.0/ui-api/list-ui/00BR0000000Wc0rMAC

You can also use the object API name and list view API name of the list view to make the same request.

/services/data/v68.0/ui-api/list-ui/Account/AllAccounts

The request returns a list of records and the metadata for the list view.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d54291e193">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d54291e196">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d54291e199">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d54291e202">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d54291e205">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d54291e193" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d54291e196" data-title="Type">String[]</td>

                  <td class="entry" headers="d54291e199" data-title="Description"><span class="ph" id="fields_param_desc"><a name="fields_param_desc"><!-- --></a>Additional fields queried for the records
                      returned. These fields don’t create visible columns. If the field isn’t
                      available to the user, an error occurs.</span></td>

                  <td class="entry" headers="d54291e202" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d54291e205" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d54291e193" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d54291e196" data-title="Type">String[]</td>

                  <td class="entry" headers="d54291e199" data-title="Description"><span class="ph" id="optionalFields_param_desc"><a name="optionalFields_param_desc"><!-- --></a>Additional fields queried for the
                      records returned. These fields don’t create visible columns. If the field
                      isn’t available to the user, no error occurs and the field isn’t included in
                      the records.</span></td>

                  <td class="entry" headers="d54291e202" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d54291e205" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d54291e193" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d54291e196" data-title="Type">Integer</td>

                  <td class="entry" headers="d54291e199" data-title="Description"><span class="ph" id="pageSize_param_desc"><a name="pageSize_param_desc"><!-- --></a>The number of list records viewed at one
                      time. The default value is 50. Value can be 1–2000.</span></td>

                  <td class="entry" headers="d54291e202" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d54291e205" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d54291e193" data-title="Parameter Name"><samp class="codeph nolang">pageToken</samp></td>

                  <td class="entry" headers="d54291e196" data-title="Type">String</td>

                  <td class="entry" headers="d54291e199" data-title="Description"><span class="ph" id="pageToken_param_desc"><a name="pageToken_param_desc"><!-- --></a>A token that represents the page offset. To
                      indicate where the page starts, use this value with the <samp class="codeph nolang">pageSize</samp> parameter. The maximum offset is
                      2000 and the default is 0.</span></td>

                  <td class="entry" headers="d54291e202" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d54291e205" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d54291e193" data-title="Parameter Name"><samp class="codeph nolang">searchTerm</samp></td>

                  <td class="entry" headers="d54291e196" data-title="Type">String</td>

                  <td class="entry" headers="d54291e199" data-title="Description"><span class="ph" id="searchTerm"><a name="searchTerm"><!-- --></a>Search term to filter the results. Wildcards are
                      supported.</span></td>

                  <td class="entry" headers="d54291e202" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d54291e205" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d54291e193" data-title="Parameter Name"><samp class="codeph nolang">sortBy</samp></td>

                  <td class="entry" headers="d54291e196" data-title="Type">String[]</td>

                  <td class="entry" headers="d54291e199" data-title="Description">
                    <span class="ph" id="sortBy_param_desc"><a name="sortBy_param_desc"><!-- --></a>The API names of the fields the list view is
                      sorted by. If the name is preceded with <samp class="codeph nolang">-</samp>, the sort order is descending. For example, <samp class="codeph nolang">Name</samp> sorts by name in ascending order.
                      <samp class="codeph nolang">-CreatedDate</samp> sorts by created date in
                      descending order. </span>
                    <p class="p">In API version 63.0 and later, you can sort by up
                      to five fields.</p>
                  </td>

                  <td class="entry" headers="d54291e202" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d54291e205" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d54291e193" data-title="Parameter Name"><samp class="codeph nolang">where</samp></td>

                  <td class="entry" headers="d54291e196" data-title="Type">String</td>

                  <td class="entry" headers="d54291e199" data-title="Description"><span class="ph" id="where_param_desc"><a name="where_param_desc"><!-- --></a>The filter applied to returned records, in
                      GraphQL syntax. For example, <samp class="codeph nolang">{ and: [ {
                        StageName: { eq: "Prospecting" } }, { Account: { Name: { eq: "Dickenson
                        plc" } } } ] }</samp> filters an Opportunity related list to show only
                      opportunities in the Prospecting stage that are linked to the “Dickenson
                      plc” account.</span></td>

                  <td class="entry" headers="d54291e202" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d54291e205" data-title="Available Version">61.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[List UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_ui.htm "The record data and metadata for a list view.")

<!-- document id=9b1e41fea0e1433d0daa5371880711aa4e7791f23d10e37e0a9be854faeb1be1 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_view_records_post.md -->

# Get List View Records with a Request Body

Get record data for a list view using a request body.

Resource

/ui-api/list-records/${objectApiName}/${listViewApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- listViewApiName—The API name of a list view, such as AllAccounts.

Available version

61.0

HTTP methods

POST

Example

This example uses a request body to query a list view named All Accounts.

POST /services/data/v68.0/ui-api/list-records/Account/AllAccounts

{
  "fields": \["Name", "Type", "AnnualRevenue", "CreatedDate"\],
  "pageSize" : 10,
  "sortBy": \["CreatedDate"\],
  "searchTerm" : "United",
  "where": "{AnnualRevenue: { gt: 1000000}}"
}

This example uses the special \_\_Recent list view API name to get the record data for the most recently used (MRU) list view for accounts.

POST /services/data/v68.0/ui-api/list-records/Account/\_\_Recent

Request parameters for POST

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| listRecordsQuery | [List Records Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_records_input.htm "Record data to query for a list view.") | Record data to query for a list view. | Required | 61.0 |

Response body for POST

[List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_record_collection.htm "A collection of list view records.")

<!-- document id=fe72a1e81d2cce64217b81e2294921c8faef760545cc31242e7627c0b327472d url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_views_records.md -->

# Get List View Records with URL Parameters

Get record data for a list view using URL parameters.

Resource

/ui-api/list-records/${listViewId}

/ui-api/list-records/${objectApiName}/${listViewApiName}

- listViewId—The ID of a list view, such as 00BR0000000Wc0rMAC.
- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- listViewApiName—The API name of a list view, such as AllAccounts or \_\_Recent.

Available Version

42.0

HTTP Method

GET

Example

As an example, let’s say we have a list view named All Accounts with a list view ID of 00BR0000000Wc0rMAC. To get information about all the records on this list view, make this request.

GET /services/data/v68.0/ui-api/list-records/00BR0000000Wc0rMAC

You can also use the object API name and list view API name of the list view to make the same request.

GET /services/data/v68.0/ui-api/list-records/Account/AllAccounts

To get record data for the most recently used (MRU) list view for accounts, use the special \_\_Recent list view API name.

GET /services/data/v68.0/ui-api/list-records/Account/\_\_Recent

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d53099e177">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d53099e180">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d53099e183">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d53099e186">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d53099e189">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d53099e177" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d53099e180" data-title="Type">String[]</td>

                  <td class="entry" headers="d53099e183" data-title="Description"><span class="ph" id="fields_param_desc"><a name="fields_param_desc"><!-- --></a>Additional fields queried for the records
                      returned. These fields don’t create visible columns. If the field isn’t
                      available to the user, an error occurs.</span></td>

                  <td class="entry" headers="d53099e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d53099e189" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d53099e177" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d53099e180" data-title="Type">String[]</td>

                  <td class="entry" headers="d53099e183" data-title="Description"><span class="ph" id="optionalFields_param_desc"><a name="optionalFields_param_desc"><!-- --></a>Additional fields queried for the
                      records returned. These fields don’t create visible columns. If the field
                      isn’t available to the user, no error occurs and the field isn’t included in
                      the records.</span></td>

                  <td class="entry" headers="d53099e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d53099e189" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d53099e177" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d53099e180" data-title="Type">Integer</td>

                  <td class="entry" headers="d53099e183" data-title="Description"><span class="ph" id="pageSize_param_desc"><a name="pageSize_param_desc"><!-- --></a>The number of list records viewed at one
                      time. The default value is 50. Value can be 1–2000.</span></td>

                  <td class="entry" headers="d53099e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d53099e189" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d53099e177" data-title="Parameter Name"><samp class="codeph nolang">pageToken</samp></td>

                  <td class="entry" headers="d53099e180" data-title="Type">String</td>

                  <td class="entry" headers="d53099e183" data-title="Description"><span class="ph" id="pageToken_param_desc"><a name="pageToken_param_desc"><!-- --></a>A token that represents the page offset. To
                      indicate where the page starts, use this value with the <samp class="codeph nolang">pageSize</samp> parameter. The maximum offset is
                      2000 and the default is 0.</span></td>

                  <td class="entry" headers="d53099e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d53099e189" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d53099e177" data-title="Parameter Name"><samp class="codeph nolang">searchTerm</samp></td>

                  <td class="entry" headers="d53099e180" data-title="Type">String</td>

                  <td class="entry" headers="d53099e183" data-title="Description"><span class="ph" id="searchTerm"><a name="searchTerm"><!-- --></a>Search term to filter the results. Wildcards are
                      supported.</span></td>

                  <td class="entry" headers="d53099e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d53099e189" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d53099e177" data-title="Parameter Name"><samp class="codeph nolang">sortBy</samp></td>

                  <td class="entry" headers="d53099e180" data-title="Type">String[]</td>

                  <td class="entry" headers="d53099e183" data-title="Description">
                    <span class="ph" id="sortBy_param_desc"><a name="sortBy_param_desc"><!-- --></a>The API names of the fields the list view is
                      sorted by. If the name is preceded with <samp class="codeph nolang">-</samp>, the sort order is descending. For example, <samp class="codeph nolang">Name</samp> sorts by name in ascending order.
                      <samp class="codeph nolang">-CreatedDate</samp> sorts by created date in
                      descending order. </span>
                    <p class="p">In API version 63.0 and later, you can sort by up
                      to five fields.</p>
                  </td>

                  <td class="entry" headers="d53099e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d53099e189" data-title="Available Version">42.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d53099e177" data-title="Parameter Name"><samp class="codeph nolang">where</samp></td>

                  <td class="entry" headers="d53099e180" data-title="Type">String</td>

                  <td class="entry" headers="d53099e183" data-title="Description"><span class="ph" id="where_param_desc"><a name="where_param_desc"><!-- --></a>The filter applied to returned records, in
                      GraphQL syntax. For example, <samp class="codeph nolang">{ and: [ {
                        StageName: { eq: "Prospecting" } }, { Account: { Name: { eq: "Dickenson
                        plc" } } } ] }</samp> filters an Opportunity related list to show only
                      opportunities in the Prospecting stage that are linked to the “Dickenson
                      plc” account.</span></td>

                  <td class="entry" headers="d53099e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d53099e189" data-title="Available Version">61.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_record_collection.htm "A collection of list view records.")

<!-- document id=015e7fb889bf31d673d375ffac73564c72e99bb26eb606f1c581215ef737d83d url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_lists_object_get.md -->

# Get List Views for an Object

Get list views associated with an object.

Resource

/ui-api/list-info/${objectApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.

Available version

61.0

HTTP methods

GET

Example

This example gets all the list views associated with accounts.

GET /services/data/v68.0/ui-api/list-info/Account

This example gets the most recently used list views associated with accounts using the recentListsOnly request parameter.

GET /services/data/v68.0/ui-api/list-info/Account?recentListsOnly=true

Request parameters for GET

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| pageSize | Integer | Number of list records viewed at one time. The default value is 20. Value can be 1–2000. | Optional | 61.0 |
| pageToken | String | Token that represents the page offset. To indicate where the page starts, use this value with the pageSize parameter. The maximum offset is 2000 and the default is 0. | Optional | 61.0 |
| q | String | Search term to filter the results. Wildcards are supported. | Optional | 61.0 |
| recentListsOnly | Boolean | Indicates whether to get recent lists only (true) or not (false). Default is false. | Optional | 61.0 |

Response body for GET

[List Info Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_summary_collection.htm "List info summary collection.")

<!-- document id=d1bd7cba16072f1a34ee75a7b917e1ac9d0330e2998bc92d3bcc62635e57791b url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_views_object.md -->

# Get List Views for an Object (Deprecated)

Get a collection of list views associated with an object.

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

#### Note

This resource is deprecated. To get list views for an object, use [Get List Views for an Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_get.htm "Get list views associated with an object.").

Resource

/ui-api/list-ui/${objectApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.

Available Version

43.0

HTTP Method

GET

Example

To retrieve all list views associated with accounts, make this request:

GET /services/data/v68.0/ui-api/list-ui/Account

The request returns a list of all list views for the given object.

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| pageSize | Integer | The number of list records viewed at one time. The default value is 20. Value can be 1–2000. | Optional | 43.0 |
| pageToken | String | A token that represents the page offset. To indicate where the page starts, use this value with the pageSize parameter. The maximum offset is 2000 and the default is 0. | Optional | 43.0 |
| q | String | Query list views that contain certain key words. | Optional | 43.0 |
| recentListsOnly | Boolean | Show only recently viewed lists. | Optional | 43.0 |

Response Body

[List View Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_view_summary_collection.htm#ui_api_responses_list_view_summary_collection "A collection of list views for a given object.")

<!-- document id=95edc69fb3a2021414ce6baa38c014ba72bb1fba9614ff4405611108f14e74c4 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_lookup.md -->

# Get Lookup Field Actions

Get the actions on lookup fields.

Resource

/ui-api/actions/lookup/${objectApiNames}

objectApiNames—A lookup field name, or a comma-delimited list of lookup field names.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have a lookup field on a New Account dialog box. To get information about the actions on this lookup field, make this request:

GET /services/data/v68.0/ui-api/actions/lookup/Account

The request returns a list of actions on the lookup field and the URLs of the request and subrequests.

{
  "actions" : {
    "Account" : {
      "actions" : \[ {
        "actionListContext" : "Lookup",
        "actionTarget" : null,
        "actionTargetType" : "Invoke",
        "apiName" : "CreateFromLookup",
        "externalId" : "00DR00000008n7M:Account::Lookup:Phone:StandardButton:CreateFromLookup",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new\_120.png",
        "id" : "0JVR00000000004OAA",
        "isMassAction" : "false",
        "label" : "New",
        "primaryColor" : "33BCE7",
        "relatedListRecordId" : null,
        "relatedSourceObject" : null,
        "section" : "Page",
        "sourceObject" : "Account",
        "subtype" : null,
        "targetObject" : "Account",
        "targetUrl" : null,
        "type" : "StandardButton"
      } \],
      "links" : \[ \],
      "url" : "/services/data/v41.0/ui-api/actions/lookup/Account"
    }
  },
  "url" : "/services/data/v41.0/ui-api/actions/lookup/Account"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d56734e120">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d56734e123">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d56734e126">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d56734e129">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d56734e132">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d56734e120" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d56734e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d56734e126" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d56734e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d56734e132" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d56734e120" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d56734e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d56734e126" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d56734e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d56734e132" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d56734e120" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d56734e123" data-title="Type">String</td>

                  <td class="entry" headers="d56734e126" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d56734e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d56734e132" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d56734e120" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d56734e123" data-title="Type">String</td>

                  <td class="entry" headers="d56734e126" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d56734e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d56734e132" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d56734e120" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d56734e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d56734e126" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d56734e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d56734e132" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

#### See Also

- [Get Lookup Field Suggestions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_get.htm "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.")
- [Get Lookup Field Suggestions for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_object_get.htm "When a user edits a lookup field, use this resource to search for and display suggestions for a specified object. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.")

<!-- document id=3473061cd72ff8281cdf1ac44b95668f4a3bfa3444dd14fdac461238a0028405 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_lookup_get.md -->

# Get Lookup Field Suggestions

When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.

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

#### Note

In version 60.0 and later, use the [POST method](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_post.htm "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You must specify dependent lookup field values used by lookup filters in the `sourceRecord` request body parameter.") for lookup field suggestions. The POST method is a more secure way of transferring data where the parameters are sent in the message body.

Resource

/ui-api/lookups/{objectApiName}/{fieldApiName}

- objectApiName—The API name of a source object.
- fieldApiName—The API name of a lookup field on the source object.

Available Version

41.0–62.0

HTTP Method

GET

Example: Get Most Recently Used Records

A lookup relationship field links a source object to a target object. To edit a lookup field, users click a lookup icon to search for and select a value from a popup list. The target object provides the values in the list.

For example, the Opportunity object has an AccountId lookup field. When a user edits an Opportunity record, the user selects an Account to associate with the Opportunity. To build a UI that suggests the most recently used Account records to the user, use this resource. The default value of the searchType parameter is Recent, so the request doesn’t specify it.

GET /ui-api/lookups/Opportunity/AccountId

Example: Search for Suggestions

To search all searchable fields for suggestions, set searchType=Search. This example searches for strings that start with the characters ca (a wildcard is implied).

GET /ui-api/lookups/Opportunity/AccountId?searchType=Search&q=ca

Example: Search Record Names for Suggestions

To search record name fields for suggestions, set searchType=TypeAhead. This example searches record names for strings that start with the characters ta (a wildcard is implied).

GET /ui-api/lookups/Opportunity/AccountId?searchType=TypeAhead&q=ta

Example: Search Dependent Lookups for Suggestions

Some lookup fields have lookup filters that restrict their valid values by referencing fields on the source object. These fields are called dependent lookups. For example, you can filter the Case Contact field to show only contacts that are associated with the account selected in the Case Account Name field.

In the Salesforce UI, this lookup filter is Contact Name: Account Name ID EQUALS Case: Account Name ID. In the User Interface API, lookup filter information appears in the filteredLookupInfo property of the [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.") response body, which is returned from several resources, including [/ui-api/record-ui/{recordIds}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui "Get layout information, metadata, and data to build UI for a single record or for a collection of records."). If the filteredLookupInfo property is non-null, the field it describes is a dependent lookup.

In this example, the Case object’s ContactId field has a filteredLookupInfo property containing a controllingFields property. The controlling field is AccountId. To restrict the lookup search, you must pass all controlling fields and their values to the lookups resource in the dependentFieldBindings parameter.

 **"objectInfos" : {**
    ...
    **"Case" : { **      
      "apiName" : "Case",
      ...
      **"fields" : {**
       ...
        **"ContactId" : {**
          "apiName" : "ContactId",
          ...properties removed for space...
          **"filteredLookupInfo" : {
            "controllingFields" : \[ "AccountId" \],**
            "dependent" : true,
            "optionalFilter" : false
          },
          ...
          "sortable" : true,
          "unique" : false,
          "updateable" : true
        },
        ...

To get the value for AccountId, look in the [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.") response body, which is returned from several resources, including [/ui-api/record-ui/{recordIds}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui "Get layout information, metadata, and data to build UI for a single record or for a collection of records.").

**"records" : {**
    "500R0000000bKpBIAU" : {
      **"apiName" : "Case",**
      "childRelationships" : { },
      "fields" : {
        ...Some properties removed for space...
        **"AccountId" : {
**          "displayValue" : null,
          **"value" : "001R0000003IG0MIAW"
**        },
        "CaseNumber" : {
          "displayValue" : null,
          "value" : "00001005"
        },
        ...

To filter the suggestions for a dependent lookup, specify the names and values of the controlling fields in the dependentFieldBindings query parameter. (This example has one controlling field).

/ui-api/lookups/case/ContactId?dependentFieldBindings=AccountId=001R0000003IG0MIAW

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d57748e303">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d57748e306">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d57748e309">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d57748e312">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d57748e315">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d57748e303" data-title="Parameter Name"><samp class="codeph nolang">targetApiName</samp></td>

                  <td class="entry" headers="d57748e306" data-title="Type">String[]</td>

                  <td class="entry" headers="d57748e309" data-title="Description">The API name of the object that you want results for. The name must
                    correspond to one of the target objects of the lookup field. If not provided,
                    by default, results for all target objects of the lookup field are returned.
                    If targetApiName isn’t specified, then the field configuration is used. If the
                    field is polymorphic, several queries are considered and you receive results
                    for every target that can lead to performance issues.</td>

                  <td class="entry" headers="d57748e312" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d57748e315" data-title="Available Version">59.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d57748e303" data-title="Parameter Name"><samp class="codeph nolang">dependent​FieldBindings</samp></td>

                  <td class="entry" headers="d57748e306" data-title="Type">String[]</td>

                  <td class="entry" headers="d57748e309" data-title="Description">The dependent field bindings for dependent lookups. These field bindings
                    represent the lookup filter that restricts the valid values for the field.
                    <p class="p">Specify field bindings in a comma-separated list in the format <samp class="codeph nolang">dependentFieldBindings={fieldApiName}​={fieldValue},{field2ApiName}={field2Value}</samp>.</p>
                    <p class="p">To
                      know whether a field is a dependent lookup, check the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info" title="The metadata for an object.">Object Info</a>
                      response body for a non-null <samp class="codeph nolang">filteredLookupInfo</samp> property. Specify the name and a value for
                      each field in the <samp class="codeph nolang">controllingFields</samp>
                      property. Get the field values from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record" title="The field data, API name, child relationship data, and record type information for a record.">Record</a>
                      response body. Both responses are returned from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui" title="Get layout information, metadata, and data to build UI for a single record or for a collection of records.">/ui-api/record-ui/{recordIds}</a> resource.</p>
                  </td>

                  <td class="entry" headers="d57748e312" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d57748e315" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d57748e303" data-title="Parameter Name"><samp class="codeph nolang">page</samp></td>

                  <td class="entry" headers="d57748e306" data-title="Type">Integer</td>

                  <td class="entry" headers="d57748e309" data-title="Description">The page number. The default value is 1.</td>

                  <td class="entry" headers="d57748e312" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d57748e315" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d57748e303" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d57748e306" data-title="Type">Integer</td>

                  <td class="entry" headers="d57748e309" data-title="Description">The number of items per page. The default value is 25.</td>

                  <td class="entry" headers="d57748e312" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d57748e315" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d57748e303" data-title="Parameter Name"><samp class="codeph nolang">q</samp></td>

                  <td class="entry" headers="d57748e306" data-title="Type">String</td>

                  <td class="entry" headers="d57748e309" data-title="Description">The term the user is searching for. <p class="p">When <samp class="codeph nolang">searchType=Search</samp>, specify at least 2 characters. A wildcard at
                      the end of the search term is implied. For example, <samp class="codeph nolang">q=ca</samp> returns Cat and Cats.</p>
                    <p class="p">When <samp class="codeph nolang">searchType=TypeAhead</samp>, specify at least 3
                      characters. A wildcard at the end of the search term is implied. You can’t
                      use a <samp class="codeph nolang">?</samp>.</p>
                  </td>

                  <td class="entry" headers="d57748e312" data-title="Required or Optional">Required if <samp class="codeph nolang">searchType</samp> is <samp class="codeph nolang">TypeAhead</samp>.</td>

                  <td class="entry" headers="d57748e315" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d57748e303" data-title="Parameter Name"><samp class="codeph nolang">searchType</samp></td>

                  <td class="entry" headers="d57748e306" data-title="Type">String</td>

                  <td class="entry" headers="d57748e309" data-title="Description">The type of search to perform. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Recent</samp>—Return most recently used
                        matches.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Search</samp>—Search for records with
                        searchable fields that match the query term.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">TypeAhead</samp>—Search for records whose
                        names start with the query term.
                      </li>

                    </ul>
                    <p class="p">The default value is <samp class="codeph nolang">Recent</samp>.</p>
                  </td>

                  <td class="entry" headers="d57748e312" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d57748e315" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Lookup Values](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lookup_values.htm#ui_api_responses_lookup_values "Records, organized by object type, and metadata in a lookup relationship.")

<!-- document id=6675a546b4b1368665c32f3dbe786e3e7dc5ab4dd74015052c2aae293f7d4238 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_lookup_object_get.md -->

# Get Lookup Field Suggestions for a Specified Object

When a user edits a lookup field, use this resource to search for and display suggestions for a specified object. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.

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

#### Note

In version 60.0 and later, use the [POST method](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_post.htm "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You must specify dependent lookup field values used by lookup filters in the `sourceRecord` request body parameter.") for lookup field suggestions. The POST method is a more secure way of transferring data where the parameters are sent in the message body.

Resource

/ui-api/lookups/{objectApiName}/{fieldApiName}/{targetApiName}

- objectApiName—The API name of a source object.
- fieldApiName—The API name of a lookup field on the source object.
- targetApiName—The API name of the target (lookup) object.

Available Version

41.0–62.0

HTTP Method

GET

Example

See [Get Lookup Field Suggestions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_get.htm#ui_api_resources_lookup_get "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.").

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d59151e139">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d59151e142">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d59151e145">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d59151e148">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d59151e151">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d59151e139" data-title="Parameter Name"><samp class="codeph nolang">dependent​FieldBindings</samp></td>

                  <td class="entry" headers="d59151e142" data-title="Type">String[]</td>

                  <td class="entry" headers="d59151e145" data-title="Description">The dependent field bindings for dependent lookups. These field bindings
                    represent the lookup filter that restricts the valid values for the field.
                    <p class="p">Specify field bindings in a comma-separated list in the format <samp class="codeph nolang">dependentFieldBindings={fieldApiName}​={fieldValue},{field2ApiName}={field2Value}</samp>.</p>
                    <p class="p">To
                      know whether a field is a dependent lookup, check the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info" title="The metadata for an object.">Object Info</a>
                      response body for a non-null <samp class="codeph nolang">filteredLookupInfo</samp> property. Specify the name and a value for
                      each field in the <samp class="codeph nolang">controllingFields</samp>
                      property. Get the field values from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record" title="The field data, API name, child relationship data, and record type information for a record.">Record</a>
                      response body. Both responses are returned from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui" title="Get layout information, metadata, and data to build UI for a single record or for a collection of records.">/ui-api/record-ui/{recordIds}</a> resource.</p>
                  </td>

                  <td class="entry" headers="d59151e148" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d59151e151" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d59151e139" data-title="Parameter Name"><samp class="codeph nolang">page</samp></td>

                  <td class="entry" headers="d59151e142" data-title="Type">Integer</td>

                  <td class="entry" headers="d59151e145" data-title="Description">The page number. The default value is 1.</td>

                  <td class="entry" headers="d59151e148" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d59151e151" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d59151e139" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d59151e142" data-title="Type">Integer</td>

                  <td class="entry" headers="d59151e145" data-title="Description">The number of items per page. The default value is 25.</td>

                  <td class="entry" headers="d59151e148" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d59151e151" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d59151e139" data-title="Parameter Name"><samp class="codeph nolang">q</samp></td>

                  <td class="entry" headers="d59151e142" data-title="Type">String</td>

                  <td class="entry" headers="d59151e145" data-title="Description">The term the user is searching for. <p class="p">When <samp class="codeph nolang">searchType=Search</samp>, specify at least 2 characters. A wildcard at
                      the end of the search term is implied. For example, <samp class="codeph nolang">q=ca</samp> returns Cat and Cats.</p>
                    <p class="p">When <samp class="codeph nolang">searchType=TypeAhead</samp>, specify at least 3
                      characters. A wildcard at the end of the search term is implied. You can’t
                      use a <samp class="codeph nolang">?</samp>.</p>
                  </td>

                  <td class="entry" headers="d59151e148" data-title="Required or Optional">Required if <samp class="codeph nolang">searchType</samp> is <samp class="codeph nolang">TypeAhead</samp>.</td>

                  <td class="entry" headers="d59151e151" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d59151e139" data-title="Parameter Name"><samp class="codeph nolang">searchType</samp></td>

                  <td class="entry" headers="d59151e142" data-title="Type">String</td>

                  <td class="entry" headers="d59151e145" data-title="Description">The type of search to perform. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Recent</samp>—Return most recently used
                        matches.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Search</samp>—Search for records with
                        searchable fields that match the query term.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">TypeAhead</samp>—Search for records whose
                        names start with the query term.
                      </li>

                    </ul>
                    <p class="p">The default value is <samp class="codeph nolang">Recent</samp>.</p>
                  </td>

                  <td class="entry" headers="d59151e148" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d59151e151" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_collection.htm#ui_api_responses_record_collection "A paginated collection of Record response bodies.")

<!-- document id=b079715e6e5095e2892dbd84aab0e2de8b4493f308009f16da8b67b5b3536376 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_lookup_post.md -->

# Get Lookup Field Suggestions With POST

When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You must specify dependent lookup field values used by lookup filters in the \`sourceRecord\` request body parameter.

Resource

/ui-api/lookups/{objectApiName}/{fieldApiName}

- objectApiName—The API name of a source object.
- fieldApiName—The API name of a lookup field on the source object.

Available Version

60.0

HTTP Method

POST

Example: Get Most Recently Used Records

A lookup relationship field links a source object to a target object. To edit a lookup field, users click on a lookup field to search for and select a value from a popup list. The target object provides the values in the list.

For example, the Opportunity object has an AccountId lookup field. When a user edits an Opportunity record, the user selects an Account to associate with the Opportunity. To build a UI that suggests the most recently used Account records to the user, use this resource. The default value of the searchType parameter is Recent, so the request doesn’t specify it.

POST /ui-api/lookups/Opportunity/AccountId

Example: Search for Suggestions using request parameters

To search all searchable fields for suggestions, set searchType=Search. This example searches for strings that start with the characters ca (a wildcard is implied).

POST /ui-api/lookups/Opportunity/AccountId?searchType=Search&q=ca

Example: Search Record Names for Suggestions using request parameters

To search record name fields for suggestions, set searchType=TypeAhead. This example searches record names for strings that start with the characters ta (a wildcard is implied).

POST /ui-api/lookups/Opportunity/AccountId?searchType=TypeAhead&q=ta

Request Parameters for POST

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d60139e164">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d60139e167">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d60139e170">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d60139e173">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d60139e176">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d60139e164" data-title="Parameter Name"><samp class="codeph nolang">page</samp></td>

                  <td class="entry" headers="d60139e167" data-title="Type">Integer</td>

                  <td class="entry" headers="d60139e170" data-title="Description">The page number. The default value is 1.</td>

                  <td class="entry" headers="d60139e173" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d60139e176" data-title="Available Version">60.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d60139e164" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d60139e167" data-title="Type">Integer</td>

                  <td class="entry" headers="d60139e170" data-title="Description">The number of items per page. The default value is 25.</td>

                  <td class="entry" headers="d60139e173" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d60139e176" data-title="Available Version">60.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d60139e164" data-title="Parameter Name"><samp class="codeph nolang">q</samp></td>

                  <td class="entry" headers="d60139e167" data-title="Type">String</td>

                  <td class="entry" headers="d60139e170" data-title="Description">The term the user is searching for. <p class="p">When <samp class="codeph nolang">searchType=Search</samp>, specify at least 2 characters. A wildcard at
                      the end of the search term is implied. For example, <samp class="codeph nolang">q=ca</samp> returns Cat and Cats.</p>
                    <p class="p">When <samp class="codeph nolang">searchType=TypeAhead</samp>, specify at least 3
                      characters. A wildcard at the end of the search term is implied. You can’t
                      use a <samp class="codeph nolang">?</samp>.</p>
                  </td>

                  <td class="entry" headers="d60139e173" data-title="Required or Optional">Required if <samp class="codeph nolang">searchType</samp> is <samp class="codeph nolang">TypeAhead</samp>.</td>

                  <td class="entry" headers="d60139e176" data-title="Available Version">60.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d60139e164" data-title="Parameter Name"><samp class="codeph nolang">searchType</samp></td>

                  <td class="entry" headers="d60139e167" data-title="Type">String</td>

                  <td class="entry" headers="d60139e170" data-title="Description">The type of search to perform. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Recent</samp>—Return most recently used
                        matches.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Search</samp>—Search for records with
                        searchable fields that match the query term.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">TypeAhead</samp>—Search for records whose
                        names start with the query term.
                      </li>

                    </ul>
                    <p class="p">The default value is <samp class="codeph nolang">Recent</samp>.</p>
                  </td>

                  <td class="entry" headers="d60139e173" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d60139e176" data-title="Available Version">60.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d60139e164" data-title="Parameter Name"><samp class="codeph nolang">targetApiName</samp></td>

                  <td class="entry" headers="d60139e167" data-title="Type">String[]</td>

                  <td class="entry" headers="d60139e170" data-title="Description">The API name of the object that you want results for. The name must
                    correspond to one of the target objects of the lookup field. If not provided,
                    by default, results for all target objects of the lookup field are returned.
                    If targetApiName isn’t specified, then the field configuration is used. If the
                    field is polymorphic, several queries are considered and you receive results
                    for every target that can lead to performance issues. </td>

                  <td class="entry" headers="d60139e173" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d60139e176" data-title="Available Version">60.0</td>

                </tr>

              </tbody>

            </table>

Request Body for POST

Example: Search Dependent Lookups for Suggestions using the request body

Some lookup fields have lookup filters that restrict their valid values by referencing fields on the source object. These fields are called dependent lookups. For example, you can filter the Case Contact field to show only contacts that are associated with the account selected in the Case Account Name field.

In the Salesforce UI, this lookup filter is Contact Name: Account Name ID EQUALS Case: Account Name ID. In the User Interface API, lookup filter information appears in the filteredLookupInfo property of the [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.") response body, which is returned from several resources, including [/ui-api/record-ui/{recordIds}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui "Get layout information, metadata, and data to build UI for a single record or for a collection of records."). If the filteredLookupInfo property is non-null, the field it describes is a dependent lookup.

In this example, the Case object’s ContactId field has a filteredLookupInfo property containing a controllingFields property. The controlling field is AccountId. To restrict the lookup search, you must pass all controlling fields and their values to the lookups resource in the sourceRecord request body property.

 **"objectInfos" : {**
    ...
    **"Case" : { **      
      "apiName" : "Case",
      ...
      **"fields" : {**
       ...
        **"ContactId" : {**
          "apiName" : "ContactId",
          ...properties removed for space...
          **"filteredLookupInfo" : {
            "controllingFields" : \[ "AccountId" \],**
            "dependent" : true,
            "optionalFilter" : false
          },
          ...
          "sortable" : true,
          "unique" : false,
          "updateable" : true
        },
        ...

To get the value for AccountId, look in the [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.") response body, which is returned from several resources, including [/ui-api/record-ui/{recordIds}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui "Get layout information, metadata, and data to build UI for a single record or for a collection of records."). For example, to retrieve the value of the AccountId field present on the Case 500R0000000bKpBIAU:

GET /ui-api/records/500R0000000bKpBIAU?fields=Case.AccountId

{
  "apiName": "Case",
  "id": "500Z7000000bhdFIAQ",
  "fields": {
    "AccountId": {
      "displayValue": null,
      "value": "001R0000003IG0MIAW"
    }
  },
  ...Some properties removed for space...
}

To filter the suggestions for a dependent lookup, specify the names and values of the controlling fields in the sourceRecord request body property. (This example has one controlling field).

Request body:

POST /ui-api/lookups/case/ContactId
{
    "sourceRecord": {
        "fields": {
            "Id": "500Z7000000bhdFIAQ",
            "AccountId": "001R0000003IG0MIAW"
        }
    },
     "orderBy": \[
        {
           "fieldApiName": "Name", 
           "isAscending":true
        }
     \]  
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d60139e485">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d60139e488">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d60139e491">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d60139e494">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d60139e497">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d60139e485" data-title="Name"><samp class="codeph nolang">orderBy</samp></td>

                  <td class="entry" headers="d60139e488" data-title="Type">
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm" title="Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.">List Order By Input</a>[]
                  </td>

                  <td class="entry" headers="d60139e491" data-title="Description">Information describing how to order the results.</td>

                  <td class="entry" headers="d60139e494" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d60139e497" data-title="Available Version">63.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d60139e485" data-title="Name"><samp class="codeph nolang">sourceRecord</samp></td>

                  <td class="entry" headers="d60139e488" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_record_input.htm" title="A description of a record to use in a request to create or update a record or in a request to check for duplicate records.">Record
                      Input</a></td>

                  <td class="entry" headers="d60139e491" data-title="Description">The source record in which the lookup relationship field is being edited.
                    <p class="p">The presence of the source record “Id” is required within the “fields”
                      property. Accepted values are “null” when creating a new record and a valid
                      record ID when updating an existing record.</p>
                    <p class="p">Some lookup fields have
                      lookup filters that restrict the values they can accept by referencing
                      fields on the source object. These fields are called dependent lookup fields
                      or controlling fields. You must pass all controlling fields and their values
                      to the lookups resource within the “fields” property. </p>
                    <p class="p">To know whether
                      a field is a lookup controlling field, check the Object Info response body
                      for a non-null filteredLookupInfo property. Get the field values from the
                      Record response body. Both responses are returned from the
                      /ui-api/record-ui/{recordIds} resource.</p>
                    Properties “allowSaveOnDuplicate”
                    and “apiName” are not used.
                  </td>

                  <td class="entry" headers="d60139e494" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d60139e497" data-title="Available Version">60.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Lookup Values](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lookup_values.htm#ui_api_responses_lookup_values "Records, organized by object type, and metadata in a lookup relationship.")

#### See Also

- [Get Lookup Field Suggestions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_get.htm "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.")
- [Get Lookup Field Suggestions for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_object_get.htm "When a user edits a lookup field, use this resource to search for and display suggestions for a specified object. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.")

<!-- document id=11a219e30f70a5ba583d27f156b8bb75ddb6796bef9efbfedddab2da1dbcf631 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_lists_object_md_get.md -->

# Get Metadata for a List View Object

Get metadata for a list view object.

Resource

/ui-api/list-object-info/${objectApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.

Available version

61.0

HTTP methods

GET

Example

Get metadata for a list object, such as account.

GET /services/data/v68.0/ui-api/list-object-info/Account

Response body for GET

[List Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_info.htm "List object info.")

<!-- document id=f40574d61780ea45519be3f9c2ddd0491c59c8520a29b948146883eb95d0904f url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_mru_list_views_md.md -->

# Get Most Recently Used List View Metadata (Deprecated)

Get metadata for an object’s most recently viewed (MRU) list view.

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

#### Note

This resource is deprecated. To get most recently used list view metadata for an object, use [Get List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md.htm "Get list view metadata.").

Resource

/ui-api/mru-list-info/${objectApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.

Available Version

43.0

HTTP Method

GET

Example

This example gets information about the metadata for the most recently used account list view.

GET /services/data/v68.0/ui-api/mru-list-info/Account

Response Body

[List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")

<!-- document id=19993a6d2d23d633d82fa399df01f2357842415fb313c61b1537eeaf62533196 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_mru_list_views_records.md -->

# Get Most Recently Used List View Records (Deprecated)

Get record data for an object’s most recently used (MRU) list view.

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

#### Note

This resource is deprecated. To get most recently used list view records, use [Get List View Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records.htm "Get record data for a list view using URL parameters.") or [Get List View Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view_records_post.htm "Get record data for a list view using a request body.").

Resource

/ui-api/mru-list-records/${objectApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.

Available Version

43.0

HTTP Method

GET

Example

To get information about the records in the most recently used account list views, make this request:

GET /services/data/v68.0/ui-api/mru-list-records/Account

The request returns a list of records in the most recently used account list view.

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| fields | String\[\] | Additional fields queried for the records returned. These fields don’t create visible columns. If the field is not available to the user, an error occurs. | Optional | 43.0 |
| optionalFields | String\[\] | Additional fields queried for the records returned. These fields don’t create visible columns. If the field is not available to the user, no error occurs and the field isn’t included in the records. | Optional | 43.0 |
| pageSize | Integer | The number of list records viewed at one time. The default value is 50. Value can be 1–2000. | Optional | 43.0 |
| pageToken | String | A token that represents the page offset. To indicate where the page starts, use this value with the pageSize parameter. The maximum offset is 2000 and the default is 0. | Optional | 43.0 |
| sortBy | String\[\] | The API name of the field the list view is sorted by. If the name is preceded with “-”, the sort order is descending. For example, "Name" sorts by name in ascending order. "-CreatedDate" sorts by created date in descending order. | Optional | 43.0 |

Response Body

[List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_record_collection.htm "A collection of list view records.")

<!-- document id=ef325d58c2574c8085be918a2f08d5a09005cdaa4c168c03f8b99ac07d6ad128 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_mru_list_views_records_md.md -->

# Get Most Recently Used List View Records and Metadata (Deprecated)

Get record data and metadata for an object’s most recently used (MRU) list view.

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

#### Note

This resource is deprecated. To get most recently used list view records, use [Get List View Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records.htm "Get record data for a list view using URL parameters.") or [Get List View Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view_records_post.htm "Get record data for a list view using a request body."). To get most recently used list view metadata, use [Get List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md.htm "Get list view metadata.").

Resource

/ui-api/mru-list-ui/${objectApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.

Available Version

43.0

HTTP Method

GET

Example

To get information about the record data and metadata for the most recently used account list views, make this request.

GET /services/data/v68.0/ui-api/mru-list-ui/Account

The request returns the record data and metadata for the most recently used account list view.

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| fields | String\[\] | Additional fields queried for the records returned. These fields don’t create visible columns. If the field is not available to the user, an error occurs. | Optional | 43.0 |
| optionalFields | String\[\] | Additional fields queried for the records returned. These fields don’t create visible columns. If the field is not available to the user, no error occurs and the field isn’t included in the records. | Optional | 43.0 |
| pageSize | Integer | The number of list records viewed at one time. The default value is 50. Value can be 1–2000. | Optional | 43.0 |
| pageToken | String | A token that represents the page offset. To indicate where the page starts, use this value with the pageSize parameter. The maximum offset is 2000 and the default is 0. | Optional | 43.0 |
| sortBy | String\[\] | The API name of the field the list view is sorted by. If the name is preceded with “-”, the sort order is descending. For example, "Name" sorts by name in ascending order. "-CreatedDate" sorts by created date in descending order. | Optional | 43.0 |

Response Body

[List UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_ui.htm "The record data and metadata for a list view.")

<!-- document id=fe63d5a5ea400db24182cac6811b58a868f5af4a3963b4656d7d11c42af0e4ec url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_mru_list.md -->

# Get MRU List View Actions

Get the header actions on the most recently used (MRU) list view for objects.

Resource

/ui-api/actions/mru-list/${objectApiNames}

objectApiNames—An object name, or a comma-delimited list of object names.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have a most recently used Accounts list view. To get information about the header actions on this list view, make this request:

GET /services/data/v68.0/ui-api/actions/mru-list/Account

The request returns a list of header actions on the list view and the URLs of the request and subrequests.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d61700e117">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d61700e120">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d61700e123">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d61700e126">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d61700e129">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d61700e117" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d61700e120" data-title="Type">String[]</td>

                  <td class="entry" headers="d61700e123" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d61700e126" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d61700e129" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d61700e117" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d61700e120" data-title="Type">String[]</td>

                  <td class="entry" headers="d61700e123" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d61700e126" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d61700e129" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d61700e117" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d61700e120" data-title="Type">String</td>

                  <td class="entry" headers="d61700e123" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d61700e126" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d61700e129" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d61700e117" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d61700e120" data-title="Type">String</td>

                  <td class="entry" headers="d61700e123" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d61700e126" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d61700e129" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d61700e117" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d61700e120" data-title="Type">String[]</td>

                  <td class="entry" headers="d61700e123" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d61700e126" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d61700e129" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm "The actions for a single record or a collection of records.")

<!-- document id=f8063519b61532c8e151b407d005bbf78d6ae63b5f754303a104368d7d1938e9 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_object_info.md -->

# Get Object Metadata

Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.

Resource

/ui-api/object-info/{objectApiName}

objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object.

Available Version

41.0

HTTP Method

GET

Response Body

[Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.")

#### See Also

- [User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm "Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.")
- [Get a Directory of Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info_directory.htm "Get a directory of objects that are supported by User Interface API and accessible to the context user. The directory includes a /ui-api/object-info/{objectApiName} resource for each supported object.")

<!-- document id=5d5b493883066c3d0472823a88487e058204350d0e7d14ed120c0ba62460cbb8 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_apps_user_nav_items.md -->

# Get Personalized Navigation Items

Get a user’s personalized navigation items (tabs).

Resource

/ui-api/apps/${appId}/user-nav-items

Available Version

43.0

HTTP Method

GET

Example

To get a user’s personalized navigation tabs for an app, make this request using the app ID:

GET /services/data/v68.0/ui-api/apps/06mRM000000AFIrYAO/user-nav-items

The request returns metadata for the personalized navigation tabs associated with this app.

{
  "navItems" : \[   {
    "availableInClassic" : true,
    "availableInLightning" : true,
    "color" : "50E3C2",
    "content" : "https://yourInstance.salesforce.com/0WO/o",
    "custom" : false,
    "developerName" : "standard-WorkOrder",
    "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/standard/work\_order\_120.png",
    "id" : "0QkR00000004CvtKAE",
    "itemType" : "Entity",
    "label" : "Work Orders",
    "objectApiName" : "WorkOrder",
    "pageReference" : {
      "attributes" : {
        "objectApiName" : "WorkOrder",
        "actionName" : "home"
      },
      "state" : { },
      "type" : "standard\_\_objectPage"
    },
    "standardType" : null
  }, {
    "availableInClassic" : true,
    "availableInLightning" : true,
    "color" : "83B6FF",
    "content" : "https://yourInstance.salesforce.com/\_ui/core/chatter/groups/GroupListPage",
    "custom" : false,
    "developerName" : "standard-CollaborationGroup",
    "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/standard/groups\_120.png",
    "id" : "0QkR000000002R3KAI",
    "itemType" : "Standard",
    "label" : "Groups",
    "objectApiName" : "CollaborationGroup",
    "pageReference" : {
      "attributes" : {
        "objectApiName" : "CollaborationGroup",
        "actionName" : "home"
      },
      "state" : { },
      "type" : "standard\_\_objectPage"
    },
    "standardType" : "Groups"
  }, {
    "availableInClassic" : true,
    "availableInLightning" : true,
    "color" : "2ECBBE",
    "content" : "https://yourInstance.salesforce.com/00O/o",
    "custom" : false,
    "developerName" : "standard-report",
    "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/standard/report\_120.png",
    "id" : "0QkR000000007UxKAI",
    "itemType" : "Standard",
    "label" : "Reports",
    "objectApiName" : "Report",
    "pageReference" : {
      "attributes" : {
        "objectApiName" : "Report",
        "actionName" : "home"
      },
      "state" : { },
      "type" : "standard\_\_objectPage"
    },
    "standardType" : "Reports"
  } \]
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d41144e114">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d41144e117">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d41144e120">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d41144e123">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d41144e126">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d41144e114" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d41144e117" data-title="Type">String</td>

                  <td class="entry" headers="d41144e120" data-title="Description">The form factor for each app that the user has access to.<a name="form_factor_values_ul"><!-- --></a>
                    <ul class="ul bulletList" id="form_factor_values_ul">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—App supports the
                        desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—App supports the
                        tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—App supports the phone
                        display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d41144e123" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d41144e126" data-title="Available Version">43.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_items.htm "An ordered list of navigation items (tabs) for the current user.")

<!-- document id=8561443b8b952efd75f99b371c61e7508d7f33b5e634bd91731f96fa0ceb44a9 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_photo.md -->

# Get Photo Actions

Get the photo actions for pages. Currently, only group and user pages support photo actions.

Resource

/ui-api/actions/photo/${recordIds}

recordIds—A single record ID, or a comma-delimited list of record IDs.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have a Group tab with a record ID of 0F9R00000000182KAA . To get information about the photo actions on the tab, make this request:

GET /services/data/v68.0/ui-api/actions/photo/0F9R00000000182KAA

The request returns a list of photo actions on the tab and the URLs of the request and subrequests.

{
  "actions" : {
    "0F9R00000000182KAA" : {
      "actions" : \[ {
        "actionListContext" : "Photo",
        "actionTarget" : null,
        "actionTargetType" : "Invoke",
        "apiName" : "ViewPhotoAction",
        "externalId" : "00DR00000008n7M:0F9R00000000182KAA::Photo:Phone:StandardButton:ViewPhotoAction",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/email\_120.png",
        "id" : "0JVR00000000035OAA",
        "isMassAction" : "false",
        "label" : "View Photo",
        "primaryColor" : "95AEC5",
        "relatedListRecordId" : null,
        "relatedSourceObject" : null,
        "section" : "Page",
        "sourceObject" : "0F9R00000000182KAA",
        "subtype" : null,
        "targetObject" : null,
        "targetUrl" : null,
        "type" : "StandardButton"
      }

... Additional actions removed for brevity ...

\],
      "links" : \[ \],
      "url" : "/services/data/v41.0/ui-api/actions/photo/0F9R00000000182KAA"
    }
  },
  "url" : "/services/data/v41.0/ui-api/actions/photo/0F9R00000000182KAA"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d65523e124">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d65523e127">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d65523e130">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d65523e133">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d65523e136">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d65523e124" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d65523e127" data-title="Type">String[]</td>

                  <td class="entry" headers="d65523e130" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d65523e133" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d65523e136" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d65523e124" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d65523e127" data-title="Type">String[]</td>

                  <td class="entry" headers="d65523e130" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d65523e133" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d65523e136" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d65523e124" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d65523e127" data-title="Type">String</td>

                  <td class="entry" headers="d65523e130" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d65523e133" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d65523e136" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d65523e124" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d65523e127" data-title="Type">String</td>

                  <td class="entry" headers="d65523e130" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d65523e133" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d65523e136" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d65523e124" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d65523e127" data-title="Type">String[]</td>

                  <td class="entry" headers="d65523e130" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d65523e133" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d65523e136" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

<!-- document id=1ee88d039dfbb115b3bee710871dc94e9712d668f29e2fa158fd57d527a07d6d url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_ui.md -->

# Get Record Data and Object Metadata

Get layout information, metadata, and data to build UI for a single record or for a collection of records.

The response contains layout information for whichever layout types are specified in the layoutTypes parameter.

It contains data for the records specified in the recordIds parameter.

The response contains object metadata for the object types of the records specified in the recordIds parameter, and for any nested objects. For example, a request to /ui-api/record-ui/001RM000003RsOHYA0, which is an Account, returns object metadata for Account and User, because the OwnerId field on the Account object contains a reference to the User object.

Resource

/ui-api/record-ui/{recordIds}

recordIds—A comma-delimited list of custom object records and [supported object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") records.

Available Version

41.0

HTTP Method

GET

Example

The response for this request includes layout information, metadata, and record data. The record data includes child relationship data for Contacts and Opportunities.

GET /ui-api/record-ui/001R0000003I6CoIAK?childRelationships=Account.Contacts,Account.Opportunities

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d75373e138">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d75373e141">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d75373e144">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d75373e147">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d75373e150">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d75373e138" data-title="Parameter Name"><samp class="codeph nolang">childRelationships</samp></td>

                  <td class="entry" headers="d75373e141" data-title="Type">String[]</td>

                  <td class="entry" headers="d75373e144" data-title="Description">A collection of child relationship names. The records with those child
                    relationship names are included in the response. Specify names in the format
                    <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">ChildRelationshipName</var></samp>
                    or <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">ChildRelationshipName</var>.<var class="keyword varname">FieldApiName</var></samp>.
                    For example, to specify the Contacts relationship on an Account, use <samp class="codeph nolang">Account.Contacts</samp>. You can get child
                    relationships one level deep.<p class="p">To get a relationship name, look in the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info" title="The metadata for an object.">Object Info</a> response body.</p>
                  </td>

                  <td class="entry" headers="d75373e147" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d75373e150" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d75373e138" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d75373e141" data-title="Type">String</td>

                  <td class="entry" headers="d75373e144" data-title="Description">The layout display size for the record. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d75373e147" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d75373e150" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d75373e138" data-title="Parameter Name"><samp class="codeph nolang">layoutTypes</samp></td>

                  <td class="entry" headers="d75373e141" data-title="Type">String[]</td>

                  <td class="entry" headers="d75373e144" data-title="Description">The layout type for the record. A collection of any of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Compact</samp>—Use this value to get a
                        layout that contains a record’s key fields.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Full</samp>—(Default) Use this value to
                        get a full layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d75373e147" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d75373e150" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d75373e138" data-title="Parameter Name"><samp class="codeph nolang">modes</samp></td>

                  <td class="entry" headers="d75373e141" data-title="Type">String[]</td>

                  <td class="entry" headers="d75373e144" data-title="Description">The access mode for the record. This value determines which fields to get
                    from a layout. Layouts have different fields for create, edit, and view modes.
                    For example, formula fields are rendered in view mode, but not in create mode
                    because they’re calculated at run time, like formulas in a spreadsheet. A
                    collection of any of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Create</samp>—Use this mode if you intend
                        to build UI that lets a user create a record. This mode is used by the
                        <samp class="codeph nolang">/ui-api/record-defaults/create/{apiName}</samp> resource.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Edit</samp>—Use this mode if you intend to
                        build UI that lets a user edit a record. This mode is used by the <samp class="codeph nolang">/ui-api/record-defaults/clone/{recordId}</samp>
                        resource.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">View</samp>—(Default) Use this mode to
                        build UI that displays a record.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d75373e147" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d75373e150" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d75373e138" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d75373e141" data-title="Type">String[]</td>

                  <td class="entry" headers="d75373e144" data-title="Description">A collection of optional field names. If a field is accessible to the
                    context user, it’s included in the response. If a field isn’t accessible to
                    the context user, it isn’t included in the response, but it doesn’t cause an
                    error. <p class="p">Specify names in the format <samp class="codeph nolang"><var class="keyword varname">ObjectApiName</var>.<var class="keyword varname">FieldName</var></samp>.
                      You can get any field that has a named relationship to this record. There’s
                      no limit to the number of fields you can specify.</p>
                  </td>

                  <td class="entry" headers="d75373e147" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d75373e150" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d75373e138" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d75373e141" data-title="Type">Integer</td>

                  <td class="entry" headers="d75373e144" data-title="Description">The maximum number of child records to return on a page.</td>

                  <td class="entry" headers="d75373e147" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d75373e150" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d75373e138" data-title="Parameter Name"><samp class="codeph nolang">updateMru</samp></td>

                  <td class="entry" headers="d75373e141" data-title="Type">Boolean</td>

                  <td class="entry" headers="d75373e144" data-title="Description">To add to the most recently used (MRU) list view, set to <samp class="codeph nolang">true</samp>. The default value is <samp class="codeph nolang">false</samp>.</td>

                  <td class="entry" headers="d75373e147" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d75373e150" data-title="Available Version">47.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_ui.htm#ui_api_responses_record_ui "The layout information, field information, and data for a record.")

#### See Also

- [User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm "Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.")
- [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm "The metadata for an object.")
- [Get Child Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_child_relationships.htm "User Interface API has several resources that include child records in their responses. If a record has many child relationships, a response can be huge and have a negative effect on performance. To get only the records you need, request records for specific child relationships and set the page size of the results.")

<!-- document id=39b5722df204396407b356300da21ba6407066000c943e30bef80ef5ed8b4f75 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_action_record.md -->

# Get Record Detail Actions

Get the actions on record detail pages.

Resource

/ui-api/actions/record/${recordIds}

recordIds—A single record ID, or a comma-delimited list of record IDs.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have an Account record detail page with a record ID of 001R0000003IDlwIAG. The page has some standard buttons and quick actions. To get information about all the actions on this page, make this request:

GET /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG

The request returns a list of actions on the page and the URLs of the request and subrequests.

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d35879e120">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d35879e123">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d35879e126">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d35879e129">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d35879e132">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d35879e120" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d35879e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d35879e126" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d35879e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d35879e132" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d35879e120" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d35879e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d35879e126" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d35879e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d35879e132" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d35879e120" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d35879e123" data-title="Type">String</td>

                  <td class="entry" headers="d35879e126" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d35879e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d35879e132" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d35879e120" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d35879e123" data-title="Type">String</td>

                  <td class="entry" headers="d35879e126" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d35879e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d35879e132" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d35879e120" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d35879e123" data-title="Type">String[]</td>

                  <td class="entry" headers="d35879e126" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d35879e129" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d35879e132" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

<!-- document id=90890c2b900522b0dedc0383a1f21282871e6a56c0048a45756d04f0eaad00e6 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_action_record_edit.md -->

# Get Record Edit Actions

Get the actions on a record edit page.

Resource

/ui-api/actions/record/${recordId}/record-edit

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have an Account page with a record ID of 001R0000003IDlwIAG. To get information about all the actions on the edit page for this record, make this request:

GET /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/record-edit

The request returns a list of actions on the edit page and the URLs of the request and subrequests.

{
  "actions" : {
    "001R0000003IDlwIAG" : {
      "actions" : \[ {
        "actionListContext" : "RecordEdit",
        "actionTarget" : null,
        "actionTargetType" : "Invoke",
        "apiName" : "SaveEdit",
        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RecordEdit:Phone:StandardButton:SaveEdit",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new\_custom19\_120.png",
        "id" : "0JVR00000000001OAA",
        "isMassAction" : "false",
        "label" : "Save",
        "primaryColor" : null,
        "relatedListRecordId" : null,
        "relatedSourceObject" : null,
        "section" : "Page",
        "sourceObject" : "001R0000003IDlwIAG",
        "subtype" : null,
        "targetObject" : "Account",
        "targetUrl" : null,
        "type" : "StandardButton"
      }

... Additional actions removed for brevity ...

\],
      "links" : \[ \],
      "url" : "/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG/record-edit"
    }
  },
  "url" : "/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG/record-edit"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d36856e118">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d36856e121">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d36856e124">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d36856e127">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d36856e130">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d36856e118" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d36856e121" data-title="Type">String[]</td>

                  <td class="entry" headers="d36856e124" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d36856e127" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d36856e130" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d36856e118" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d36856e121" data-title="Type">String[]</td>

                  <td class="entry" headers="d36856e124" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d36856e127" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d36856e130" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d36856e118" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d36856e121" data-title="Type">String</td>

                  <td class="entry" headers="d36856e124" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d36856e127" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d36856e130" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d36856e118" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d36856e121" data-title="Type">String</td>

                  <td class="entry" headers="d36856e124" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d36856e127" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d36856e130" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d36856e118" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d36856e121" data-title="Type">String[]</td>

                  <td class="entry" headers="d36856e124" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d36856e127" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d36856e130" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

<!-- document id=8a1ccc4bbadaffda1ac6a93a2cb011458a3cb2ffa064fb8e2fdac6c5718c9bf8 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_layout.md -->

# Get Record Layout Metadata

Get metadata about page layouts for the specified object type.

Resource

/ui-api/layout/{objectApiName}

objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object.

Available Version

41.0

HTTP Method

GET

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d72763e103">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d72763e106">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d72763e109">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d72763e112">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d72763e115">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d72763e103" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d72763e106" data-title="Type">String</td>

                  <td class="entry" headers="d72763e109" data-title="Description">The layout display size for the record. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d72763e112" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d72763e115" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d72763e103" data-title="Parameter Name"><samp class="codeph nolang">layoutType</samp></td>

                  <td class="entry" headers="d72763e106" data-title="Type">String</td>

                  <td class="entry" headers="d72763e109" data-title="Description">The layout type for the record. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Compact</samp>—Use this value to get a
                        layout that contains a record’s key fields.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Full</samp>—(Default) Use this value to
                        get a full layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d72763e112" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d72763e115" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d72763e103" data-title="Parameter Name"><samp class="codeph nolang">mode</samp></td>

                  <td class="entry" headers="d72763e106" data-title="Type">String</td>

                  <td class="entry" headers="d72763e109" data-title="Description">The access mode for the record. This value determines which fields to get
                    from a layout. Layouts have different fields for create, edit, and view modes.
                    For example, formula fields are rendered in view mode, but not in create mode
                    because they’re calculated at run time, like formulas in a spreadsheet. One of
                    these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Create</samp>—Use this mode if you intend
                        to build UI that lets a user create a record. This mode is used by the
                        <samp class="codeph nolang">/ui-api/record-defaults/create/{apiName}</samp> resource.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Edit</samp>—Use this mode if you intend to
                        build UI that lets a user edit a record. This mode is used by the <samp class="codeph nolang">/ui-api/record-defaults/clone/{recordId}</samp>
                        resource.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">View</samp>—(Default) Use this mode to
                        build UI that displays a record.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d72763e112" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d72763e115" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d72763e103" data-title="Parameter Name"><samp class="codeph nolang">recordTypeId</samp></td>

                  <td class="entry" headers="d72763e106" data-title="Type">Id</td>

                  <td class="entry" headers="d72763e109" data-title="Description">The ID of the record type (RecordType object) for the new record. If not
                    provided, the default record type is used.</td>

                  <td class="entry" headers="d72763e112" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d72763e115" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout.htm#ui_api_responses_record_layout "The layout information for a record.")

#### See Also

- [User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm "Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.")

<!-- document id=d329c5f1923c5b51dcf7f3f4bf1674f2453f70fd2548715915e1f224509333c6 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_actions_get.md -->

# Get Related List Actions with a Request Body

Get the actions on related lists for a record detail page. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.

Resources

/ui-api/actions/record/${recordIds}/related-list/${relatedListId}

- recordIds—The 15 or 18 character ID of a record.
- relatedListId—(Optional) A related list ID. If this parameter isn’t specified, the request returns all related list actions for the specified record. To get actions for a batch of related lists, see [Get a Batch of Related List Actions with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_actions_batch_get.htm "Get the actions on a batch of related lists for a record. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.").

Available Version

57.0

HTTP Method

POST

Example

To get information about related list actions on a record detail page, use this request with a request body.

POST /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list

{
  "apiNames": \["New"\],
  "retrievalMode": "All"
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| listRecordActionsQuery | [Action Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_action_input.htm "Get the actions on related lists on a record detail page.") | The data for related list actions. | Optional | 57.0 |

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

<!-- document id=7e5a630c82b198ebde054fd4ae4c3904ff28c2fe001b9261df0c8b1b99a6783b url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list.md -->

# Get Related List Actions with URL Parameters

Get the actions on related lists on a record detail page via URL parameters.

Resources

/ui-api/actions/record/${recordIds}/related-list/${relatedListId}

- recordIds—The 15 or 18 character ID of a record.
- relatedListId—(Optional) A related list ID. If this parameter isn’t specified, the request returns all related list actions for the specified record. To get actions for a batch of related lists, see [Get a Batch of Related List Actions with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_lists_batch.htm "Get the actions on a batch of related lists for a record via URL parameters.").

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have an Account record detail page with a record ID of 001R0000003IDlwIAG. The page has some related lists, including tasks and events. To get information about all the related list actions on this page, make this request.

GET /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list

The request returns a list of related list actions on the page and the URLs of the request and subrequests.

{
  "actions" : {
    "001R0000003IDlwIAG" : {
      "actions" : \[ {
        "actionListContext" : "RelatedList",
        "actionTarget" : null,
        "actionTargetType" : "Invoke",
        "apiName" : "NewTask",
        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RelatedList:Phone:StandardButton:NewTask",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new\_task\_120.png",
        "id" : "0JVR00000000036OAA",
        "isMassAction" : "false",
        "label" : "New Task",
        "primaryColor" : "4BC076",
        "relatedListRecordId" : null,
        "relatedSourceObject" : "OpenActivities",
        "section" : "Page",
        "sourceObject" : "001R0000003IDlwIAG",
        "subtype" : null,
        "targetObject" : "Task",
        "targetUrl" : null,
        "type" : "StandardButton"
      }, {
        "actionListContext" : "RelatedList",
        "actionTarget" : null,
        "actionTargetType" : "Invoke",
        "apiName" : "NewEvent",
        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RelatedList:Phone:StandardButton:NewEvent",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new\_event\_120.png",
        "id" : "0JVR00000000037OAA",
        "isMassAction" : "false",
        "label" : "New Event",
        "primaryColor" : "EB7092",
        "relatedListRecordId" : null,
        "relatedSourceObject" : "OpenActivities",
        "section" : "Page",
        "sourceObject" : "001R0000003IDlwIAG",
        "subtype" : null,
        "targetObject" : "Event",
        "targetUrl" : null,
        "type" : "StandardButton"
      }

... Additional actions removed for brevity ...

\],
      "links" : \[ \],
      "url" : "/services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list"
    }
  },
  "url" : "/services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d83528e145">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d83528e148">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d83528e151">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d83528e154">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d83528e157">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d83528e145" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d83528e148" data-title="Type">String[]</td>

                  <td class="entry" headers="d83528e151" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d83528e154" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d83528e157" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d83528e145" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d83528e148" data-title="Type">String[]</td>

                  <td class="entry" headers="d83528e151" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d83528e154" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d83528e157" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d83528e145" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d83528e148" data-title="Type">String</td>

                  <td class="entry" headers="d83528e151" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d83528e154" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d83528e157" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d83528e145" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d83528e148" data-title="Type">String</td>

                  <td class="entry" headers="d83528e151" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d83528e154" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d83528e157" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d83528e145" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d83528e148" data-title="Type">String[]</td>

                  <td class="entry" headers="d83528e151" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d83528e154" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d83528e157" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

<!-- document id=793f361776e43097d9882b030fff474ab473162142e994f90103efaa5b849d6b url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_info_md.md -->

# Get Related List Metadata

Returns metadata for a related list in a page layout.

Resource

/ui-api/related-list-info/${parentObjectApiName}/${relatedListId}

- parentObjectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- relatedListId—The ID of a supported related list for that object, such as Contracts.

Available Version

50.0

HTTP Method

GET

Example

To get metadata for the Contracts related list in the Account object, make this request.

GET /services/data/v68.0/ui-api/related-list-info/Account/Contracts

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| fields | String\[\] | Fields in the related list to query. If a field is specified and the user doesn’t have access to it or it doesn’t exist, an error occurs. | Optional | 57.0 |
| optionalFields | String\[\] | Additional fields in the related list to query. If a field is specified and the user doesn’t have access to it, no error occurs. | Optional | 57.0 |
| recordTypeId | Id | The ID of the record type (RecordType object) for the record. If unspecified, the default record type for the context user is used. If there is no default record type for the context user, the Salesforce default record type is used. | Optional | 50.0 |
| restrictColumns​ToLayout | Boolean | Indicates whether to retrieve metadata for only the list columns in the page layout (true) or all columns (false). The default value is true. To further filter columns, also use fields and optionalFields. | Optional | 57.0 |

Response Body

[Related List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm "Metadata that describes a related list.")

<!-- document id=af2ce0f75dbb59a94eae0ace2fd504c59e056dea58b4ec8c834b8ec9f14e8921 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_record.md -->

# Get Related List Record Actions

Get the actions on records in related lists.

Resource

/ui-api/actions/record/${recordId}/related-list-record/${relatedListRecordIds}

relatedListRecordIds—A related list record ID, or a comma-delimited list of related list record IDs.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have an Account record detail page with a record ID of 001R0000003IDlwIAG. The page has a Contacts related list, and one of the Contacts has a record ID of 003R0000007qfC7. To get information about the actions for this contact, make this request:

GET /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG/related-list-record/003R0000007qfC7

The request returns a list of actions for the contact and the URLs of the request and subrequests.

{
        "actionListContext" : "RelatedListRecord",
        "actionTarget" : null,
        "actionTargetType" : "Invoke",
        "apiName" : "Delete",
        "externalId" : "00DR00000008n7M:001R0000003IDlwIAG::RelatedListRecord:Phone:StandardButton:Delete",
        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/delete\_120.png",
        "id" : "0JVR00000000014OAA",
        "isMassAction" : "false",
        "label" : "Delete",
        "primaryColor" : "E6717C",
        "relatedListRecordId" : "003R0000007qfC7",
        "relatedSourceObject" : "Contacts",
        "section" : "Page",
        "sourceObject" : "001R0000003IDlwIAG",
        "subtype" : null,
        "targetObject" : "Contact",
        "targetUrl" : null,
        "type" : "StandardButton"
      }

... Additional actions removed for brevity ...

\],
      "links" : \[ \],
      "url" : "/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG/related-list-record/003R0000007qfC7"
    }
  },
  "url" : "/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG/related-list-record/003R0000007qfC7"
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d88542e126">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d88542e129">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d88542e132">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d88542e135">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d88542e138">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d88542e126" data-title="Parameter Name"><samp class="codeph nolang">actionTypes</samp></td>

                  <td class="entry" headers="d88542e129" data-title="Type">String[]</td>

                  <td class="entry" headers="d88542e132" data-title="Description">
                    <p class="p">The action type. One or more of these values: </p>

                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">CustomButton</samp>—A button that opens a
                        URL or Visualforce page or executes JavaScript.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                        Salesforce action, attached to a limited set of objects.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">QuickAction</samp>—A global or
                        object-specific action.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">StandardButton</samp>—A pre-defined
                        Salesforce button, such as <strong class="ph uicontrol">New</strong>,
                        <strong class="ph uicontrol">Edit</strong>, and <strong class="ph uicontrol">Delete</strong>.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d88542e135" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d88542e138" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d88542e126" data-title="Parameter Name"><samp class="codeph nolang">apiNames</samp></td>

                  <td class="entry" headers="d88542e129" data-title="Type">String[]</td>

                  <td class="entry" headers="d88542e132" data-title="Description">The API names of one or more actions to be retrieved. Use this parameter
                    only when passing <samp class="codeph nolang">retrievalMode=All</samp>. </td>

                  <td class="entry" headers="d88542e135" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d88542e138" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d88542e126" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d88542e129" data-title="Type">String</td>

                  <td class="entry" headers="d88542e132" data-title="Description">The layout display size. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—(Default) Use this value to
                        get a layout for desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—Use this value to get a
                        layout for tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—Use this value to get a
                        layout for phone display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d88542e135" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d88542e138" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d88542e126" data-title="Parameter Name"><samp class="codeph nolang">retrievalMode</samp></td>

                  <td class="entry" headers="d88542e129" data-title="Type">String</td>

                  <td class="entry" headers="d88542e132" data-title="Description">When the action context is <samp class="codeph nolang">Record</samp>,
                    this parameter indicates which actions to retrieve from the record page. One
                    of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">All</samp>—Retrieves all actions specified
                        in the <samp class="codeph nolang">apiNames</samp> parameter.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">PageLayout</samp>—(Default) Retrieves
                        actions from the page layout.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d88542e135" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d88542e138" data-title="Available Version">49.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d88542e126" data-title="Parameter Name"><samp class="codeph nolang">sections</samp></td>

                  <td class="entry" headers="d88542e129" data-title="Type">String[]</td>

                  <td class="entry" headers="d88542e132" data-title="Description">The section of the user interface that the actions reside in. One or more
                    of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                    </ul>

                  </td>

                  <td class="entry" headers="d88542e135" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d88542e138" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm#ui_api_responses_action "The actions for a single record or a collection of records.")

<!-- document id=491979fca2b975b4442ad25ac1acb9028ade679bbc61988e7ed6b2520a90639d url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_count.md -->

# Get Related List Record Count

Returns the record count for a related list.

Resource

/ui-api/related-list-count/${parentRecordId}/${relatedListId}

- parentRecordId—The ID of the record you want to get related lists for.
- relatedListId—The ID of a supported related list for that object.

Available Version

50.0

HTTP Method

GET

Example

To get the number of records in the Contracts related list for the account 001RM000003UNu6YAG, make this request.

/services/data/v68.0/ui-api/related-list-count/001RM000003UNu6YAG/Contracts

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| maxCount | Integer | The maximum number of records to return. The default value is 20. | Optional | 50.0 |

Response Body

[Related List Record Count](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_record_count.htm "The number of records in a given related list.")

<!-- document id=2c51d5a41b9febe3619e7f87df3890a2abe5d0d79aa1cd5c4327333924e4a63a url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_records_get.md -->

# Get Related List Records with a Request Body

Returns record data for up to 1,999 records in a related list. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.

Resources

/ui-api/related-list-records/${parentRecordId}/${relatedListId}

- parentRecordId—The ID of the record you want to get related lists for.
- relatedListId—The API name of a supported related list for that object, such as Contacts. In API version 62.0 and later, relatedListId supports the API name of a child relationship.

Available Version

55.0

HTTP Method

POST

Example

To get record data for the Contacts related list for the account record 001xx000003GYOpAAO, use this request.

POST /ui-api/related-list-records/001xx000003GYOpAAO/Contacts

{
 "fields": \["Name", "Id", "Birthdate"\],
 "optionalFields": \["Email"\],
 "sortBy": \["CreatedDate"\],
 "pageSize": 10,
 "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}"
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| listRecordsQuery | [Related List Records Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_record_input.htm "Get record data for up to 1,999 records in a related list.") | The record data for the related list. | Required | 55.0 |

Response Body

[Related List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_record_collection.htm "A collection of related list records.")

<!-- document id=403633b5bbcf8f4b4c848e3409f973a082707f2196c836c6c7ae3c20df9a6737 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_records.md -->

# Get Related List Records with URL Parameters

Returns record data for up to 1,999 records in a related list via URL parameters.

Resources

/ui-api/related-list-records/${parentRecordId}/${relatedListId}

- parentRecordId—The ID of the record you want to get related lists for.
- relatedListId—The API name of a supported related list for that object, such as Contracts. In API version 62.0 and later, relatedListId supports the API name of a child relationship.

Available Version

50.0

HTTP Method

GET

Example

To get metadata for the Contracts related list for the account record 001RM000003UNu6YAG, make this request.

/services/data/v68.0/ui-api/related-list-records/001RM000003UNu6YAG/Contracts

To get metadata for the Contracts related list for the account record 001RM000003UNu6YAG, and also retrieve the ContractNumber field, make this request.

/services/data/v68.0/ui-api/related-list-records/001RM000003UNu6YAG/Contracts?fields=Contract.ContractNumber

Request Parameters

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

#### Note

To get record data for a related list without complex URL parameters, you can use the POST method and enter request parameters in the request body. See [Get a Related List Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_get.htm "Returns record data for up to 1,999 records in a related list. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.").

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d89531e156">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d89531e159">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d89531e162">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d89531e165">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d89531e168">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d89531e156" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d89531e159" data-title="Type">String[]</td>

                  <td class="entry" headers="d89531e162" data-title="Description"><span class="ph" id="fields_param_desc"><a name="fields_param_desc"><!-- --></a>Fields queried for the records returned. These
                      fields are included in the response body and don’t create visible columns.
                      If the field isn’t available to the user, an error occurs.</span></td>

                  <td class="entry" headers="d89531e165" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d89531e168" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d89531e156" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d89531e159" data-title="Type">String[]</td>

                  <td class="entry" headers="d89531e162" data-title="Description"><span class="ph" id="optionalFields_param_desc"><a name="optionalFields_param_desc"><!-- --></a>Additional fields queried for the
                      records returned. These fields are included in the response body and don’t
                      create visible columns. If the field isn’t available to the user, no error
                      occurs and the field isn’t included in the records.</span></td>

                  <td class="entry" headers="d89531e165" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d89531e168" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d89531e156" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d89531e159" data-title="Type">Integer</td>

                  <td class="entry" headers="d89531e162" data-title="Description"><span class="ph" id="pageSize_param_desc"><a name="pageSize_param_desc"><!-- --></a>The number of list records viewed at one
                      time. The default value is 50. Value can be 1–1999.</span></td>

                  <td class="entry" headers="d89531e165" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d89531e168" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d89531e156" data-title="Parameter Name"><samp class="codeph nolang">pageToken</samp></td>

                  <td class="entry" headers="d89531e159" data-title="Type">String</td>

                  <td class="entry" headers="d89531e162" data-title="Description"><span class="ph" id="pageToken_param_desc"><a name="pageToken_param_desc"><!-- --></a>The token for additional pages of records
                      beyond the first page. To fetch another page, use the value returned by
                      <samp class="codeph nolang">nextPageToken</samp>from the previous
                      page.</span></td>

                  <td class="entry" headers="d89531e165" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d89531e168" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d89531e156" data-title="Parameter Name"><samp class="codeph nolang">sortBy</samp></td>

                  <td class="entry" headers="d89531e159" data-title="Type">String[]</td>

                  <td class="entry" headers="d89531e162" data-title="Description">
                    <span class="ph" id="sortBy_param_desc"><a name="sortBy_param_desc"><!-- --></a>The API names of the fields that the related
                      list is sorted by. If the name is preceded with <samp class="codeph nolang">-</samp>, the sort order is descending. For example, <samp class="codeph nolang">Name</samp> sorts by name in ascending order.
                      <samp class="codeph nolang">-CreatedDate</samp> sorts by created date in
                      descending order. </span>
                    <p class="p">In API version 63.0 and later, you can sort by up
                      to five fields. If a field is invalid or isn’t accessible to the context
                      user, this parameter is ignored, but no error occurs.</p>
                  </td>

                  <td class="entry" headers="d89531e165" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d89531e168" data-title="Available Version">50.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d89531e156" data-title="Parameter Name"><samp class="codeph nolang">where</samp></td>

                  <td class="entry" headers="d89531e159" data-title="Type">String</td>

                  <td class="entry" headers="d89531e162" data-title="Description">
                    <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.uiapi.meta/uiapi/images/icon_note.png" alt="Note">
                            <div class="mediaBd">
                              <h4 class="mbs">Note</h4>
                              <p>The <samp class="codeph nolang">where</samp> parameter isn’t supported
                                for GET requests.</p>
                            </div>
                          </div>
                        </div>
                      </div>
                    </div>

                  </td>

                  <td class="entry" headers="d89531e165" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d89531e168" data-title="Available Version">55.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Related List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_record_collection.htm "A collection of related list records.")

<!-- document id=bc4492e635a61ef13e7c6afea8a6bd985324ae82fb32ccaf01b34dc4e0e8b3e3 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_preferences_get.md -->

# Get Related List User Preferences

Returns user preferences for a related list.

Resource

/ui-api/related-list-preferences/${preferencesId}

- preferencesId—The ID of user preferences for a related list, for example, Account.RelatedContactList.

Available Version

57.0

HTTP Method

GET

Example

To get information about user preferences for a Contact related list on an Account, make this request.

GET /services/data/v68.0/ui-api/related-list-preferences/Account.RelatedContactList

Response Body

[Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_user_preferences.htm "User preferences for a related list.")

<!-- document id=82454a6eae647a531dd5483618256d687d270dae1ad69b7e149878bc1ef794c4 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_object.md -->

# Get Related Lists for an Object

Returns the related lists in an object’s default layout.

Resource

/ui-api/related-list-info/${parentObjectApiName}

- parentObjectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.

Available Version

50.0

HTTP Method

GET

Example

To get information about related lists for the Account object, make this request:

GET /services/data/v68.0/ui-api/related-list-info/Account

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| recordTypeId | Id | The ID of the record type (RecordType object) for the record. If not provided, the default record type is used. | Optional | 50.0 |

Response Body

[Related List Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_summary_collection.htm "A collection of related lists for a given object.")

<!-- document id=04156559e07a193000e16a7a2928af422cdf55ded9f36a4c96ef80aca9ceaebf url=/legacydeveloper/current/en-us/uiapi/ui_api_get_started.md -->

# Get Started with User Interface API

Build Salesforce UI for native mobile apps and custom web apps using the same API that Salesforce uses to build Lightning Experience and Salesforce for Android, iOS, and mobile web. Build user interfaces that let users work with records, list views, actions, favorites, and more. Not only do you get data and metadata in a single response, but the response matches metadata changes made to the org by Salesforce admins. You don’t have to worry about layouts, picklists, field-level security, or sharing—all you have to do is build an app that users love.

The User Interface API base URL is https://{your\_instance}.salesforce.com/services/data/v{api\_version}/ui-api.

The Record UI resource shows the power of User Interface API. To display a record, your code makes this simple request:

GET /ui-api/record-ui/001R0000003GeJ1IAK

Behind the scenes, Salesforce does the heavy lifting.

- Checks field-level security settings, sharing settings, and perms.
- Makes SOQL queries to get record data.
- Gets object metadata and theme information.
- Gets layout information.

You’re one happy developer, because Salesforce transforms the results into an easy-to-consume JSON response with all the metadata and data necessary to display the record.

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

#### Note

Most User Interface API resource actions aren’t exposed as static methods in Apex.

In addition to building UI for Salesforce records, you can also use User Interface API to build UI for Salesforce actions, favorites, and list views.

- **[User Interface API Release Notes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_release_notes.htm)**  
    The API release notes include updates to the request bodies, response bodies, and resources.
- **[User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm)**  
    Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.
- **[User Interface API Sample Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_sample_apps.htm)**  
    We’ve built two sample apps that use User Interface API to create, read, update, and delete records. The apps are open-source and available on GitHub.
- **[Authentication, Versioning, Limits, ETag, and More](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_intro.htm)**  
    Learn the high-level facts about how to use User Interface API. How do you authenticate? How is the API versioned? What are the rate limits? All the information you need, available at a glance.
- **[Status Codes and Error Responses](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_errors.htm)**  
    The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred.
- **[API End-of-Life Policy](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/api_ui_eol.htm)**  
    Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. To mature and improve the quality and performance of the API, versions that are more than three years old sometimes are no longer supported.

<!-- document id=d869f7641feb4fafa379a1ce8da02327d07e951ef64e3c4b4aa667e3258be3ea url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_picklist_values.md -->

# Get Values for a Picklist Field

If a field’s dataType property is equal to Picklist or MultiPicklist, use this resource to get its values.

Resource

/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}

- objectApiName—The API name of a [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object.
- recordTypeId—The ID of the record type.
- fieldApiName—The API name of the picklist field on the object.

Available Version

41.0

HTTP Method

GET

Response Body

[Picklist Values](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_values.htm#ui_api_responses_picklist_values "The picklist values for a field, scoped to a record type. If a picklist is dependent, this response includes the values of its immediate controlling field and how they map to the picklist.")

#### See Also

- [Build UI for Picklists](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_dependent_picklist.htm "User Interface API exposes properties and resources that make it easy for a client to build picklists and dependent picklists.")
- [Get Values for All Picklist Fields of a Record Type](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm "Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request.")
- [Get Record Data and Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm "Get layout information, metadata, and data to build UI for a single record or for a collection of records.")
- [Get Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info.htm "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.")
- [User Interface API Quick Start](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_quick_start_postman.htm "Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.")

<!-- document id=9d80c1dd4e91d025d585e38efaba3cf7305468a1044861919dcd03724257d555 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_picklist_values_collection.md -->

# Get Values for All Picklist Fields of a Record Type

Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents\_\_c, Countries\_\_c, Cities\_\_c), use this resource to get all the values for each picklist in one request.

This resource is available as a static method in Apex in API version 66.0 and later. See [getPicklistValuesByRecordType(objectApiName, recordTypeId)](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_ConnectAPI_RecordUi_static_methods.htm#apex_ConnectAPI_RecordUi_getPicklistValuesByRecordType_1) in the Apex Reference Guide.

Resource

/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}

- objectApiName—The API name of a [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object.
- recordTypeId—The ID of the record type.

Available Version

42.0

HTTP Method

GET

Response Body

[Picklist Values Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_values_collection.htm#ui_api_responses_picklist_values_collection "A collection of picklist values for all the picklists of a specified record type.")

#### See Also

- [Build UI for Picklists](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_dependent_picklist.htm "User Interface API exposes properties and resources that make it easy for a client to build picklists and dependent picklists.")
- [Get Values for a Picklist Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values.htm "If a field’s dataType property is equal to Picklist or MultiPicklist, use this resource to get its values.")

<!-- document id=2b54d1181765d3eecaa8e01963973bf2b62476244b7bc92254f130fe962bb35f url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_lead_status_picklist_values.md -->

# Lead Status Picklist Value Attributes

Additional picklist value attributes for lead statuses.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d116275e39">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d116275e42">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d116275e45">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d116275e48">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d116275e51">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d116275e39" data-title="Property Name"><samp class="codeph nolang">converted</samp></td>

              <td class="entry" headers="d116275e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d116275e45" data-title="Description">If this status indicates the lead has been converted, the value is <samp class="codeph nolang">true</samp>, otherwise <samp class="codeph nolang">false</samp>.</td>

              <td class="entry" headers="d116275e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d116275e51" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d116275e39" data-title="Property Name"><samp class="codeph nolang">picklistAtrributes​ValueType</samp></td>

              <td class="entry" headers="d116275e42" data-title="Type">String</td>

              <td class="entry" headers="d116275e45" data-title="Description">The value is <samp class="codeph nolang">LeadStatus</samp>. Indicates that
                these value attributes are associated with the status of a lead.<p class="p">For more
                  information, see the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_leadstatus.htm" target="_blank">LeadStatus object documentation</a>.</p>
                <p class="p">The
                  property <samp class="codeph nolang">picklistAtrributes​ValueType</samp>
                  contains a typographical error.</p>
              </td>

              <td class="entry" headers="d116275e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d116275e51" data-title="Available Version">41.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Picklist Value](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_value.htm "A single picklist value.")

<!-- document id=fdad879c417433c24f767e446f6a78ae5e0c924503be382665a10484b22bfd24 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_column.md -->

# List Column

A column in a list.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fieldApiName | String | The API name for the field. | Small, 42.0 | 42.0 |
| inlineEditAttributes | Map<String, [List Column Inline Edit Attributes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_column_inline_edit_attributes.htm "List column inline edit attributes.")\> | Map of record type ID to inline edit attributes for the column. | Small, 61.0 | 61.0 |
| label | String | The label of the field. | Small, 42.0 | 42.0 |
| lookupId | String | The ID of the field if the field is a reference. If the field isn’t a reference, the value can be null. | Small, 58.0 | 58.0 |
| searchable | Boolean | Indicates whether the list column is searchable. | Small, 61.0 | 61.0 |
| sortable | Boolean | Indicates whether the list column is sortable. | Small, 42.0 | 42.0 |

#### See Also

- [Get List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records_md.htm "Get record data and metadata for a list view.")
- [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")

<!-- document id=51efeff8397d9ac95d44f78f4ce9298dbb77d836c060f8f1b561e8eaf749a012 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_column_inline_edit_attributes.md -->

# List Column Inline Edit Attributes

List column inline edit attributes.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| editable | Boolean | Indicates whether the column can be edited inline. | Small, 61.0 | 61.0 |
| required | Boolean | Indicates whether the column is required to be populated when inline editing. | Small, 61.0 | 61.0 |

#### See Also

- [List Column](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_column.htm "A column in a list.")

<!-- document id=94e9df4a6fbf99ca590af454e3fb74c2619a654769621361886cc5302534911d url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_filter_by_info.md -->

# List Filter by Info

Information used to filter a list.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d117838e33">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d117838e35">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d117838e37">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d117838e39">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d117838e41">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d117838e33" data-title="Property Name"><samp class="codeph nolang">fieldApiName</samp></td>
              <td class="entry" headers="d117838e35" data-title="Type">String</td>
              <td class="entry" headers="d117838e37" data-title="Description">The API name for the field used to filter the list.</td>
              <td class="entry" headers="d117838e39" data-title="Filter Group and Version">Small, 42.0</td>
              <td class="entry" headers="d117838e41" data-title="Available Version">42.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d117838e33" data-title="Property Name"><samp class="codeph nolang">label</samp></td>
              <td class="entry" headers="d117838e35" data-title="Type">String</td>
              <td class="entry" headers="d117838e37" data-title="Description">The label for the field used to filter the list.</td>
              <td class="entry" headers="d117838e39" data-title="Filter Group and Version">Small, 42.0</td>
              <td class="entry" headers="d117838e41" data-title="Available Version">42.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d117838e33" data-title="Property Name"><samp class="codeph nolang">operandLabels</samp></td>
              <td class="entry" headers="d117838e35" data-title="Type">String[]</td>
              <td class="entry" headers="d117838e37" data-title="Description">The values (or label if one exists) used to filter the list.</td>
              <td class="entry" headers="d117838e39" data-title="Filter Group and Version">Small, 42.0</td>
              <td class="entry" headers="d117838e41" data-title="Available Version">42.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d117838e33" data-title="Property Name"><samp class="codeph nolang">operator</samp></td>
              <td class="entry" headers="d117838e35" data-title="Type">String</td>
              <td class="entry" headers="d117838e37" data-title="Description">The filter operator. One of these values: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Contains</samp></li>

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

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

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

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

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

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

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

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

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

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

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

                </ul>
              </td>
              <td class="entry" headers="d117838e39" data-title="Filter Group and Version">Small, 42.0</td>
              <td class="entry" headers="d117838e41" data-title="Available Version">42.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [Get List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records_md.htm "Get record data and metadata for a list view.")
- [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")
- [Related List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm "Metadata that describes a related list.")

<!-- document id=40771ea291131508914221b8bc85c118e22c897e4a310acdfd1f9c1ccdd73159 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_filter_by_info_input.md -->

# List Filter By Info Input

List filter by info to update or create.

JSON example

{
"fieldApiName": "Name",
"operandLabels": \[ "This", "That"\],
"operator": "Equals"
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d23337e59">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d23337e62">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d23337e65">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d23337e68">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d23337e71">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d23337e59" data-title="Name"><samp class="codeph nolang">fieldApiName</samp></td>

                  <td class="entry" headers="d23337e62" data-title="Type">String</td>

                  <td class="entry" headers="d23337e65" data-title="Description">API name for the field used to filter the list.</td>

                  <td class="entry" headers="d23337e68" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23337e71" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d23337e59" data-title="Name"><samp class="codeph nolang">operandLabels</samp></td>

                  <td class="entry" headers="d23337e62" data-title="Type">String[]</td>

                  <td class="entry" headers="d23337e65" data-title="Description">Values (or label if one exists) used to filter the list.</td>

                  <td class="entry" headers="d23337e68" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23337e71" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d23337e59" data-title="Name"><samp class="codeph nolang">operator</samp></td>

                  <td class="entry" headers="d23337e62" data-title="Type">String</td>

                  <td class="entry" headers="d23337e65" data-title="Description">Filter operator. Values are:<ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Contains</samp></li>

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

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

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

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

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

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

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

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

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

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

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

                    </ul>
                  </td>

                  <td class="entry" headers="d23337e68" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23337e71" data-title="Available Version">61.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [List Info Post Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_info_post_input.htm "Info to create a list.")
- [List Info Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_info_input.htm "Info to update a list.")

<!-- document id=c0abafc9143221b3241ff9cecd7440ecf886e29ac86386808701f34eccc65433 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_metadata.md -->

# List Info

Metadata that describes a list.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d121798e33">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d121798e35">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d121798e37">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d121798e39">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d121798e41">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">cloneable</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">Boolean</td>

              <td class="entry" headers="d121798e37" data-title="Description">Indicates whether the list can be cloned.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">createable</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">Boolean</td>

              <td class="entry" headers="d121798e37" data-title="Description">Indicates whether a list for the object can be created.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">deletable</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">Boolean</td>

              <td class="entry" headers="d121798e37" data-title="Description">Indicates whether the list can be deleted.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">displayColumns</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_column.htm#ui_api_responses_list_column" title="A column in a list.">List
                  Column</a>[]
              </td>

              <td class="entry" headers="d121798e37" data-title="Description">All display columns for the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">filterLogicString</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">String</td>

              <td class="entry" headers="d121798e37" data-title="Description">The filter logic string, such as (1 OR 2) and 3. Indexes start with 1.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">filteredByInfo</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_filter_by_info.htm#ui_api_responses_list_filter_by_info" title="Information used to filter a list.">List Filter by
                  Info</a>[]
              </td>

              <td class="entry" headers="d121798e37" data-title="Description">Filtering information for the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">hasMassActions</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">Boolean</td>

              <td class="entry" headers="d121798e37" data-title="Description">Indicates whether the list has mass actions.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 62.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">62.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">id</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_reference.htm" title="The list view referenced by the collection or metadata.">List Reference</a></td>

              <td class="entry" headers="d121798e37" data-title="Description">Identity information for the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0 only</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">inlineEditDetails</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_inline_edit_details.htm" title="List inline edit details.">List Inline Edit Details</a></td>

              <td class="entry" headers="d121798e37" data-title="Description">Inline edit details for the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">String</td>

              <td class="entry" headers="d121798e37" data-title="Description">The list’s display label. For example, All Accounts.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">listReference</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_reference.htm" title="The list view referenced by the collection or metadata.">List Reference</a></td>

              <td class="entry" headers="d121798e37" data-title="Description">Object representing the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">listShares</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_share_category.htm" title="List info share category.">List Info Share Category</a></td>

              <td class="entry" headers="d121798e37" data-title="Description">Items that the list is shared with.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">listViewApiName</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">String</td>

              <td class="entry" headers="d121798e37" data-title="Description">The list’s API name. For example, <samp class="codeph nolang">AllAccounts</samp> or <samp class="codeph nolang">__Recent</samp>, for the
                most recently used (MRU) list view for the object.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0 only</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">objectApiNames</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">String[]</td>

              <td class="entry" headers="d121798e37" data-title="Description">API names of objects that are returned by the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">orderedByInfo</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_order_by_info.htm#ui_api_responses_list_order_by_info" title="Ordering information for a list.">List Order By
                  Info</a>[]
              </td>

              <td class="entry" headers="d121798e37" data-title="Description">Ordering information for the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">scope</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_scope.htm" title="List scope.">List Scope</a></td>

              <td class="entry" headers="d121798e37" data-title="Description">Scope information for the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">searchable</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">Boolean</td>

              <td class="entry" headers="d121798e37" data-title="Description">Indicates whether the list can be searched.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">updateable</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">Boolean</td>

              <td class="entry" headers="d121798e37" data-title="Description">Indicates whether the list can be updated.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">userPreferences</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_user_preference.htm#ui_api_responses_list_user_preference" title="User preferences for the list view.">List User
                  Preference</a></td>

              <td class="entry" headers="d121798e37" data-title="Description">User preferences for the list.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">visibility</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">String</td>

              <td class="entry" headers="d121798e37" data-title="Description">Visibility of the list. One of these values: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Private</samp></li>

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

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

                </ul>
              </td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d121798e33" data-title="Property Name"><samp class="codeph nolang">visibilityEditable</samp></td>

              <td class="entry" headers="d121798e35" data-title="Type">Boolean</td>

              <td class="entry" headers="d121798e37" data-title="Description">Indicates whether the visibility of the list can be edited.</td>

              <td class="entry" headers="d121798e39" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d121798e41" data-title="Available Version">42.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [Get Most Recently Used List View Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_mru_list_views_md.htm "Get metadata for an object’s most recently viewed (MRU) list view.")
- [List UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_ui.htm "The record data and metadata for a list view.")
- [Get List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records_md.htm "Get record data and metadata for a list view.")
- [Update List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md_patch.htm "Update list view metadata.")
- [Create a List View for an Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_post.htm "Create a list view associated with an object.")
- [Get List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md.htm "Get list view metadata.")

<!-- document id=a55fe6b1c4d3c0a560c7af829301593987dca7fbd6522bef22b15bd32dedc3b9 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_info_input.md -->

# List Info Input

Info to update a list.

Example

This example uses a request body to update the metadata for a list view. The object API name is Account and the list view API name is AllAccounts.

PATCH /services/data/v68.0/ui-api/list-info/Account/AllAccounts

{
"filteredByInfo": \[
  {
  "fieldApiName": "Name",
  "operandLabels": \[ "This", "That"\],
  "operator": "Equals"
  },
  {
  "fieldApiName": "Phone",
  "operandLabels": \[ "919"\],
  "operator": "StartsWith"
  },
{
  "fieldApiName": "AnnualRevenue",
  "operandLabels": \[ "1000000"\],
  "operator": "GreaterThan"
  }
\],
"filterLogicString" : "(1 OR 2) AND 3",
"label": "Accounts opened this year",
"scope": {
  "apiName": "entity",
  "entityId": "00Gxx000000sjI8",
  "relatedEntityId": "701xx000003HZ7X"
},
"visibility": "Public"
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d23962e69">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d23962e72">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d23962e75">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d23962e78">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d23962e81">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d23962e69" data-title="Name"><samp class="codeph nolang">displayColumns</samp></td>

                  <td class="entry" headers="d23962e72" data-title="Type">String[]</td>

                  <td class="entry" headers="d23962e75" data-title="Description">Display columns (field API names) for the list.</td>

                  <td class="entry" headers="d23962e78" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23962e81" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d23962e69" data-title="Name"><samp class="codeph nolang">filterLogicString</samp></td>

                  <td class="entry" headers="d23962e72" data-title="Type">String</td>

                  <td class="entry" headers="d23962e75" data-title="Description">Filter logic string, such as (1 OR 2) and 3. Indexes start with
                    1.</td>

                  <td class="entry" headers="d23962e78" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23962e81" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d23962e69" data-title="Name"><samp class="codeph nolang">filteredByInfo</samp></td>

                  <td class="entry" headers="d23962e72" data-title="Type">
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_filter_by_info_input.htm" title="List filter by info to update or create.">List Filter By Info Input</a>[]
                  </td>

                  <td class="entry" headers="d23962e75" data-title="Description">Filtering information for the list.</td>

                  <td class="entry" headers="d23962e78" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23962e81" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d23962e69" data-title="Name"><samp class="codeph nolang">label</samp></td>

                  <td class="entry" headers="d23962e72" data-title="Type">String</td>

                  <td class="entry" headers="d23962e75" data-title="Description">List’s display label, for example, All Accounts.</td>

                  <td class="entry" headers="d23962e78" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23962e81" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d23962e69" data-title="Name"><samp class="codeph nolang">listShares</samp></td>

                  <td class="entry" headers="d23962e72" data-title="Type">String[]</td>

                  <td class="entry" headers="d23962e75" data-title="Description">Objects the list is shared with, if visibility is shared.</td>

                  <td class="entry" headers="d23962e78" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23962e81" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d23962e69" data-title="Name"><samp class="codeph nolang">scope</samp></td>

                  <td class="entry" headers="d23962e72" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_scope_input.htm" title="List scope to update or create.">List Scope Input</a></td>

                  <td class="entry" headers="d23962e75" data-title="Description">Scope information for the list.</td>

                  <td class="entry" headers="d23962e78" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23962e81" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d23962e69" data-title="Name"><samp class="codeph nolang">visibility</samp></td>

                  <td class="entry" headers="d23962e72" data-title="Type">String</td>

                  <td class="entry" headers="d23962e75" data-title="Description">List’s visibility. One of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Private</samp></li>

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

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

                    </ul>
                  </td>

                  <td class="entry" headers="d23962e78" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d23962e81" data-title="Available Version">61.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Update List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md_patch.htm "Update list view metadata.")

<!-- document id=ffb9f29001db7fca4ae85386f11a82c449e0328b4f118031d1a586b4ac0fadf3 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_info_post_input.md -->

# List Info Post Input

Info to create a list.

Example

This example uses a request body to create the metadata for an account list view.

POST /services/data/v68.0/ui-api/list-info/Account

{
"listViewApiName": "MyAccountListView",
"filteredByInfo": \[
  {
  "fieldApiName": "Name",
  "operandLabels": \[ "This", "That"\],
  "operator": "Equals"
  },
  {
  "fieldApiName": "Phone",
  "operandLabels": \[ "919"\],
  "operator": "StartsWith"
  },
{
  "fieldApiName": "AnnualRevenue",
  "operandLabels": \[ "1000000"\],
  "operator": "GreaterThan"
  }
\],
"filterLogicString" : "(1 OR 2) AND 3",
"label": "Accounts opened this year",
"scope": {
  "apiName": "entity",
  "entityId": "00Gxx000000sjI8",
  "relatedEntityId": "701xx000003HZ7X"
},
"visibility": "Public"
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d24998e63">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d24998e66">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d24998e69">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d24998e72">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d24998e75">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d24998e63" data-title="Name"><samp class="codeph nolang">displayColumns</samp></td>

                  <td class="entry" headers="d24998e66" data-title="Type">String[]</td>

                  <td class="entry" headers="d24998e69" data-title="Description">Display columns (field API names) for the list.</td>

                  <td class="entry" headers="d24998e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d24998e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d24998e63" data-title="Name"><samp class="codeph nolang">filterLogicString</samp></td>

                  <td class="entry" headers="d24998e66" data-title="Type">String</td>

                  <td class="entry" headers="d24998e69" data-title="Description">Filter logic string, such as (1 OR 2) and 3. Indexes start with
                    1.</td>

                  <td class="entry" headers="d24998e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d24998e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d24998e63" data-title="Name"><samp class="codeph nolang">filteredByInfo</samp></td>

                  <td class="entry" headers="d24998e66" data-title="Type">
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_filter_by_info_input.htm" title="List filter by info to update or create.">List Filter By Info Input</a>[]
                  </td>

                  <td class="entry" headers="d24998e69" data-title="Description">Filtering information for the list.</td>

                  <td class="entry" headers="d24998e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d24998e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d24998e63" data-title="Name"><samp class="codeph nolang">label</samp></td>

                  <td class="entry" headers="d24998e66" data-title="Type">String</td>

                  <td class="entry" headers="d24998e69" data-title="Description">List’s display label, for example, All Accounts.</td>

                  <td class="entry" headers="d24998e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d24998e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d24998e63" data-title="Name"><samp class="codeph nolang">listShares</samp></td>

                  <td class="entry" headers="d24998e66" data-title="Type">String[]</td>

                  <td class="entry" headers="d24998e69" data-title="Description">Objects the list is shared with, if visibility is shared. <p class="p">For role
                      sharing, use <samp class="codeph nolang">Role.<var class="keyword varname">RoleAPIName</var></samp>. For group sharing, use
                      <samp class="codeph nolang"><var class="keyword varname">groupType.GroupApiName</var></samp>, where
                      <var class="keyword varname">groupType</var> is one of the <samp class="codeph nolang">type</samp> values for the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_group.htm" target="_blank">Group</a> object.
                    </p>
                  </td>

                  <td class="entry" headers="d24998e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d24998e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d24998e63" data-title="Name"><samp class="codeph nolang">listViewApiName</samp></td>

                  <td class="entry" headers="d24998e66" data-title="Type">String</td>

                  <td class="entry" headers="d24998e69" data-title="Description">API name for the list. This property is optional but strongly
                    recommended. If unspecified, a default API name is generated.</td>

                  <td class="entry" headers="d24998e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d24998e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d24998e63" data-title="Name"><samp class="codeph nolang">scope</samp></td>

                  <td class="entry" headers="d24998e66" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_scope_input.htm" title="List scope to update or create.">List Scope Input</a></td>

                  <td class="entry" headers="d24998e69" data-title="Description">Scope information for the list.</td>

                  <td class="entry" headers="d24998e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d24998e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d24998e63" data-title="Name"><samp class="codeph nolang">visibility</samp></td>

                  <td class="entry" headers="d24998e66" data-title="Type">String</td>

                  <td class="entry" headers="d24998e69" data-title="Description">List’s visibility. One of these values: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Private</samp></li>

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

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

                    </ul>
                  </td>

                  <td class="entry" headers="d24998e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d24998e75" data-title="Available Version">61.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Create a List View for an Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_post.htm "Create a list view associated with an object.")

<!-- document id=84dc0610c80ca6e7eaaca91d8f862b1f3aa90fdfcb7cf690a914471691d157b5 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_info_share.md -->

# List Info Share

List info share.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| label | String | Label for the shared item. | Small, 61.0 | 61.0 |
| shareApiName | String | API name for the shared item. | Small, 61.0 | 61.0 |

#### See Also

- [List Info Share Category](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_share_category.htm "List info share category.")

<!-- document id=1b9ea07dbb80fbc9cc943713e8efb5466b6c3c2e460fb127eacbdd2f9ad888c3 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_info_share_category.md -->

# List Info Share Category

List info share category.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d118910e27">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d118910e29">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d118910e31">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d118910e33">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d118910e35">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d118910e27" data-title="Property Name"><samp class="codeph nolang">shareType</samp></td>
              <td class="entry" headers="d118910e29" data-title="Type">String</td>
              <td class="entry" headers="d118910e31" data-title="Description">Share type for the category. Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ChannelProgramGroup</samp></li>

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

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

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

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

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

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

                </ul>
              </td>
              <td class="entry" headers="d118910e33" data-title="Filter Group and Version">Small, 61.0</td>
              <td class="entry" headers="d118910e35" data-title="Available Version">61.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d118910e27" data-title="Property Name"><samp class="codeph nolang">shares</samp></td>
              <td class="entry" headers="d118910e29" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_share.htm" title="List info share.">List Info Share</a>[]
              </td>
              <td class="entry" headers="d118910e31" data-title="Description">Shares in the category.</td>
              <td class="entry" headers="d118910e33" data-title="Filter Group and Version">Small, 61.0</td>
              <td class="entry" headers="d118910e35" data-title="Available Version">61.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")

<!-- document id=45a5ecba0bbf55b0baae90d7d79e05bf4f2c2ff86df9e3dc349ae390e60e8c93 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_info_summary.md -->

# List Info Summary

List info summary.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | API name of the list. | Small, 61.0 | 61.0 |
| id | String | ID of the list. | Small, 61.0 | 61.0 |
| label | String | List's label. | Small, 61.0 | 61.0 |
| url | String | List’s UI URL. | Small, 61.0 | 61.0 |

#### See Also

- [List Info Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_summary_collection.htm "List info summary collection.")

<!-- document id=e33839fd2d286e670d02f4757ed8754e07c8176cee559b898c68e51260793c56 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_info_summary_collection.md -->

# List Info Summary Collection

List info summary collection.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| count | Integer | Total count of lists returned. | Small, 61.0 | 61.0 |
| currentPageToken | String | Page token of the current page of lists. | Small, 61.0 | 61.0 |
| currentPageUrl | String | URL of the current page of lists. | Small, 61.0 | 61.0 |
| lists | [List Info Summary](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_summary.htm "List info summary.")\[\] | Collection of list summaries. | Small, 61.0 | 61.0 |
| nextPageToken | String | Page token of the next page of lists. | Small, 61.0 | 61.0 |
| nextPageUrl | String | URL of the next page of lists. | Small, 61.0 | 61.0 |
| objectApiName | String | API name of the object in the URL. | Small, 61.0 | 61.0 |
| pageSize | Integer | Page size specified in the query parameter or the default value. | Small, 61.0 | 61.0 |
| previousPageToken | String | Page token of the previous page of lists. | Small, 61.0 | 61.0 |
| previousPageUrl | String | URL of the previous page of lists. | Small, 61.0 | 61.0 |
| queryString | String | Query string specified in the query parameter or null. | Small, 61.0 | 61.0 |
| recentListsOnly | Boolean | Indicates whether recent lists only were returned (true) or not (false). | Small, 61.0 | 61.0 |

#### See Also

- [Get List Views for an Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_get.htm "Get list views associated with an object.")

<!-- document id=cf39afc19ebfb07556f6fd3c3fa7351c73832ba9d5362d0aac4bbc1db1d3dd43 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_inline_edit_details.md -->

# List Inline Edit Details

List inline edit details.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d121425e27">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d121425e29">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d121425e31">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d121425e33">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d121425e35">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d121425e27" data-title="Property Name"><samp class="codeph nolang">message</samp></td>
              <td class="entry" headers="d121425e29" data-title="Type">String</td>
              <td class="entry" headers="d121425e31" data-title="Description">Message describing why inline edit is off.</td>
              <td class="entry" headers="d121425e33" data-title="Filter Group and Version">Small, 61.0</td>
              <td class="entry" headers="d121425e35" data-title="Available Version">61.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d121425e27" data-title="Property Name"><samp class="codeph nolang">state</samp></td>
              <td class="entry" headers="d121425e29" data-title="Type">String</td>
              <td class="entry" headers="d121425e31" data-title="Description">State of inline edit for the list. Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Disabled</samp></li>

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

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

                </ul>
              </td>
              <td class="entry" headers="d121425e33" data-title="Filter Group and Version">Small, 61.0</td>
              <td class="entry" headers="d121425e35" data-title="Available Version">61.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")

<!-- document id=c519187853fa7d0a019eec73381f8c1b4ad67a1bf41317c48a0b7c66d4d0ff5e url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_object_column.md -->

# List Object Column

List object column.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d124606e27">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d124606e29">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d124606e31">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d124606e33">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d124606e35">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">alias</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">String</td>

              <td class="entry" headers="d124606e31" data-title="Description">Alias for the column.</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">dataType</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">String</td>

              <td class="entry" headers="d124606e31" data-title="Description">Data type for the column. Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Address</samp></li>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">defaultFilter​Operator</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">String</td>

              <td class="entry" headers="d124606e31" data-title="Description">Default filter operator for the column. </td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">displayable</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">Boolean</td>

              <td class="entry" headers="d124606e31" data-title="Description">Indicates whether the column is displayable (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">fieldApiName</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">String</td>

              <td class="entry" headers="d124606e31" data-title="Description">Field API name for the column.</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">filterable</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">Boolean</td>

              <td class="entry" headers="d124606e31" data-title="Description">Indicates whether the column is filterable (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">String</td>

              <td class="entry" headers="d124606e31" data-title="Description">Label for the column.</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">picklistValues</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_picklist_value.htm" title="List object picklist value.">List Object Picklist Value</a>[]
              </td>

              <td class="entry" headers="d124606e31" data-title="Description">List of allowed picklist values for the column.</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">quickFilter​Operator</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">String</td>

              <td class="entry" headers="d124606e31" data-title="Description">Operator to use for quick filters on the column.</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 64.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">64.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">quickFilter​Overrides</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_quick_filter_overrides.htm" title="List object column quick filter overrides.">List Object Quick Filter Overrides</a></td>

              <td class="entry" headers="d124606e31" data-title="Description">Optional overrides to use for quick filters on the column.</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 64.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">64.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">quickFilterable</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">Boolean</td>

              <td class="entry" headers="d124606e31" data-title="Description">Indicates whether the column can have quick filters (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 64.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">64.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">sortable</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">Boolean</td>

              <td class="entry" headers="d124606e31" data-title="Description">Indicates whether the column is sortable (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d124606e27" data-title="Property Name"><samp class="codeph nolang">supportedFilter​Operators</samp></td>

              <td class="entry" headers="d124606e29" data-title="Type">String[]</td>

              <td class="entry" headers="d124606e31" data-title="Description">Supported filter operators for the column. Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Contains</samp></li>

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

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

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

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

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

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

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

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d124606e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d124606e35" data-title="Available Version">61.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [List Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_info.htm "List object info.")

<!-- document id=881e19394b5cddf21b1409b0f6ffa9faad07a2bb3931fc9bbec251cd2c95530a url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_object_info.md -->

# List Object Info

List object info.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d126668e27">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d126668e29">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d126668e31">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d126668e33">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d126668e35">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d126668e27" data-title="Property Name"><samp class="codeph nolang">availableScopes</samp></td>

              <td class="entry" headers="d126668e29" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_scope.htm" title="List object scope.">List Object Scope</a>[]
              </td>

              <td class="entry" headers="d126668e31" data-title="Description">Information about available scopes for the object.</td>

              <td class="entry" headers="d126668e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d126668e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d126668e27" data-title="Property Name"><samp class="codeph nolang">columns</samp></td>

              <td class="entry" headers="d126668e29" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_column.htm" title="List object column.">List Object Column</a>[]
              </td>

              <td class="entry" headers="d126668e31" data-title="Description">Information about available columns for the object.</td>

              <td class="entry" headers="d126668e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d126668e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d126668e27" data-title="Property Name"><samp class="codeph nolang">createable</samp></td>

              <td class="entry" headers="d126668e29" data-title="Type">Boolean</td>

              <td class="entry" headers="d126668e31" data-title="Description">Indicates whether a new list for the object can be created (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d126668e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d126668e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d126668e27" data-title="Property Name"><samp class="codeph nolang">objectApiName</samp></td>

              <td class="entry" headers="d126668e29" data-title="Type">String</td>

              <td class="entry" headers="d126668e31" data-title="Description">Object API name.</td>

              <td class="entry" headers="d126668e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d126668e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d126668e27" data-title="Property Name"><samp class="codeph nolang">public​Createable</samp></td>

              <td class="entry" headers="d126668e29" data-title="Type">Boolean</td>

              <td class="entry" headers="d126668e31" data-title="Description">Indicates whether the context user can create a public list view for the object
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">If <samp class="codeph nolang">publicCreateable</samp> is
                  <samp class="codeph nolang">true</samp>, <samp class="codeph nolang">sharedCreateable</samp> is also <samp class="codeph nolang">true</samp>.
                </p>
              </td>

              <td class="entry" headers="d126668e33" data-title="Filter Group and Version">Small, 67.0</td>

              <td class="entry" headers="d126668e35" data-title="Available Version">67.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d126668e27" data-title="Property Name"><samp class="codeph nolang">publicOrShared​Createable</samp></td>

              <td class="entry" headers="d126668e29" data-title="Type">Boolean</td>

              <td class="entry" headers="d126668e31" data-title="Description">Indicates whether the context user can create a public list view for the object
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">This property is deprecated in version 67.0 In version 67.0
                  and later, we recommend using <samp class="codeph nolang">publicCreateable</samp> or <samp class="codeph nolang">shared​Createable</samp> for this information.</p>
              </td>

              <td class="entry" headers="d126668e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d126668e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d126668e27" data-title="Property Name"><samp class="codeph nolang">relatedEntity​ApiName</samp></td>

              <td class="entry" headers="d126668e29" data-title="Type">String</td>

              <td class="entry" headers="d126668e31" data-title="Description">API name of the related object to which this list can be scoped, or
                null.</td>

              <td class="entry" headers="d126668e33" data-title="Filter Group and Version">Small, 61.0</td>

              <td class="entry" headers="d126668e35" data-title="Available Version">61.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d126668e27" data-title="Property Name"><samp class="codeph nolang">shared​Createable</samp></td>

              <td class="entry" headers="d126668e29" data-title="Type">Boolean</td>

              <td class="entry" headers="d126668e31" data-title="Description">Indicates whether the context user can create a shared list view for the object
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d126668e33" data-title="Filter Group and Version">Small, 67.0</td>

              <td class="entry" headers="d126668e35" data-title="Available Version">67.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [Get Metadata for a List View Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_md_get.htm "Get metadata for a list view object.")

<!-- document id=8cdfed5cb19060fe8de6371ce1b8a59d275251fa582f178e9df6cce53f06f5d2 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_object_picklist_value.md -->

# List Object Picklist Value

List object picklist value.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | API name for the picklist value. | Small, 61.0 | 61.0 |
| label | String | Label for the picklist value. | Small, 61.0 | 61.0 |

#### See Also

- [List Object Column](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_column.htm "List object column.")

<!-- document id=96b9364944e6dfe34d56d7952f60e1bcbd91a930129f2e5670f606d012b78b6e url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_object_quick_filter_overrides.md -->

# List Object Quick Filter Overrides

List object column quick filter overrides.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| dataType | String | Data type to use for quick filters for the column. | Small, 64.0 | 64.0 |
| picklistValues | Map<String, String>\[\] | Picklist values to use for quick filters for the column. | Small, 64.0 | 64.0 |

#### See Also

- [List Object Column](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_column.htm "List object column.")

<!-- document id=490a3869d129b7aba975072999230b2d7541d45c45fb8c320e023b8c828258be url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_object_scope.md -->

# List Object Scope

List object scope.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | API name for the scope. | Small, 61.0 | 61.0 |
| availableEntities | [List Object Scope Available Entity](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_scope_available_entity.htm "List object scope available entity, such as a group or queue.")\[\] | Available entities, such as groups or queues, for the scope. | Small, 61.0 | 61.0 |
| label | String | Label for the scope. | Small, 61.0 | 61.0 |

#### See Also

- [List Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_info.htm "List object info.")

<!-- document id=5b8ab31257cdf11ecbca885590c297caed08fe51dcef40bc8dccaae278e5863b url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_object_scope_available_entity.md -->

# List Object Scope Available Entity

List object scope available entity, such as a group or queue.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| id | String | ID for the available entity. | Small, 61.0 | 61.0 |
| label | String | Label for the available entity. | Small, 61.0 | 61.0 |

#### See Also

- [List Object Scope](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_scope.htm "List object scope.")

<!-- document id=b7040a362cbcdf1389292b661e9b60c0987da71e87cb40db6517fd9d6e3950e4 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_order_by_info.md -->

# List Order By Info

Ordering information for a list.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fieldApiName | String | The API name for the field. | Small, 42.0 | 42.0 |
| isAscending | Boolean | Indicates whether the list column is ascending or descending. | Small, 42.0 | 42.0 |
| label | String | The localized label of the field. | Small, 42.0 | 42.0 |

#### See Also

- [Get List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records_md.htm "Get record data and metadata for a list view.")
- [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")
- [Related List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm "Metadata that describes a related list.")
- [Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_user_preferences.htm "User preferences for a related list.")
- [List Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_preferences.htm "List preferences.")

<!-- document id=a312cc805c737e9403621f26c7517cd0f05d45ff9dae6dbafc86fe8832f15736 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_order_by_input.md -->

# List Order By Input

Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.

Example

This example uses a request body to update the metadata for the Contracts related list for the Account object:

PATCH /services/data/v68.0/ui-api/related-list-info/Account/Contracts

{ 
  "orderedByInfo" : \[{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }\],
  "userPreferences" : {
    "columnWidths" : {
        "Name" : -1
    },
    "columnWrap" : {
        "Name" : false
    }
  }
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| fieldApiName | String | The API name for the field. | Optional | 50.0 |
| isAscending | Boolean | Indicates whether the list column is ascending or descending. | Optional | 50.0 |

#### See Also

- [Related List Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_input.htm "A related list to update.")
- [Related List User Preferences Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_user_preferences_input.htm "User preferences to update for a related list.")
- [List Preferences Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_preferences_input.htm "List preferences to update.")
- [Lookup Post Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_lookup_post_input.htm "Get lookup field suggestions.")

<!-- document id=3ab71ee1ec530394dd8c0cbbb1999cb113d0ab2fb835c9a7a925f621fc62bcec url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_preferences.md -->

# List Preferences

List preferences.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| columnWidths | Map<String, Integer> | Column width preferences for the list. | Small, 61.0 | 61.0 |
| columnWrap | Map<String, Boolean> | Column wrapping preferences for the list. | Small, 61.0 | 61.0 |
| listReference | [List Reference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_reference.htm "The list view referenced by the collection or metadata.") | Reference information for the list. | Small, 61.0 | 61.0 |
| orderedBy | [List Order By Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_order_by_info.htm "Ordering information for a list.")\[\] | Ordering preference for the list. | Small, 61.0 | 61.0 |

#### See Also

- [Get List View Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_preferences_get.htm "Get list view preferences.")
- [Update List View Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_preferences_update.htm "Update list view preferences.")

<!-- document id=6f3d2c94e64ed97fde61c8b8aa5e6237c9bbb03c5067148e75a43f7255497df1 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_preferences_input.md -->

# List Preferences Input

List preferences to update.

Example

This example updates list preferences for the All Accounts list view.

PATCH /services/data/v68.0/ui-api/list-preferences/Account/AllAccounts

{
"columnWidths" : {
  "Name" : 200
  },
"columnWrap" : {
  "Name" : false
  },
"orderedBy" : \[{
  "fieldApiName": "Name",
  "isAscending" : true
  }\]
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d26631e63">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d26631e66">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d26631e69">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d26631e72">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d26631e75">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d26631e63" data-title="Name"><samp class="codeph nolang">columnWidths</samp></td>

                  <td class="entry" headers="d26631e66" data-title="Type">Map&lt;String, Integer&gt;</td>

                  <td class="entry" headers="d26631e69" data-title="Description">Column width preferences to update. If you pass a null value, preferences
                    reset to the default.</td>

                  <td class="entry" headers="d26631e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d26631e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d26631e63" data-title="Name"><samp class="codeph nolang">columnWrap</samp></td>

                  <td class="entry" headers="d26631e66" data-title="Type">Map&lt;String, Boolean&gt;</td>

                  <td class="entry" headers="d26631e69" data-title="Description">Column wrap preferences to update. If you pass a null value, preferences
                    reset to the default.</td>

                  <td class="entry" headers="d26631e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d26631e75" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d26631e63" data-title="Name"><samp class="codeph nolang">orderedBy</samp></td>

                  <td class="entry" headers="d26631e66" data-title="Type">
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm" title="Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.">List Order By Input</a>[]
                  </td>

                  <td class="entry" headers="d26631e69" data-title="Description">Ordering preferences to update. If you pass a null value, preferences
                    reset to the default.<p class="p">In API version 63.0 and later, you can sort by up to
                      five columns. In earlier versions, results are sorted by the first
                      column.</p>
                  </td>

                  <td class="entry" headers="d26631e72" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d26631e75" data-title="Available Version">61.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Update List View Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_preferences_update.htm "Update list view preferences.")

<!-- document id=e8040e39f380e0a1d3db205e6d0122f2dd6cdf273202ad57abe14b5fc9eef638 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_record_collection.md -->

# List Record Collection

A collection of list view records.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| count | Integer | The total count of records returned. | Small, 43.0 | 43.0 |
| currentPageToken | String | The token for the current page of records. | Small, 43.0 | 43.0 |
| currentPageUrl | String | The URL of the current page of records. | Small, 43.0 | 43.0 |
| fields | String\[\] | List of fields specified in the request. If a field isn’t available to the user, an error occurs. | Small, 48.0 | 48.0 |
| listInfoETag | String | An [ETag](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_intro.htm#ui_api_get_started_intro "Learn the high-level facts about how to use User Interface API. How do you authenticate? How is the API versioned? What are the rate limits? All the information you need, available at a glance.") that indicates whether the metadata has changed. | Small, 42.0 | 42.0 |
| listReference | [List Reference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_reference.htm "The list view referenced by the collection or metadata.") | The list the records belong to. | Small, 48.0 | 48.0 |
| nextPageToken | String | The token for the next page of records. | Small, 43.0 | 43.0 |
| nextPageUrl | String | The URL of the next page of records. | Small, 43.0 | 43.0 |
| optionalFields | String\[\] | Optional fields specified in the request. If a field isn’t available to the user, no error occurs and the field isn’t included in the response. | Small, 48.0 | 48.0 |
| pageSize | Integer | The number of list records viewed at one time. The default value is 50. | Small, 48.0 | 48.0 |
| previousPageToken | String | The token for the previous page of records. | Small, 43.0 | 43.0 |
| previousPageUrl | String | The URL of the previous page of records. | Small, 43.0 | 43.0 |
| records | [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.")\[\] | A collection of records. | Small, 43.0 | 43.0 |
| searchTerm | String | Search term specified in the request. | Small, 61.0 | 61.0 |
| sortBy | String | The API name of the field the list view is sorted by. If the name is preceded with \-, the sort order is descending. | Small, 48.0 | 48.0 |
| where | String | Where string specified in the request. | Small, 61.0 | 61.0 |

#### See Also

- [Get Most Recently Used List View Records (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_mru_list_views_records.htm "Get record data for an object’s most recently used (MRU) list view.")
- [Get List View Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records.htm "Get record data for a list view using URL parameters.")
- [Get List View Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view_records_post.htm "Get record data for a list view using a request body.")
- [List UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_ui.htm "The record data and metadata for a list view.")

<!-- document id=06d35bc6bcf70660e917e76bec6304792547098c938bc0c877bb1e2e66ce9282 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_records_input.md -->

# List Records Input

Record data to query for a list view.

Example

This example uses a request body to query a list view named All Accounts.

POST /services/data/v68.0/ui-api/list-records/Account/AllAccounts

{
  "fields": \["Name", "Type", "AnnualRevenue", "CreatedDate"\],
  "pageSize" : 10,
  "sortBy": \["CreatedDate"\],
  "searchTerm" : "United",
  "where": "{AnnualRevenue: { gt: 1000000}}"
}

This example uses the special \_\_Recent list view API name to get the record data for the most recently used (MRU) list view for accounts.

POST /services/data/v68.0/ui-api/list-records/Account/\_\_Recent

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d27149e72">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d27149e75">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d27149e78">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d27149e81">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d27149e84">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d27149e72" data-title="Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d27149e75" data-title="Type">String[]</td>

                  <td class="entry" headers="d27149e78" data-title="Description">Additional fields queried for the records returned. These fields don’t
                    create visible columns. If the field isn’t available to the user, an error
                    occurs.</td>

                  <td class="entry" headers="d27149e81" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d27149e84" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d27149e72" data-title="Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d27149e75" data-title="Type">String[]</td>

                  <td class="entry" headers="d27149e78" data-title="Description">Additional fields queried for the records returned. These fields don’t
                    create visible columns. If the field isn’t available to the user, no error
                    occurs and the field isn’t included in the records.</td>

                  <td class="entry" headers="d27149e81" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d27149e84" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d27149e72" data-title="Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d27149e75" data-title="Type">Integer</td>

                  <td class="entry" headers="d27149e78" data-title="Description">The number of list records viewed at one time. The default value is 50.
                    Value can be 1–2000.</td>

                  <td class="entry" headers="d27149e81" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d27149e84" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d27149e72" data-title="Name"><samp class="codeph nolang">pageToken</samp></td>

                  <td class="entry" headers="d27149e75" data-title="Type">String</td>

                  <td class="entry" headers="d27149e78" data-title="Description">A token that represents the page offset. To indicate where the page
                    starts, use this value with the <samp class="codeph nolang">pageSize</samp>
                    parameter. The maximum offset is 2000 and the default is 0.</td>

                  <td class="entry" headers="d27149e81" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d27149e84" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d27149e72" data-title="Name"><samp class="codeph nolang">searchTerm</samp></td>

                  <td class="entry" headers="d27149e75" data-title="Type">String</td>

                  <td class="entry" headers="d27149e78" data-title="Description">Search term to filter the results. Wildcards are supported.</td>

                  <td class="entry" headers="d27149e81" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d27149e84" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d27149e72" data-title="Name"><samp class="codeph nolang">sortBy</samp></td>

                  <td class="entry" headers="d27149e75" data-title="Type">String[]</td>

                  <td class="entry" headers="d27149e78" data-title="Description">The API names of the fields the list view is sorted by. If the name is
                    preceded with <samp class="codeph nolang">-</samp>, the sort order is
                    descending. For example, <samp class="codeph nolang">Name</samp> sorts by
                    name in ascending order. <samp class="codeph nolang">-CreatedDate</samp>
                    sorts by created date in descending order.<p class="p">In API version 63.0 and later,
                      you can sort by up to five fields.</p>
                  </td>

                  <td class="entry" headers="d27149e81" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d27149e84" data-title="Available Version">61.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d27149e72" data-title="Name"><samp class="codeph nolang">where</samp></td>

                  <td class="entry" headers="d27149e75" data-title="Type">String</td>

                  <td class="entry" headers="d27149e78" data-title="Description">The filter applied to returned records, in GraphQL syntax. For example,
                    <samp class="codeph nolang">{ and: [ { StageName: { eq: "Prospecting" } },
                      { Account: { Name: { eq: "Dickenson plc" } } } ] }</samp> filters an
                    Opportunity related list to show only opportunities in the Prospecting stage
                    that are linked to the “Dickenson plc” account.
                  </td>

                  <td class="entry" headers="d27149e81" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d27149e84" data-title="Available Version">61.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Get List View Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view_records_post.htm "Get record data for a list view using a request body.")

<!-- document id=356878cfbc995f6588f4e3f1d36654890fadfdc2156e74e0b1791d562933e711 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_reference.md -->

# List Reference

The list view referenced by the collection or metadata.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| id | String | The list view ID. | Small, 42.0 | 42.0 |
| listViewApiName | String | The list view's API name, for example, AllAccounts | Small, 43.0 | 43.0 |
| objectApiName | String | A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account. | Small, 42.0 | 42.0 |
| type | String | The list view type. | Small, 42.0 | 42.0 |

#### See Also

- [List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_record_collection.htm "A collection of list view records.")
- [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")
- [List Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_preferences.htm "List preferences.")

<!-- document id=aa4f0578873f64d1eb64b97328f4b747c380956804c78b2bbf5a00dac7164036 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_scope.md -->

# List Scope

List scope.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | API name for the scope. | Small, 61.0 | 61.0 |
| entity | [List Scope Entity](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_scope_entity.htm "List scope entity.") | Entity for the scope. | Small, 61.0 | 61.0 |
| label | String | Label for the scope. | Small, 61.0 | 61.0 |
| relatedEntity | [List Scope Related Entity](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_scope_related_entity.htm "List scope related entity.") | Related entity for the scope. | Small, 61.0 | 61.0 |

#### See Also

- [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")

<!-- document id=6155e125e3231d477b6380c5f04b8a9bd58583a6d1e7c1c5c4df50eeaacf4618 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_scope_entity.md -->

# List Scope Entity

List scope entity.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| id | String | ID of the scope entity. | Small, 61.0 | 61.0 |
| label | String | Label for the scope entity. | Small, 61.0 | 61.0 |

#### See Also

- [List Scope](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_scope.htm "List scope.")

<!-- document id=5b4f3b6248984c0b086aa6390f5a63134aeb3957930c8a59e807085d2f2ea591 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_scope_input.md -->

# List Scope Input

List scope to update or create.

JSON example

{
"apiName": "entity",
"entityId": "00Gxx000000sjI8",
"relatedEntityId": "701xx000003HZ7X"
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | API name of the list’s scope. | Optional | 61.0 |
| entityId | String | ID of the scope’s entity. | Optional | 61.0 |
| relatedEntityId | String | ID of the related entity for the scope. | Optional | 61.0 |

#### See Also

- [List Info Post Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_info_post_input.htm "Info to create a list.")
- [List Info Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_info_input.htm "Info to update a list.")

<!-- document id=eeef7b647de513e8337c6488a1c8b06f2536b9eda8802d5e976b9e70a80eaae4 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_scope_related_entity.md -->

# List Scope Related Entity

List scope related entity.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| id | String | ID of the scope entity. | Small, 61.0 | 61.0 |
| label | String | Label for the scope entity. | Small, 61.0 | 61.0 |
| type | String | Type of scope entity. | Small, 61.0 | 61.0 |

#### See Also

- [List Scope](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_scope.htm "List scope.")

<!-- document id=89eb61b1b875160c1c3eaca0e0d1ac257f875ce643d19a4dfdd32d462123b636 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_ui.md -->

# List UI

The record data and metadata for a list view.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| info | [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm#ui_api_responses_list_metadata "Metadata that describes a list.") | The metadata for the list view. | Small, 42.0 | 42.0 |
| records | [List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_record_collection.htm#ui_api_responses_list_record_collection "A collection of list view records.") | The record data for the list view. | Small, 42.0 | 42.0 |

#### See Also

- [Get Most Recently Used List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_mru_list_views_records_md.htm "Get record data and metadata for an object’s most recently used (MRU) list view.")
- [Get List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records_md.htm "Get record data and metadata for a list view.")

<!-- document id=6470f6923f0ef44a795998d354b840737f19f9a19189f68f70c5f0f34ec75dd6 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_user_preference.md -->

# List User Preference

User preferences for the list view.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| columnWidths | Map<String, Integer> | Column width preferences for the list view. Maps a column name to a width. | Small, 42.0 | 42.0 |
| columnWrap | Map<String, Boolean> | Column wrapping preferences for the list view. Maps a column name to a boolean that indicates whether the column text wraps. | Small, 42.0 | 42.0 |

#### See Also

- [Get List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records_md.htm "Get record data and metadata for a list view.")
- [List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")
- [Related List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm "Metadata that describes a related list.")

<!-- document id=9e8453fccf1ac3040a639d38a7b9b235d8debe1cdd24cf2a5ab074440ccff73f url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_list_user_preference_input.md -->

# List User Preference Input

A related list user preferences to update.

Example

This example uses a request body to update the metadata for the Contracts related list for the Account object:

PATCH /services/data/v68.0/ui-api/related-list-info/Account/Contracts

{ 
  "orderedByInfo" : \[{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }\],
  "userPreferences" : {
    "columnWidths" : {
        "Name" : -1
    },
    "columnWrap" : {
        "Name" : false
    }
  }
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| columnWidths | Map<String, Integer> | Column width preferences.\-1 indicates default width. | Optional | 50.0 |
| columnWrap | Map<String, Boolean> | Indicates whether the column text wraps. | Optional | 50.0 |

#### See Also

- [Related List Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_input.htm "A related list to update.")

<!-- document id=4a3be4836740a388c70ddbaa4f3685ab9741440f3ecc0547059305e921c1fe89 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_view_summary.md -->

# List View Summary

A summary of list views for an object.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | The list view's object API name. | Small, 43.0 | 43.0 |
| id | String | ID of the list view. | Small, 43.0 | 43.0 |
| label | String | The list view's label. | Small, 43.0 | 43.0 |
| listUiUrl | String | The list view’s UI URL. | Small, 43.0 | 43.0 |

#### See Also

- [List View Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_view_summary_collection.htm "A collection of list views for a given object.")

<!-- document id=f7d0ff2c37bec885c550c2f88d5ab10ed431a354a0d80dceda326e1e4e7858a4 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_list_view_summary_collection.md -->

# List View Summary Collection

A collection of list views for a given object.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| count | Integer | The total number of list views returned. | Small, 43.0 | 43.0 |
| currentPageToken | String | The pageToken of the current page of list views. | Small, 43.0 | 43.0 |
| currentPageUrl | String | The URL of the current page of list views. | Small, 43.0 | 43.0 |
| lists | [List View Summary](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_view_summary.htm "A summary of list views for an object.") | Collection of list views for the given object | Small, 43.0 | 43.0 |
| nextPageToken | String | The pageToken of the next page of list views. | Small, 43.0 | 43.0 |
| nextPageUrl | String | The URL of the next page of list views | Small, 43.0 | 43.0 |
| objectApiName | String | A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account. | Small, 48.0 | 48.0 |
| pageSize | Integer | The number of list records viewed at one time. The default value is 20. | Small, 48.0 | 48.0 |
| previousPageToken | String | The pageToken of the previous page of list views. | Small, 43.0 | 43.0 |
| previousPageUrl | String | The URL of the previous page of list views. | Small, 43.0 | 43.0 |
| queryString | String | The query string used in the query parameter. | Small, 48.0 | 48.0 |
| recentListsOnly | Boolean | Show only recently viewed lists. The default value is false. | Small, 48.0 | 48.0 |

#### See Also

- [Get List Views for an Object (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_object.htm "Get a collection of list views associated with an object.")

<!-- document id=ae1793382e2373b41cd0b50db1e0c2eba10a726f78ec1d1989f230ef7d390289 url=/legacydeveloper/current/en-us/uiapi/ui_api_list_view_supported_objects.md -->

# List View Supported Objects

List views support a subset of the standard objects that User Interface API supports.

For general information about supported objects, see [Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm "User Interface API supports all custom objects and external objects and many standard objects.").

This list includes the standard objects supported for list views.

As of Summer ’23, all new standard objects are auto-enabled for UI API usage. This list might not reflect the latest object support. To check if list views are supported for a specific object in UI API, use the [/ui-api/list-info/{objectApiName} resource](https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_resources_lists_object_get.htm).

- AcademicSession
- AcademicTerm
- AcademicTermEnrollment
- AcademicYear
- Account
- AccountAccountRelation
- AccountBrand
- AccountForecast
- AccountParticipant
- Accreditation
- AcctMgrTarget
- ActionableList
- ActionCadence
- ActionPlan
- ActionPlanBaseTemplateAsgn
- ActionPlanItem
- ActionPlanTemplate
- ActionPlanTemplateAssignment
- ActionPlanTemplateItem
- ActionPlanTemplateItemValue
- ActionPlanTemplateVersion
- ActionPlnTmplItmDependency
- ActionVisibility
- ActivityTiming
- AdBuyServerAccount
- AdCreativeSizeType
- AddOnDefinition
- Address
- AdOpportunity
- AdOrderItem
- AdOrderItemCreativeSizeType
- AdOrderItemPrintIssue
- AdOrderItemUnitsSplit
- AdOrderLineAdTarget
- AdPageLayoutType
- AdProductDefaultTargetCategory
- AdProductTargetCategory
- AdQuote
- AdQuoteLineCreativeSizeType
- AdQuoteLinePrintIssue
- AdQuoteLineUnitsSplit
- AdServer
- AdServerUser
- AdSpaceSpecification
- AdTargetCategory
- AdTargetCategorySegment
- AdUsage
- AdUsageSummary
- AdvAccountForecastFact
- AdvAcctForecastSetPartner
- AdvAcctForecastSetUse
- AffinityScore
- AiDataset
- AirTravelEmssnFctr
- AirTravelEnrgyUse
- AISentimentResult
- AiVisionModel
- AiVisionModelMetric
- AiVisionModelObjectMetric
- AiVisitRecommendation
- AiVisitRecommendRequest
- AiVisitSummary
- AiVisitTaskRcmd
- AiVisitTaskRcmdRequest
- AltenativePaymentMethod
- AnnualEmssnInventory
- AnnualEmssnRdctnTarget
- AntiCorruptionInitSum
- ApiAnomalyEventStore
- ApplicationCase
- ApplicationDecision
- ApplicationFormTemplate
- ApplicationRecommendation
- ApplicationRecommender
- ApplicationReview
- ApplicationTimeline
- AppointmentInvitation
- AppointmentInvitee
- AppointmentTopicTimeSlot
- ApptBundleAggrDurDnscale
- ApptBundleAggrPolicy
- ApptBundleConfig
- ApptBundlePolicy
- ApptBundlePolicySvcTerr
- ApptBundlePropagatePolicy
- ApptBundleRestrictPolicy
- ApptBundleSortPolicy
- ApptReasonEngmtChannelType
- AsmtQstnRespRecommendation
- Assessment
- AssessmentEnvelope
- AssessmentEnvelopeItem
- AssessmentIndicatorDefinition
- AssessmentQuestion
- AssessmentQuestionAssignment
- AssessmentQuestionResponse
- AssessmentQuestionSet
- AssessmentQuestionVersion
- AssessmentSignature
- AssessmentTask
- AssessmentTaskDefinition
- AssessmentTaskOrder
- Asset
- AssetAccountParticipant
- AssetContactParticipant
- AssetDowntimePeriod
- AssetMilestone
- AssetStatePeriod
- AssetWarranty
- AssignedResource
- AssociatedLocation
- AssortmentProduct
- AsyncOperationLog
- AttributeCategory
- AttributePicklist
- AttributePicklistValue
- AuthApplicationAsset
- AuthApplicationPlace
- AuthorizationFormConsent
- AuthorizedInsuranceLine
- AuthorNote
- AuthProvider
- Award
- BackgroundOperation
- BatchJob
- BatchJobDefinition
- BatchJobPart
- BatchJobPartFailedRecord
- BenefitAssignment
- BenefitAssignmentAdjustment
- BenefitDisbursement
- BenefitDisbursementAdj
- BenefitSchedule
- BenefitSession
- BenefitType
- BillingBatchFilterCriteria
- BillingBatchScheduler
- BillingTreatmentItem
- BldgEnrgyIntensity
- BldgEnrgyIntensityVal
- BldgSizeCategory
- BoardCertification
- BroadcastCommAudience
- BroadcastCommunication
- BroadcastTopic
- Budget
- BudgetAllocation
- BudgetCategory
- BudgetCategoryValue
- BudgetPeriod
- BundledCareFeeAgreement
- BusinessAlert
- BusinessAlertStatus
- BusinessBrand
- BusinessLicense
- BusinessLicenseApplication
- BusinessMilestone
- BusinessProfile
- BusinessType
- BusRegAuthorizationType
- BuyerGroupPricebook
- Campaign
- CapitationCareFeeAgreement
- CardPaymentMethod
- CareBarrier
- CareBarrierType
- CareBenefitVerifyRequest
- CareDeterminant
- CareDeterminantType
- CareDiagnosis
- CareEpisode
- CareEpisodeDetail
- CareFeeScheduleItem
- CareInterventionType
- CareMetricTarget
- CarePgmEnrolleeWkOrdStep
- CarePgmEnrolleeWorkOrderv
- CarePgmProvHealthcareProvider
- CarePlan
- CarePlanActivity
- CarePlanActivityDetail
- CarePlanDetail
- CarePlanTemplate
- CarePlanTemplateBenefit
- CarePlanTemplateGoal
- CarePlanTemplateProblem
- CarePreauth
- CarePreauthItem
- CareProgram
- CareProgramCampaign
- CareProgramEligibilityRule
- CareProgramEnrollee
- CareProgramEnrolleeProduct
- CareProgramEnrollmentCard
- CareProgramGoal
- CareProgramProduct
- CareProgramProvider
- CareProgramTeamMember
- CareProviderAdverseAction
- CareProviderFacilitySpecialty
- CareProviderSearchableField
- CareRegisteredDevice
- CareRequest
- CareRequestDrug
- CareRequestExtension
- CareRequestItem
- CareRequestReviewer
- CareSpecialty
- CareSpecialtyTaxonomy
- CareTaxonomy
- CartDeliveryGroup
- CartItem
- CartTax
- Case
- CaseComment
- CaseParticipant
- CaseProgram
- CaseRelatedFile
- CaseRelatedIssue
- CategorizedCareFeeAgreement
- ChangeRequest
- ChangeRequestRelatedIssue
- ChannelProgram
- ChannelProgramLevel
- Claim
- ClaimCase
- ClaimCoverage
- ClaimCoveragePaymentDetail
- ClaimCoverageReserveDetail
- ClaimCovPaymentAdjustment
- ClaimCovReserveAdjustment
- ClaimItem
- ClaimParticipant
- ClaimPaymentSummary
- ClaimPayoutPlan
- ClaimRecovery
- ClaimTeamMember
- ClinicalDetectedIssue
- ClinicalDetectedIssueDetail
- ClinicalEncounter
- ClinicalEncounterDiagnosis
- ClinicalEncounterFacility
- ClinicalEncounterProvider
- ClinicalEncounterReason
- CloudServiceProvider
- CodeSet
- CodeSetBundle
- CodeSetRelationship
- CollaborationRoom
- CommissionSchedule
- CommissionScheduleAssignment
- CommsRegionDiscount
- CommsVolumeDiscount
- ComplaintCase
- ComplaintParticipant
- ConstituentRole
- Contact
- ContactContactRelation
- ContactEncounter
- ContactEncounterParticipant
- ContactPointAddress
- ContactProfile
- ContactRequest
- ContentDocument
- ContentNote
- ContentVersion
- Contract
- ContractDocumentVersion
- ContractDocVerContentDoc
- ContractDocVersionSection
- ContractGroupPlan
- ContractGroupPlanGroupClass
- ContractLineItem
- ContractPaymentAgreement
- ConversationBroadcastEntry
- Coupon
- CourseOffering
- CourseOfferingParticipant
- CourseOfferingPtcpResult
- CourseOfferingSchedule
- CourseOfferingScheduleTmpl
- CourtAction
- CourtActionOutcome
- CoverageBenefit
- CoverageBenefitItem
- CoverageType
- CrbnCreditAlloc
- CrbnCreditAllocItem
- CrbnCreditDistribution
- CrbnCreditProject
- CrbnEmssnScopeAlloc
- CrbnEmssnScopeAllocVal
- CredentialStuffingEventStore
- CreditMemo
- CreditMemoAddressGroup
- CreditMemoInvApplication
- CreditMemoLine
- Crisis
- CryptoTransEnvelopeChgLog
- Customer
- CustomerProperty
- CustomObjectParticipant
- DataLakeObjectInstance
- DelegatedAccount
- DeleteEvent
- DeliveryTask
- DiagnosticSummaryDetail
- DigitalSignature
- DigitalWallet
- Disclosure
- DisclsReportingPeriod
- DistributorAuthorization
- DivrsEquityInclSum
- DocumentChecklistItem
- DocumentClause
- DocumentClauseSet
- DocumentEnvelope
- DocumentTemplate
- DuplicateRecordItem
- DuplicateRecordSet
- DynamicDataCapture
- EconomicPerformanceSum
- EditionDefinition
- EducationalInfoRequest
- ElectricityEmssnFctrSet
- EmailContent
- EmailTemplate
- EmissionsActivity
- EmissionsForecastFact
- EmpBenefitSummary
- Employee
- EmployeeCrisisAssessment
- EmployeeDemographicSum
- EmployeeDevelopmentSum
- EmpUserProvisioningProcess
- EmpUserProvisionProcessErr
- EmssnRdctnCommitment
- EmssnReductionTarget
- EnablementProgram
- EngagementAttendee
- EngagementChannelWorkType
- EngagementInteraction
- EngagementTopic
- Entitlement
- EntityMilestone
- EnvironmentalRisk
- EnvironmentHubMember
- Examination
- Expense
- ExpenseReport
- ExpenseReportEntry
- ExpressionSetView
- ExtDataShare
- ExtDataShareTarget
- FeeScheduleDefinition
- FieldPermissions
- FinanceTransactionErrorLog
- FinancialDeal
- FinancialDealAsset
- FinancialDealBid
- FinancialDealInteraction
- FinancialDealParticipant
- FinancialDealParty
- FinancialDealProduct
- FinclDealInteractionSummary
- FlowOrchestrationInstance
- FlowOrchestrationLog
- FlowOrchestrationWorkItem
- FrgtHaulingEmssnFctr
- FrgtHaulingEnrgyUse
- FulfillmentOrder
- FulfillmentOrderLineItem
- FundingAward
- FundingAwardAmendment
- FundingAwardRequirement
- FundingDisbursement
- FundingOpportunity
- GeneratedDocument
- GeneratedWaste
- GenericVisitTask
- GenericVisitTaskContext
- GeoCountry
- GeoState
- GnrcVstKeyPerformanceInd
- GnrcVstTaskContextRelation
- GoalAssignment
- GoalAssignmentDetail
- GoalDefinition
- GovtFinancialAsstSum
- GroundTravelEmssnFctr
- GroundTravelEnrgyUse
- GroupCensus
- GroupCensusMember
- GroupCensusMemberPlan
- GroupClass
- GroupClassContribution
- HealthCareDiagnosis
- HealthcareFacilityNetwork
- HealthcarePayerNetwork
- HealthcarePractitionerFacility
- HealthCareProcedure
- HealthcareProvider
- HealthcareProviderNpi
- HealthcareProviderSpecialty
- HealthcareProviderTaxonomy
- HealthCondition
- HealthConditionDetail
- HealthScore
- HealthScoreActionLog
- HotelStayEmssnFctr
- HotelStayEnrgyUse
- IdentityDocument
- Image
- Incident
- IncludedLicenseDefinition
- Individual
- IndividualApplication
- IndividualApplicationItem
- InflationRate
- InspectionAssessmentInd
- InsPolicyTransactionDetail
- InStoreLocation
- InsuranceClaimAsset
- InsuranceContract
- InsurancePolicy
- InsurancePolicyAsset
- InsurancePolicyCoverage
- InsurancePolicyMemberAsset
- InsurancePolicyParticipant
- InsurancePolicySurcharge
- InsurancePolicyTransaction
- InsuranceProfile
- IntegrationProviderDef
- Interaction
- InteractionAttendee
- InteractionParticipant
- InteractionRelatedAccount
- InteractionSumDiscussedAccount
- InteractionSummary
- InteractionSummaryParticipant
- InterestTag
- InventoryItemReservation
- InventoryReservation
- Invoice
- InvoiceAddressGroup
- InvoiceBatchRun
- InvoiceBatchRunCriteria
- InvoiceBatchRunRecovery
- InvoiceLine
- JobProfile
- JournalReason
- JournalSubType
- JournalType
- KnowledgeArticleVersion—See [Salesforce Knowledge Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.knowledge_dev.meta/knowledge_dev/knowledge_development_uiapi_limitations.htm) for UI API limitations.
- Lead
- LearnerProgram
- LearnerProgramRequirement
- LearnerProgramRqmtProgress
- Learning
- LearningAchievement
- LearningCourse
- LearningFoundationItem
- LearningOutcomeItem
- LearningProgram
- LearningProgramPlan
- LearningProgramPlanRqmt
- LegalEntity
- LicensingSnapshotRequest
- ListEmail
- Location
- LocationGroup
- LocationWaitlist
- LocationWaitlistedParty
- LoyaltyAggrPointExprtLedger
- LoyaltyLedger
- LoyaltyMemberCurrency
- LoyaltyMembershipLifecycle
- LoyaltyMemberTier
- LoyaltyPartnerProduct
- LoyaltyPgmEngmtAttribute
- LoyaltyPgmEngmtAttrProm
- LoyaltyPgmGroupMbrRlnsp
- LoyaltyPgmMbrAttributeVal
- LoyaltyPgmPartnerCurrency
- LoyaltyPgmPartnerPromotion
- LoyaltyPgmPtnrLdgrSummary
- LoyaltyPgmPtnrPrepaidPack
- LoyaltyProgram
- LoyaltyProgramBadge
- LoyaltyProgramCurrency
- LoyaltyProgramMbrPromotion
- LoyaltyProgramMember
- LoyaltyProgramMemberBadge
- LoyaltyProgramMemberCase
- LoyaltyProgramMemberMerge
- LoyaltyProgramPartner
- LoyaltyProgramPartnerLedger
- LoyaltyProgramProcess
- LoyaltyProgramWidget
- LoyaltyTier
- LoyaltyTierBenefit
- LoyaltyTierGroup
- Macro
- MaintenancePlan
- MaintenanceWorkRule
- ManufacturingProgram
- MarketingForm
- MarketingLink
- MarketingLinkContent
- MarketSegment
- MediaChannel
- MediaContentTitle
- MediaPrintIssue
- MediaTitleAvailability
- MediaTitleReleaseDate
- MediaTitleRevenue
- MedicationDispense
- MedicationReconciliation
- MedicationStatementDetail
- MedicationTherapyReview
- MedicationTherapyStmtReview
- MedicinalIngredient
- MedReconRecommendation
- MedReconStmtRecommendation
- MedTherapyStmtReviewIssue
- MemberBenefit
- MemberPlan
- MerchantAccount
- MessagingChannel
- MessagingSession
- MfgProgramCpntFrcstFact
- MfgProgramForecastFact
- MfgProgramVariantFrcstFact
- MktAiPredictiveInsight
- MktDataTransform
- Network
- NetworkReferencedObject
- ObjectPermissions
- ObjectStateActionDefinition
- ObjectStateTransitionAction
- OcrDocumentScanResult
- OmniAssessmentTask
- OmniDataTransform
- OmniDataTransformItem
- OmniESignatureTemplate
- OmniInteractionConfig
- OmniProcess
- OmniProcessAsmtQuestionVer
- OmniProcessCompilation
- OmniProcessElement
- OmniScriptSavedSession
- OmniUiCard
- OperatingHours
- OperatingHoursHoliday
- Opportunity
- OpportunityParticipant
- OpportunityPreferredSeller
- Order
- OrderChangeLog
- OrderItemRelationship
- OrderPaymentSummary
- OrderSummary
- OrgIncidentSummary
- OtherEmssnFctrSet
- OtherEmssnFctrSetItem
- PartnerFundAllocation
- PartnerFundClaim
- PartnerFundRequest
- PartnerMarketingBudget
- PartyCertifiedCapacity
- PartyIdentityVerification
- PartyIdentityVerificationStep
- PartyIncome
- PartyProfile
- PartyProfileAddress
- PartyProfileRisk
- PartyRelationshipGroup
- PartyRoleRelation
- PartyScreeningStep
- PartyScreeningSummary
- PatientImmunization
- Payment
- PaymentAuthorization
- PaymentBatchRun
- PaymentBatchRunCriteria
- PaymentGateway
- PaymentGatewayProvider
- PaymentIntent
- PaymentLineInvoice
- PaymentRequest
- PaymentRequestLine
- PaymentSchedule
- PaymentScheduleItem
- PaymentSchedulePolicy
- PaymentScheduleTreatment
- PaymentScheduleTreatmentDtl
- PaymentTerm
- PaymentTermItem
- PcmtEmssnFctrSet
- PcmtEmssnFctrSetItem
- PercentileBsdCareFeeAgreement
- PermissionSet
- PermissionSetGroup
- PermissionSetLicense
- PersonDisability
- PersonEducation
- PersonEmployment
- PersonExamination
- PersonLanguage
- PersonLifeEvent
- PersonName
- PgmRebateTypBnftMapping
- PickTicket
- PickTicketAssignment
- PickTicketProduct
- PlanBenefit
- PlanBenefitItem
- PlatformLicenseDefinition
- PreliminaryApplicationRef
- PreventiveCareAgreement
- PriceAdjustmentSchedule
- Pricebook2
- PricebookEntry
- PriceList
- PricingHeader
- PricingLineItem
- PricingProduct
- PrivacyHold
- PrivacyHoldReason
- PrivacyJobSession
- PrivacyPolicy
- PrivacyRequest
- Problem
- ProblemDefinition
- ProblemGoalDefinition
- ProblemIncident
- ProcessException
- Producer
- ProducerCommission
- ProducerPolicyAssignment
- Product2
- ProductAttributeDefinition
- ProductCatalog
- ProductCategory
- ProductCategoryAttribute
- ProductCategoryServiceProcess
- ProductComponentGroup
- ProductConsumed
- ProductConsumedState
- ProductCoverage
- ProductEmissionsFactor
- ProductFaultCode
- ProductItem
- ProductItemTransaction
- ProductLaborCode
- ProductLicenseMap
- ProductOverridePathItem
- ProductQuantityRule
- ProductRelatedMaterial
- ProductRelationshipType
- ProductRelComponentOverride
- ProductRequest
- ProductRequestLineItem
- ProductRequired
- ProductSellingModelOption
- ProductServiceCampaign
- ProductServiceCampaignItem
- ProductTransfer
- ProductTransferState
- ProductWarrantyTerm
- Program
- ProgramEnrollment
- ProgramProduct
- ProgramRebateType
- ProgramRebateTypeBenefit
- ProgramRebateTypeFilter
- ProgramRebateTypePayout
- ProgramRebateTypeProduct
- ProgramRebateTypeReference
- ProgramRebateTypPayoutSrc
- ProgramTermApplnTimeline
- Promotion
- PromotionChannel
- PromotionLoyaltyPtnrProdt
- PromotionMarketSegment
- PromotionProduct
- PromotionProductCategory
- PromotionQualifier
- PromotionSegment
- PromotionSegmentBuyerGroup
- PromotionSegmentSalesStore
- PromotionTarget
- PromotionTier
- ProrationPolicy
- ProviderNetworkContract
- ProviderNetworkTier
- ProviderSearchSyncLog
- PublicApplicationParticipant
- PublicProgram
- PurchaserPlan
- PurchaserPlanAssn
- PurchaseQuantityRule
- PymtSchdDistributionMethod
- Quote
- QuoteDocument
- QuoteLineItemAttribute
- RebateClaim
- RebateMemberAggregateItem
- RebateMemberProductAggregate
- RebatePayment
- RebatePayoutAdjustment
- RebateProgram
- RebateProgramMember
- RebateProgramMemberPayout
- RebateProgramPayoutPeriod
- ReceivedDocument
- ReceivedDocumentType
- Recommendation
- RecordAlert
- RecordsetFilterCriteria
- RecordsetFilterCriteriaRule
- RecordsetFltrCritMonitor
- ReferencedDashboard
- Referral
- RefrigerantEmssnFctr
- RefundLinePayment
- RegionStatusDiscount
- RegulatoryAuthority
- RegulatoryAuthorizationType
- RegulatoryCode
- RegulatoryCodeAssessmentInd
- RegulatoryCodeUse
- RegulatoryCodeViolation
- RegulatoryTrxnFee
- RegulatoryTrxnFeeItem
- ReinsAgreementLineItem
- ReinsPolicyBordereauFact
- ReinsProtocolProdtComponent
- ReinsuranceAgreement
- ReinsuranceProtocol
- ReinsuranceProtocolAgreement
- RentalCarEmssnFctr
- RentalCarEnrgyUse
- ReplyText
- Report
- ReportAnomalyEventStore
- ReportedConsumption
- ResourceAbsence
- ResourcePreference
- RetailLocationGroup
- RetailStore
- RetailVisitKpi
- ReturnOrder
- ReturnOrderItemAdjustment
- ReturnOrderLineItem
- RevRecogTreatmentItemGroup
- RevenueDistributionMethod
- RevenueElement
- RevenueElementDistribution
- RevenueRecogTreatmentItem
- RevenueRecognitionPolicy
- RevenueRecognitionTreatment
- RightsQuote
- RightsQuoteLineItem
- RightsQuoteLineMediaTitle
- SalesAgreement
- SalesChannel
- SalesContractLine
- SalesforceContract
- SalesforceInvoice
- SalesforceQuote
- Scope3CrbnFtprnt
- Scope3EmssnSrc
- Scope3PcmtItem
- Scope3PcmtSummary
- Scorecard
- ScorecardAssociation
- SecuritiesHolding
- Seller
- SerializedProductTransaction
- ServiceAppointment
- ServiceAppointmentGroup
- ServiceContract
- ServiceCrew
- ServiceCrewMember
- ServiceReport
- ServiceResource
- ServiceResourceSkill
- ServiceTerritory
- ServiceTerritoryMember
- ServiceTerritoryRelationship
- SessionHijackingEventStore
- SettingUsageDefinition
- SettingUsageMap
- SharedSavingPaymentAgreement
- SharingRecordCollection
- SharingRecordCollectionItem
- Shift
- ShiftEngagementChannel
- ShiftPattern
- ShiftPatternEntry
- ShiftSegmentType
- ShiftTemplate
- ShiftWorkTopic
- Shipment
- SignatureTask
- SignatureTaskLineItem
- SkillLevelDefinition
- SkillRequirement
- Snippet
- SocialContributionSum
- SocialPersona
- SocialPost
- StandardCareFeeAgreement
- StnryAssetAnnualFact
- StnryAssetCrbnFtprnt
- StnryAssetCrbnFtprntItm
- StnryAssetEnrgyUse
- StnryAssetEnvrSrc
- StnryAssetWaterActvty
- StnryAssetWaterFtprnt
- StnryAssetWtrFtprntItm
- StoreActionPlanTemplate
- StoreAssortment
- StoreIntegratedService
- StoreProduct
- SuccessTeam
- Supplier
- SupplierProduct
- Survey
- SurveyEmailBranding
- SurveyInvitation
- SurveyQuestion
- SurveyQuestionChoice
- SurveyResponse
- SurveySubject
- SustainabilityCntrLine
- SustainabilityCredit
- SustainabilityPurchase
- SustainabilityScorecard
- SvcCatalogItemDef
- SvcCatalogReqRelatedItem
- SvcCatalogRequest
- Swarm
- SwarmMember
- TagCategory
- TagCategoryAssignment
- TaxDisclosureSummary
- TaxEngine
- TaxEngineInteractionLog
- TaxEngineProvider
- TaxRate
- Tenant
- TenantSecurityNotificationRule
- ThreatDetectionFeedback
- TimeSheet
- TimeSheetEntry
- TimeSlot
- Topic
- TrackedCommunication
- TrackedCommunicationDetail
- TrainingCourseParticipant
- TransactionJournal
- TravelMode
- TrnCourse
- UnitOfMeasure
- UnitOfMeasureConversion
- UsageFactor
- UsageImpactFactor
- UsageImpactGroup
- UsageImpactGroupFactor
- UsageImpactGroupPgmMeasure
- UsageImpactGroupVersion
- User
- UserAccessPolicy
- UserAppMenuItem
- UserDefinedLabel
- UserDefinedLabelAssignment
- UserEsignVendorIdentifier
- UserFinancialAuthority
- UserLicenseDefinition
- UserLocationAssignment
- UserRole
- UserTerritory2AssocLog
- Vehicle
- VehicleAssetCrbnFtprnt
- VehicleAssetEmssnSrc
- VehicleAssetEnrgyUse
- VehicleDefinition
- VehicleUserAssignment
- VideoCall
- VideoCallParticipant
- VideoRecording
- ViolationEnforcementAction
- ViolationType
- ViolationTypeUse
- Visit
- Visitor
- VoiceCall
- VolumeDiscount
- VolunteerProject
- Voucher
- VoucherDefinition
- WarrantyTerm
- WarrantyTermCoverage
- WasteFootprint
- WasteFootprintItem
- WebCart
- WebStoreInventorySource
- WebStorePricebook
- WorkCapacityLimit
- WorkCapacityUsage
- WorkerCompCoverageClass
- WorkOrder
- WorkOrderLineItem
- WorkPlan
- WorkPlanSelectionRule
- WorkPlanTemplate
- WorkPlanTemplateEntry
- WorkProcedure
- WorkProcedureStep
- WorkStep
- WorkStepTemplate
- WorkType
- WorkTypeCareSpecialty
- WorkTypeExtension
- WorkTypeGroup
- WorkTypeGroupMember
- WorkTypeGroupRole
- WstDispoEmssnFctrSet
- WstDispoEmssnFctrSetItm

<!-- document id=b0f578a48563418a5fe8f62f4d9b5b8c143c63f367ad69608acff2e2a91ee14d url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_views.md -->

# Lists

Use these resources to get data and metadata about list views and related lists displayed in the Salesforce UI.

- **[Get List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md.htm)**  
    Get list view metadata.
- **[Get a Batch of List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md_batch.htm)**  
    Get metadata for a batch of list views.
- **[Update List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md_patch.htm)**  
    Update list view metadata.
- **[Delete List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md_delete.htm)**  
    Delete list view metadata.
- **[Get List Views for an Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_get.htm)**  
    Get list views associated with an object.
- **[Create a List View for an Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_post.htm)**  
    Create a list view associated with an object.
- **[Get Metadata for a List View Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_md_get.htm)**  
    Get metadata for a list view object.
- **[Get List View Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records.htm)**  
    Get record data for a list view using URL parameters.
- **[Get List View Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_view_records_post.htm)**  
    Get record data for a list view using a request body.
- **[Get List View Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_preferences_get.htm)**  
    Get list view preferences.
- **[Update List View Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_preferences_update.htm)**  
    Update list view preferences.
- **[Get Related Lists for an Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_object.htm)**  
    Returns the related lists in an object’s default layout.
- **[Get Related List Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records.htm)**  
    Returns record data for up to 1,999 records in a related list via URL parameters.
- **[Get Related List Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_get.htm)**  
    Returns record data for up to 1,999 records in a related list. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.
- **[Get Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_md.htm)**  
    Returns metadata for a related list in a page layout.
- **[Get Related List Record Count](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_count.htm)**  
    Returns the record count for a related list.
- **[Get a Batch of Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_batch.htm)**  
    Returns metadata for a batch of related lists in a page layout.
- **[Get a Batch of Related List Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_batch.htm)**  
    Returns record data for a batch of related lists via URL parameters.
- **[Get a Batch of Related List Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_batch_get.htm)**  
    Returns record data for a batch of related lists. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.
- **[Get a Batch of Related List Record Counts](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_count_batch.htm)**  
    Returns the record count for a batch of related lists.
- **[Update Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_md_patch.htm)**  
    Update metadata for a related list in a page layout.
- **[Get Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_preferences_get.htm)**  
    Returns user preferences for a related list.
- **[Get a Batch of Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_preferences_batch_get.htm)**  
    Returns a batch of user preferences for a related list.
- **[Update Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_preferences_patch.htm)**  
    Updates user preferences for a related list.

<!-- document id=9104840b4c72f8717c981852fe36e493dd64dcd53ea592375f8f845d47bab47d url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_location_field.md -->

# Location Field

A complex location value for a record field.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| latitude | Double | Gets the latitude of the location. This value maybe null if both latitude and longitude are null. | Small, 41.0 | 41.0 |
| longitude | Double | Gets the longitude of the location. This value maybe null if both latitude and longitude are null. | Small, 41.0 | 41.0 |

<!-- document id=a0dc9a92395540b6d5bec56a367a03f6dae5a49267bbf9b35090ab1109363c0d url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_lookup_metadata.md -->

# Lookup Metadata

Search lookups metadata.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fieldApiName | String | API name of the lookup field. | Small, 57.0 | 57.0 |
| objectApiName | String | API name of the lookup field source object. | Small, 57.0 | 57.0 |
| secondaryField | String | API name of the field used as a secondary display field. | Small, 55.0 | 55.0 |
| targetInfo | Map<String, [Lookup Metadata Target Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lookup_metadata_target_info.htm "Search lookups target metadata.")\> | Map of lookup metadata target information. | Small, 57.0 | 57.0 |

<!-- document id=9349fb2a943990222ec68b6b7b39d1736864688fafa9ebc0ada38d85d7607539 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_lookup_metadata_target_info.md -->

# Lookup Metadata Target Info

Search lookups target metadata.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| advancedLookupInfo | [Advanced Lookup Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_advanced_lookup_info.htm "Advanced search lookup information.") | Advanced lookup information. | Small, 61.0 | 61.0 |
| errorMessages | String\[\] | Error messages. | Small, 66.0 | 66.0 |
| fullSearchInfo | [Display Layout and Matching Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_display_layout_and_matching_info.htm "Search lookups target display layout and matching information.") | Full search display layout and matching information. | Small, 57.0 | 57.0–60.0 |
| objectApiName | String | Object API name. | Small, 57.0 | 57.0 |
| suggestionsInfo | [Display Layout and Matching Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_display_layout_and_matching_info.htm "Search lookups target display layout and matching information.") | Suggestions display layout and matching information. | Small, 57.0 | 57.0 |

<!-- document id=f5eb650a1c5114ca66b491bcae4780b982a901168c85d64c6fa4aaa194a9630e url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_lookup_post_input.md -->

# Lookup Post Input

Get lookup field suggestions.

Example: Search Dependent Lookups for Suggestions using the request body

Some lookup fields have lookup filters that restrict their valid values by referencing fields on the source object. These fields are called dependent lookups. For example, you can filter the Case Contact field to show only contacts that are associated with the account selected in the Case Account Name field.

In the Salesforce UI, this lookup filter is Contact Name: Account Name ID EQUALS Case: Account Name ID. In the User Interface API, lookup filter information appears in the filteredLookupInfo property of the [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.") response body, which is returned from several resources, including [/ui-api/record-ui/{recordIds}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui "Get layout information, metadata, and data to build UI for a single record or for a collection of records."). If the filteredLookupInfo property is non-null, the field it describes is a dependent lookup.

In this example, the Case object’s ContactId field has a filteredLookupInfo property containing a controllingFields property. The controlling field is AccountId. To restrict the lookup search, you must pass all controlling fields and their values to the lookups resource in the sourceRecord request body property.

 **"objectInfos" : {**
    ...
    **"Case" : { **      
      "apiName" : "Case",
      ...
      **"fields" : {**
       ...
        **"ContactId" : {**
          "apiName" : "ContactId",
          ...properties removed for space...
          **"filteredLookupInfo" : {
            "controllingFields" : \[ "AccountId" \],**
            "dependent" : true,
            "optionalFilter" : false
          },
          ...
          "sortable" : true,
          "unique" : false,
          "updateable" : true
        },
        ...

To get the value for AccountId, look in the [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.") response body, which is returned from several resources, including [/ui-api/record-ui/{recordIds}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm#ui_api_resources_record_ui "Get layout information, metadata, and data to build UI for a single record or for a collection of records."). For example, to retrieve the value of the AccountId field present on the Case 500R0000000bKpBIAU:

GET /ui-api/records/500R0000000bKpBIAU?fields=Case.AccountId

{
  "apiName": "Case",
  "id": "500Z7000000bhdFIAQ",
  "fields": {
    "AccountId": {
      "displayValue": null,
      "value": "001R0000003IG0MIAW"
    }
  },
  ...Some properties removed for space...
}

To filter the suggestions for a dependent lookup, specify the names and values of the controlling fields in the sourceRecord request body property. (This example has one controlling field).

Request body:

POST /ui-api/lookups/case/ContactId
{
    "sourceRecord": {
        "fields": {
            "Id": "500Z7000000bhdFIAQ",
            "AccountId": "001R0000003IG0MIAW"
        }
    },
     "orderBy": \[
        {
           "fieldApiName": "Name", 
           "isAscending":true
        }
     \]  
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d29058e182">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d29058e185">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d29058e188">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d29058e191">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d29058e194">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d29058e182" data-title="Name"><samp class="codeph nolang">orderBy</samp></td>

                  <td class="entry" headers="d29058e185" data-title="Type">
                    <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm" title="Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.">List Order By Input</a>[]
                  </td>

                  <td class="entry" headers="d29058e188" data-title="Description">Information describing how to order the results.</td>

                  <td class="entry" headers="d29058e191" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d29058e194" data-title="Available Version">63.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d29058e182" data-title="Name"><samp class="codeph nolang">sourceRecord</samp></td>

                  <td class="entry" headers="d29058e185" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_record_input.htm" title="A description of a record to use in a request to create or update a record or in a request to check for duplicate records.">Record Input</a></td>

                  <td class="entry" headers="d29058e188" data-title="Description">The source record in which the lookup relationship field is being edited.
                    <p class="p">The presence of the source record “Id” is required within the “fields”
                      property. Accepted values are “null” when creating a new record and a valid
                      record ID when updating an existing record.</p>
                    <p class="p">Some lookup fields have
                      lookup filters that restrict the values they can accept by referencing
                      fields on the source object. These fields are called dependent lookup fields
                      or controlling fields. You must pass all controlling fields and their values
                      to the lookups resource within the “fields” property. </p>
                    <p class="p">To know whether
                      a field is a lookup controlling field, check the Object Info response body
                      for a non-null filteredLookupInfo property. Get the field values from the
                      Record response body. Both responses are returned from the
                      /ui-api/record-ui/{recordIds} resource.</p>
                    Properties “allowSaveOnDuplicate”
                    and “apiName” are not used.
                  </td>

                  <td class="entry" headers="d29058e191" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d29058e194" data-title="Available Version">60.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Get Lookup Field Suggestions With POST](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_post.htm "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You must specify dependent lookup field values used by lookup filters in the `sourceRecord` request body parameter.")

<!-- document id=e4787ee3099a6b41f74724a25d98be83a71a8ebca006986deab0fb4e8245eb0b url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_lookup_values.md -->

# Lookup Values

Records, organized by object type, and metadata in a lookup relationship.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| lookupResults | Map <String, [Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_collection.htm#ui_api_responses_record_collection "A paginated collection of Record response bodies.")\> | A map of object API names to Record Collection response bodies containing the lookup results for that object type. | Small, 41.0 | 41.0 |
| metadata | Map <String, [Lookup Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lookup_metadata.htm "Search lookups metadata.")\> | A map of object API names to Lookup Metadata response bodies containing the metadata results. | Small, 55.0 | 55.0 |

#### See Also

- [Get Lookup Field Suggestions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_get.htm "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.")
- [Get Lookup Field Suggestions With POST](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_post.htm "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You must specify dependent lookup field values used by lookup filters in the `sourceRecord` request body parameter.")

<!-- document id=4000c7c8f5d5a44534c6b96a1e067c9b260985c4959c46f8da90d33dcff8f461 url=/legacydeveloper/current/en-us/uiapi/ui_api_features_apps.md -->

# Manage Apps

An app is a collection of items that work together to serve a particular function. Salesforce apps come in two flavors: Classic apps and Lightning apps. Classic apps are created and managed in Salesforce Classic. Lightning apps are created and managed in Lightning Experience. Admins customize both types of apps to match the way users work.

Classic apps are a collection of standard and custom tabs, including most standard objects, custom objects, Visualforce tabs, Lightning component tabs, Canvas apps via Visualforce tabs, and web tabs. In Salesforce Classic, users use tabs to access objects, like accounts and leads. Tabs also serve up other features, such as the Home page or Chatter.

Lightning apps are a collection of items that include everything from the Classic apps list, plus Lightning page tabs, and utilities like Sales Dialer. In Lightning apps, admins customize the app’s logo and enhance branding by customizing the color of the navigation bar. Navigation in Lightning Experience is similar to navigation in Salesforce Classic, but with some improvements. In Lightning Experience, users can complete actions and access recent records and lists directly from the navigation bar. Users can also switch between apps that have custom colors and branding.

Users can also personalize which items appear in their navigation bar in Lightning Experience or tabs in Salesforce Classic. Although users can’t completely override the navigation created by admins, they can add and reorder items or tabs from their view. In addition, in Lightning Experience, users can add Favorite items directly to their navigation bar.

Using these App resources, you can get a list of apps, items from an app, and the presentation data for a user’s navigation.

To return metadata for a list of all apps for the current user, use this [resource](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps.htm "Get metadata for all the apps a user has access to. Metadata for the selected app includes tabs on the app’s navigation bar. Metadata for other apps doesn’t include tabs on the navigation bar.").

GET /ui-api/apps

To return metadata about a specific app, use this [resource](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_id.htm "Get the metadata for an app.").

GET /ui-api/apps/${appId}

To return metadata about a specific app, and save the app as the last accessed app for the user, use this [resource](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_id_update.htm "Returns metadata for an app, and saves an app as the last selected for a user.").

PATCH /ui-api/apps/${appId}

To return metadata about the app the current user last selected, or sees by default, use this [resource](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_selected.htm "Retrieves the app the current user last selected or the app the user sees by default.").

GET /ui-api/apps/selected

To return metadata about a user’s personalized navigation, use this [resource](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_user_nav_items.htm "Get a user’s personalized navigation items (tabs).").

GET /ui-api/apps/${appId}/user-nav-items

To return metadata for a list of all navigation tabs for the current user, use this [resource](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_all_nav_items.htm "Gets all navigation items (tabs) that the user has access to.").

GET /ui-api/nav-items

<!-- document id=8f07519710f09ef833841d1b8d0706837407547eef019a2bd96ca4b3d7de0cc5 url=/legacydeveloper/current/en-us/uiapi/ui_api_features_favorites.md -->

# Manage Favorites

Favorites let users access frequently used pages in Salesforce. Use User Interface API Favorites resources to manage favorites.

You can create, get, delete, and update favorites, update all favorites at once, and update favorite usage information, for example, the number of times a favorite was clicked. Responses return all fields required to render favorites.

This request returns all the favorites of the context user.

GET /ui-api/favorites

{
  "favorites" : \[ {
    "accessCount" : 1,
    "iconColor" : "FCB95B",
    "iconUrl" : "https://.../img/icon/t4v35/standard/opportunity\_120.png",
    "id" : "0MVR00000004GGlOAM",
    "lastAccessDate" : "2017-08-07T18:51:54.000Z",
    "name" : "My Best Opportunities",
    "objectType" : "Opportunity",
    "sortOrder" : 1,
    "subtitle" : "Opportunities",
    "target" : "00BR0000000tTTwMAM",
    "targetType" : "ListView"
  }, {
    "accessCount" : 1,
    "iconColor" : "A094ED",
    "iconUrl" : "https://.../img/icon/t4v35/standard/contact\_120.png",
    "id" : "0MVR00000004FOPOA2",
    "lastAccessDate" : "2017-07-21T21:35:27.000Z",
    "name" : "John Doe",
    "objectType" : "Contact",
    "sortOrder" : 2,
    "subtitle" : "Contact",
    "target" : "003R0000001bivAIAQ",
    "targetType" : "Record"
  }, {
    "accessCount" : 1,
    "iconColor" : "f6707b",
    "iconUrl" : "https://.../img/icon/t4v35/custom/custom84\_120.png",
    "id" : "0MVR000000004D5OAI",
    "lastAccessDate" : "2017-08-11T17:24:01.000Z",
    "name" : "Trend Board",
    "objectType" : "TabDefinition",
    "sortOrder" : 3,
    "subtitle" : "Tab",
    "target" : "Trend\_Board",
    "targetType" : "Tab"
  }, {
    "accessCount" : 1,
    "iconColor" : "F88962",
    "iconUrl" : "https://.../img/icon/t4v35/standard/lead\_120.png",
    "id" : "0MVR00000004GOpOAM",
    "lastAccessDate" : "2017-08-11T17:24:24.000Z",
    "name" : "Leads to Follow Up on",
    "objectType" : "Lead",
    "sortOrder" : 4,
    "subtitle" : "Leads",
    "target" : "Lead",
    "targetType" : "ListView"
  } \]
}

Adding a favorite to the top of the list is as easy as knowing what type of favorite it is and how to identify it. For example, to add an Account as a favorite, add it as a Record favorite using its ID. To insert it at the beginning of the list, explicitly set the sortOrder to 1, otherwise it’s inserted at the end of the list.

POST /ui-api/favorites?target=001R0000002LBXUIA4&targetType=Record&sortOrder=1
{
  "accessCount" : 1,
  "iconColor" : "7F8DE1",
  "iconUrl" : "https://.../img/icon/t4v35/standard/account\_120.png",
  "id" : "0MVR000000004DFOAY",
  "lastAccessDate" : "2017-08-11T19:26:04.000Z",
  "name" : "Global Media",
  "objectType" : "Account",
  "sortOrder" : 1,
  "subtitle" : "Account",
  "target" : "001R0000002LBXUIA4",
  "targetType" : "Record"
}

To track how often a user accesses a particular favorite, make a patch request using the favorite's ID and see the accessCount increment and the lastAccessDate update.

PATCH /ui-api/favorites/0MVR000000004DFOAY/usage
{
  "accessCount" : 2,
  "iconColor" : "7F8DE1",
  "iconUrl" : "https://.../img/icon/t4v35/standard/account\_120.png",
  "id" : "0MVR000000004DFOAY",
  "lastAccessDate" : "2017-08-11T19:31:17.416Z",
  "name" : "Global Media",
  "objectType" : "Account",
  "sortOrder" : 1,
  "subtitle" : "Account",
  "target" : "001R0000002LBXUIA4",
  "targetType" : "Record"
}

Removing a favorite is as easy and requires using the favorite's ID again.

DELETE /ui-api/favorites/0MVR000000004DFOAY

To reorder or rename your favorites, you have some options. The first option is to individually update each favorite one by one. When reordering this way, the server automatically updates the sort order of affected favorites in the list so the sort order stays consistent. The second and more useful option is to reorder, rename, and delete favorites in a single request. This option is useful for building an edit dialog where the user can rename some favorites, delete others, and reorder whichever they choose. All these changes can then be made in a single request.

PUT /ui-api/favorites/batch

Here’s the input for the PUT request:

{
  "favorites" : \[
    {
      "id": "0MVR00000004GOpOAM"
    },
    {
      "id": "0MVR00000004GGlOAM",
      "name": "Top Opportunities"
    },
    {
      "id": "0MVR000000004D5OAI"
    }
  \]
}

Here’s the response for the PUT request:

{
  "favorites" : \[ {
    "accessCount" : 1,
    "iconColor" : "F88962",
    "iconUrl" : "https://.../img/icon/t4v35/standard/lead\_120.png",
    "id" : "0MVR00000004GOpOAM",
    "lastAccessDate" : "2017-08-11T17:24:24.000Z",
    "name" : "Leads to Follow Up",
    "objectType" : "Lead",
    "sortOrder" : 1,
    "subtitle" : "Leads",
    "target" : "Lead",
    "targetType" : "ListView"
  }, {
    "accessCount" : 1,
    "iconColor" : "FCB95B",
    "iconUrl" : "https://.../img/icon/t4v35/standard/opportunity\_120.png",
    "id" : "0MVR00000004GGlOAM",
    "lastAccessDate" : "2017-08-07T18:51:54.000Z",
    "name" : "Top Opportunities",
    "objectType" : "Opportunity",
    "sortOrder" : 2,
    "subtitle" : "Opportunities",
    "target" : "00BR0000000tTTwMAM",
    "targetType" : "ListView"
  }, {
    "accessCount" : 1,
    "iconColor" : "f6707b",
    "iconUrl" : "https://.../img/icon/t4v35/custom/custom84\_120.png",
    "id" : "0MVR000000004D5OAI",
    "lastAccessDate" : "2017-08-11T17:24:01.000Z",
    "name" : "Trend Board",
    "objectType" : "TabDefinition",
    "sortOrder" : 3,
    "subtitle" : "Tab",
    "target" : "Trend\_Board",
    "targetType" : "Tab"
  } \]
}

In this single request, we deleted our contact John Doe, moved Leads to Follow Up to the top of the list, and we renamed My Best Opportunities to Top Opportunities.

#### See Also

- [Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites.htm "Use these resources to create and update a single favorite or a collection of favorites, and to get favorites usage information. These resources make it easy to build UI for favorites.")

<!-- document id=5d3ca22b170c41e01eafc9e6b042916dca5c85ad58c84c917597c1a7d6d7c5fc url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_match.md -->

# Match

A group of records that match the duplicate rules.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| duplicateResultInfos | Map<String, [Duplicate Result Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_result_info.htm "The result of the check for duplicate records. If duplicate records exist, returns the records' IDs and the duplicate rule that was used to match the records.")\> | A map of the duplicate rules and the information about the duplicate match. | Small, 50.0 | 50.0 |
| objectApiName | String | The object's API name. | Small, 50.0 | 50.0 |
| recordIds | String\[\] | A list of IDs of the matching records. | Small, 50.0 | 50.0 |

<!-- document id=8735c456d7e687a471ff1fe505118a64bf942318973768536ba348732f2c2d63 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_match_result.md -->

# Match Result

A duplicate rule match. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record. Each duplicate rule requires at least one matching rule to identify which existing records are possible duplicates.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | The API name of the object. | Small, 41.0 | 41.0 |
| isAllowSave | Boolean | Indicates whether the rule allows a duplicate to be saved. | Big, 41.0 | 41.0 |
| matchRecordIds | String\[\] | The IDs of the matching records. | Small, 41.0 | 41.0 |
| matchRule | String | The developer name of the matching duplicate rule. | Big, 41.0 | 41.0 |
| objectLabel | String | The object’s label. | Small, 41.0 | 41.0 |
| objectLabelPlural | String | The object’s label in plural form. | Small, 41.0 | 41.0 |
| themeInfo | [Theme Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_info.htm#ui_api_responses_theme_info "Color and icon information for a theme.") | Information about the object’s color and icon. | Small, 41.0 | 41.0 |

#### See Also

- [Duplicate Record Error](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_record_error.htm "Information about duplicate record errors. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record.")

<!-- document id=54d95450f8193a946f95b034637d38048e4a38c047ec2adcfd7b5bbe9093eac4 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_match_result_info.md -->

# Match Result Info

Information about the results of a match.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| recordIds | String\[\] | A list of IDs of the matching records. | Small, 50.0 | 50.0 |
| rule | String | The name of the match rule used to match the records. | Small, 50.0 | 50.0 |

<!-- document id=05b7e49c4b06047aedf6ba9ad3c4a0c9bc8593c84ae9093ca03795b8edef00e7 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_match_rule.md -->

# Match Rule

A match rule defines how duplicate records are identified in duplicate rules and duplicate jobs. Learn about one of the match rules for the specified object, including the match rule's name and the fields that the match rule checks.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d141142e51">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d141142e54">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d141142e57">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d141142e60">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d141142e63">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d141142e51" data-title="Property Name"><samp class="codeph nolang">matchEngine</samp></td>

              <td class="entry" headers="d141142e54" data-title="Type">String</td>

              <td class="entry" headers="d141142e57" data-title="Description">The type of matching used by the match rule. Possible values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ExactMatchEngine</samp>—use exact
                    matching rules to decide if the field values match.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FuzzyMatchEngine</samp>—use fuzzy
                    matching rules to decide if the field values match.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d141142e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d141142e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141142e51" data-title="Property Name"><samp class="codeph nolang">matchFields</samp></td>

              <td class="entry" headers="d141142e54" data-title="Type">String[]</td>

              <td class="entry" headers="d141142e57" data-title="Description">Fields that the match rule uses when checking for matching records.</td>

              <td class="entry" headers="d141142e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d141142e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141142e51" data-title="Property Name"><samp class="codeph nolang">name</samp></td>

              <td class="entry" headers="d141142e54" data-title="Type">String</td>

              <td class="entry" headers="d141142e57" data-title="Description">The name of the match rule.</td>

              <td class="entry" headers="d141142e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d141142e63" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141142e51" data-title="Property Name"><samp class="codeph nolang">objectApiName</samp></td>

              <td class="entry" headers="d141142e54" data-title="Type">String</td>

              <td class="entry" headers="d141142e57" data-title="Description">The API name of the object to which the match rule belongs.</td>

              <td class="entry" headers="d141142e60" data-title="Filter Group and Version">Small, 50.0</td>

              <td class="entry" headers="d141142e63" data-title="Available Version">50.0</td>

            </tr>

          </tbody>

        </table>

<!-- document id=2c61b7286c0d19bfc3628ce2a0a4f0eea2f80b39a11101ce242f67ed58b757dd url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_matching_info.md -->

# Matching Info

Search lookups target matching information.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| matchingFields | String\[\] | Ordered list of fields to match on. | Small, 57.0 | 57.0 |

<!-- document id=a8498b26caa6f3fe7cf54136e7227a29d00e9280fba40aed235ef150983a45ec url=/legacydeveloper/current/en-us/uiapi/ui_api_mru_list_view_supported_objects.md -->

# Most Recently Used List View Supported Objects

Most recently used (MRU) list views support a subset of the standard objects that User Interface API supports.

For general information about supported objects, see [Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm "User Interface API supports all custom objects and external objects and many standard objects.").

This list includes the standard objects supported for MRU list views.

As of Summer ’23, all new standard objects are auto-enabled for UI API usage. This list might not reflect the latest object support. To check if most recently used list views are supported for a specific object in UI API, use the [/ui-api/list-info/{objectApiName} resource](https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_resources_lists_object_get.htm) and check results for the list view named \_\_Recent.

- AISentimentResult
- AcademicSession
- AcademicTerm
- AcademicTermEnrollment
- AcademicYear
- Account
- AccountAccountRelation
- AccountBrand
- AccountForecast
- AccountParticipant
- Accreditation
- AcctMgrTarget
- ActionCadence
- ActionPlan
- ActionPlanBaseTemplateAsgn
- ActionPlanItem
- ActionPlanTemplate
- ActionPlanTemplateAssignment
- ActionPlanTemplateItem
- ActionPlanTemplateItemValue
- ActionPlanTemplateVersion
- ActionPlnTmplItmDependency
- ActionVisibility
- ActionableList
- ActivityTiming
- AdBuyServerAccount
- AdCreativeSizeType
- AdOpportunity
- AdOrderItem
- AdOrderItemCreativeSizeType
- AdOrderItemPrintIssue
- AdOrderItemUnitsSplit
- AdOrderLineAdTarget
- AdPageLayoutType
- AdProductDefaultTargetCategory
- AdProductTargetCategory
- AdQuote
- AdQuoteLineCreativeSizeType
- AdQuoteLinePrintIssue
- AdQuoteLineUnitsSplit
- AdServer
- AdServerUser
- AdSpaceSpecification
- AdTargetCategory
- AdTargetCategorySegment
- AdUsage
- AdUsageSummary
- AddOnDefinition
- Address
- AdvAccountForecastFact
- AdvAcctForecastSetPartner
- AdvAcctForecastSetUse
- AffinityScore
- AiDataset
- AiVisionModel
- AiVisionModelMetric
- AiVisionModelObjectMetric
- AiVisitRecommendRequest
- AiVisitRecommendation
- AiVisitSummary
- AiVisitTaskRcmd
- AiVisitTaskRcmdRequest
- AirTravelEmssnFctr
- AirTravelEnrgyUse
- AltenativePaymentMethod
- AnnualEmssnInventory
- AnnualEmssnRdctnTarget
- AntiCorruptionInitSum
- ApiAnomalyEventStore
- ApplicationCase
- ApplicationDecision
- ApplicationFormTemplate
- ApplicationRecommendation
- ApplicationRecommender
- ApplicationReview
- ApplicationTimeline
- AppointmentInvitation
- AppointmentInvitee
- AppointmentTopicTimeSlot
- ApptBundleAggrDurDnscale
- ApptBundleAggrPolicy
- ApptBundleConfig
- ApptBundlePolicy
- ApptBundlePolicySvcTerr
- ApptBundlePropagatePolicy
- ApptBundleRestrictPolicy
- ApptBundleSortPolicy
- ApptReasonEngmtChannelType
- AsmtQstnRespRecommendation
- Assessment
- AssessmentEnvelope
- AssessmentEnvelopeItem
- AssessmentIndicatorDefinition
- AssessmentQuestion
- AssessmentQuestionAssignment
- AssessmentQuestionResponse
- AssessmentQuestionSet
- AssessmentQuestionVersion
- AssessmentSignature
- AssessmentTask
- AssessmentTaskContentDocument
- AssessmentTaskDefinition
- AssessmentTaskOrder
- Asset
- AssetAccountParticipant
- AssetContactParticipant
- AssetDowntimePeriod
- AssetMilestone
- AssetWarranty
- AssignedResource
- AssociatedLocation
- AssortmentProduct
- AsyncOperationLog
- AttributeCategory
- AttributePicklist
- AttributePicklistValue
- AuthApplicationAsset
- AuthApplicationPlace
- AuthorNote
- AuthorizationFormConsent
- AuthorizedInsuranceLine
- Award
- BackgroundOperation
- BatchJob
- BatchJobDefinition
- BatchJobPart
- BatchJobPartFailedRecord
- BenefitAssignment
- BenefitAssignmentAdjustment
- BenefitDisbursement
- BenefitDisbursementAdj
- BenefitSchedule
- BenefitSession
- BenefitType
- BillingBatchFilterCriteria
- BillingBatchScheduler
- BillingTreatmentItem
- BldgEnrgyIntensity
- BldgEnrgyIntensityVal
- BldgSizeCategory
- BoardCertification
- BroadcastCommAudience
- BroadcastCommunication
- BroadcastTopic
- Budget
- BudgetAllocation
- BudgetCategory
- BudgetCategoryValue
- BudgetPeriod
- BundledCareFeeAgreement
- BusRegAuthorizationType
- BusinessAlert
- BusinessAlertStatus
- BusinessBrand
- BusinessLicense
- BusinessLicenseApplication
- BusinessMilestone
- BusinessProfile
- BusinessType
- BuyerGroupPricebook
- Campaign
- CapitationCareFeeAgreement
- CardPaymentMethod
- CareBarrier
- CareBarrierType
- CareBenefitVerifyRequest
- CareDeterminant
- CareDeterminantType
- CareDiagnosis
- CareEpisode
- CareEpisodeDetail
- CareFeeScheduleItem
- CareInterventionType
- CareMetricTarget
- CareObservation
- CarePgmEnrolleeWkOrdStep
- CarePgmEnrolleeWorkOrder
- CarePgmProvHealthcareProvider
- CarePlan
- CarePlanActivity
- CarePlanActivityDetail
- CarePlanDetail
- CarePlanTemplate
- CarePlanTemplateBenefit
- CarePlanTemplateGoal
- CarePlanTemplateProblem
- CarePreauth
- CarePreauthItem
- CareProgram
- CareProgramCampaign
- CareProgramEligibilityRule
- CareProgramEnrollee
- CareProgramEnrolleeProduct
- CareProgramEnrollmentCard
- CareProgramGoal
- CareProgramProduct
- CareProgramProvider
- CareProgramTeamMember
- CareProviderAdverseAction
- CareProviderFacilitySpecialty
- CareProviderSearchableField
- CareRegisteredDevice
- CareRequest
- CareRequestDrug
- CareRequestExtension
- CareRequestItem
- CareRequestReviewer
- CareSpecialty
- CareSpecialtyTaxonomy
- CareTaxonomy
- CartDeliveryGroup
- CartItem
- CartTax
- Case
- CaseParticipant
- CaseProgram
- CaseRelatedFile
- CaseRelatedIssue
- CategorizedCareFeeAgreement
- ChangeRequest
- ChangeRequestRelatedIssue
- ChannelProgram
- ChannelProgramLevel
- Claim
- ClaimCase
- ClaimCovPaymentAdjustment
- ClaimCovReserveAdjustment
- ClaimCoverage
- ClaimCoveragePaymentDetail
- ClaimCoverageReserveDetail
- ClaimItem
- ClaimParticipant
- ClaimPaymentSummary
- ClaimPayoutPlan
- ClaimRecovery
- ClaimTeamMember
- ClinicalDetectedIssue
- ClinicalDetectedIssueDetail
- ClinicalEncounter
- ClinicalEncounterDiagnosis
- ClinicalEncounterFacility
- ClinicalEncounterProvider
- ClinicalEncounterReason
- CloudServiceProvider
- CodeSet
- CodeSetBundle
- CodeSetRelationship
- CollaborationRoom
- CommissionSchedule
- CommissionScheduleAssignment
- CommsRegionDiscount
- CommsVolumeDiscount
- ComplaintCase
- ComplaintParticipant
- ConstituentRole
- Contact
- ContactContactRelation
- ContactEncounter
- ContactEncounterParticipant
- ContactPointAddress
- ContactProfile
- ContactRequest
- ContentDocument
- ContentNote
- Contract
- ContractDocVerContentDoc
- ContractDocVersionSection
- ContractDocumentVersion
- ContractGroupPlan
- ContractGroupPlanGroupClass
- ContractPaymentAgreement
- ConversationBroadcastEntry
- Coupon
- CourseOffering
- CourseOfferingParticipant
- CourseOfferingPtcpResult
- CourseOfferingSchedule
- CourseOfferingScheduleTmpl
- CourtAction
- CourtActionOutcome
- CoverageBenefit
- CoverageBenefitItem
- CoverageType
- CrbnCreditAlloc
- CrbnCreditAllocItem
- CrbnCreditDistribution
- CrbnCreditProject
- CrbnEmssnScopeAlloc
- CrbnEmssnScopeAllocVal
- CredentialStuffingEventStore
- CreditMemo
- CreditMemoAddressGroup
- CreditMemoInvApplication
- CreditMemoLine
- Crisis
- CryptoTransEnvelopeChgLog
- CustomObjectParticipant
- Customer
- CustomerProperty
- DataLakeObjectInstance
- DelegatedAccount
- DeliveryTask
- DiagnosticSummaryDetail
- DigitalSignature
- DigitalWallet
- Disclosure
- DisclsReportingPeriod
- DistributorAuthorization
- DivrsEquityInclSum
- DocumentChecklistItem
- DocumentClause
- DocumentClauseSet
- DocumentEnvelope
- DocumentTemplate
- DuplicateRecordSet
- DynamicDataCapture
- EconomicPerformanceSum
- EditionDefinition
- EducationalInfoRequest
- ElectricityEmssnFctrSet
- EmailContent
- EmailTemplate
- EmissionsActivity
- EmissionsForecastFact
- EmpBenefitSummary
- EmpUserProvisionProcessErr
- EmpUserProvisioningProcess
- Employee
- EmployeeCrisisAssessment
- EmployeeDemographicSum
- EmployeeDevelopmentSum
- EmssnRdctnCommitment
- EmssnReductionTarget
- EnablementProgram
- EngagementAttendee
- EngagementChannelWorkType
- EngagementInteraction
- EngagementTopic
- Entitlement
- EnvironmentHubMember
- EnvironmentalRisk
- Examination
- Expense
- ExpenseReport
- ExpenseReportEntry
- ExpressionSetView
- ExtDataShare
- ExtDataShareTarget
- FeeScheduleDefinition
- FieldPermissions
- FinanceTransactionErrorLog
- FinancialDeal
- FinancialDealAsset
- FinancialDealBid
- FinancialDealInteraction
- FinancialDealParticipant
- FinancialDealParty
- FinancialDealProduct
- FinclDealInteractionSummary
- FlowOrchestrationInstance
- FlowOrchestrationLog
- FlowOrchestrationWorkItem
- FrgtHaulingEmssnFctr
- FrgtHaulingEnrgyUse
- FulfillmentOrder
- FulfillmentOrderLineItem
- FundingAward
- FundingAwardAmendment
- FundingAwardRequirement
- FundingDisbursement
- FundingOpportunity
- GeneratedDocument
- GeneratedWaste
- GenericVisitTask
- GenericVisitTaskContext
- GeoCountry
- GeoState
- GnrcVstKeyPerformanceInd
- GnrcVstTaskContextRelation
- GoalAssignment
- GoalAssignmentDetail
- GoalDefinition
- GovtFinancialAsstSum
- GroundTravelEmssnFctr
- GroundTravelEnrgyUse
- GroupCensus
- GroupCensusMember
- GroupCensusMemberPlan
- GroupClass
- GroupClassContribution
- HealthCareDiagnosis
- HealthCareProcedure
- HealthCondition
- HealthConditionDetail
- HealthScore
- HealthScoreActionLog
- HealthcareFacilityNetwork
- HealthcarePayerNetwork
- HealthcarePractitionerFacility
- HealthcareProvider
- HealthcareProviderNpi
- HealthcareProviderSpecialty
- HealthcareProviderTaxonomy
- HotelStayEmssnFctr
- HotelStayEnrgyUse
- IdentityDocument
- Image
- Incident
- IncludedLicenseDefinition
- Individual
- IndividualApplication
- IndividualApplicationItem
- InflationRate
- InsPolicyTransactionDetail
- InspectionAssessmentInd
- InStoreLocation
- InsuranceClaimAsset
- InsuranceContract
- InsurancePolicy
- InsurancePolicyAsset
- InsurancePolicyCoverage
- InsurancePolicyMemberAsset
- InsurancePolicyParticipant
- InsurancePolicySurcharge
- InsurancePolicyTransaction
- InsuranceProfile
- IntegrationProviderDef
- Interaction
- InteractionAttendee
- InteractionParticipant
- InteractionRelatedAccount
- InteractionSumDiscussedAccount
- InteractionSummary
- InteractionSummaryParticipant
- InterestTag
- InventoryItemReservation
- InventoryReservation
- Invoice
- InvoiceAddressGroup
- InvoiceBatchRun
- InvoiceBatchRunCriteria
- InvoiceBatchRunRecovery
- InvoiceLine
- JobProfile
- JournalReason
- JournalSubType
- JournalType
- KnowledgeArticleVersion
- Lead
- LearnerProgram
- LearnerProgramRequirement
- LearnerProgramRqmtProgress
- Learning
- LearningAchievement
- LearningCourse
- LearningFoundationItem
- LearningOutcomeItem
- LearningProgram
- LearningProgramPlan
- LearningProgramPlanRqmt
- LegalEntity
- LicensingSnapshotRequest
- ListEmail
- Location
- LocationGroup
- LocationWaitlist
- LocationWaitlistedParty
- LoyaltyAggrPointExprtLedger
- LoyaltyLedger
- LoyaltyMemberCurrency
- LoyaltyMemberTier
- LoyaltyMembershipLifecycle
- LoyaltyPartnerProduct
- LoyaltyPgmEngmtAttrProm
- LoyaltyPgmEngmtAttribute
- LoyaltyPgmGroupMbrRlnsp
- LoyaltyPgmMbrAttributeVal
- LoyaltyPgmPartnerCurrency
- LoyaltyPgmPartnerPromotion
- LoyaltyPgmPtnrLdgrSummary
- LoyaltyPgmPtnrPrepaidPack
- LoyaltyProgram
- LoyaltyProgramBadge
- LoyaltyProgramCurrency
- LoyaltyProgramMbrPromotion
- LoyaltyProgramMember
- LoyaltyProgramMemberBadge
- LoyaltyProgramMemberCase
- LoyaltyProgramMemberMerge
- LoyaltyProgramPartner
- LoyaltyProgramPartnerLedger
- LoyaltyProgramProcess
- LoyaltyProgramWidget
- LoyaltyTier
- LoyaltyTierBenefit
- LoyaltyTierGroup
- Macro
- MaintenancePlan
- MaintenanceWorkRule
- ManufacturingProgram
- MarketingForm
- MarketingLink
- MarketingLinkContent
- MedReconRecommendation
- MedReconStmtRecommendation
- MedTherapyStmtReviewIssue
- MediaChannel
- MediaContentTitle
- MediaPrintIssue
- MediaTitleAvailability
- MediaTitleReleaseDate
- MediaTitleRevenue
- MedicationDispense
- MedicationReconciliation
- MedicationStatementDetail
- MedicationTherapyReview
- MedicationTherapyStmtReview
- MedicinalIngredient
- MemberBenefit
- MemberPlan
- MerchantAccount
- MessagingChannel
- MessagingSession
- MfgProgramCpntFrcstFact
- MfgProgramForecastFact
- MfgProgramVariantFrcstFact
- MktAiPredictiveInsight
- MktDataTransform
- Network
- NetworkReferencedObject
- ObjectPermissions
- ObjectStateActionDefinition
- ObjectStateTransitionAction
- OcrDocumentScanResult
- OmniAssessmentTask
- OmniDataTransform
- OmniDataTransformItem
- OmniProcess
- OmniProcessAsmtQuestionVer
- OmniProcessCompilation
- OmniProcessElement
- OmniScriptSavedSession
- OmniUiCard
- OperatingHours
- OperatingHoursHoliday
- Opportunity
- OpportunityParticipant
- OpportunityPreferredSeller
- Order
- OrderChangeLog
- OrderItemRelationship
- OrderPaymentSummary
- OrderSummary
- OrgIncidentSummary
- OtherEmssnFctrSet
- OtherEmssnFctrSetItem
- PartnerFundAllocation
- PartnerFundClaim
- PartnerFundRequest
- PartnerMarketingBudget
- PartyCertifiedCapacity
- PartyIdentityVerification
- PartyIdentityVerificationStep
- PartyIncome
- PartyProfile
- PartyProfileAddress
- PartyProfileRisk
- PartyRelationshipGroup
- PartyRoleRelation
- PartyScreeningStep
- PartyScreeningSummary
- PatientImmunization
- Payment
- PaymentAuthorization
- PaymentBatchRun
- PaymentBatchRunCriteria
- PaymentGateway
- PaymentGatewayProvider
- PaymentIntent
- PaymentLineInvoice
- PaymentRequest
- PaymentRequestLine
- PaymentSchedule
- PaymentScheduleItem
- PaymentSchedulePolicy
- PaymentScheduleTreatment
- PaymentScheduleTreatmentDtl
- PaymentTerm
- PaymentTermItem
- PcmtEmssnFctrSet
- PcmtEmssnFctrSetItem
- PercentileBsdCareFeeAgreement
- PermissionSet
- PermissionSetGroup
- PermissionSetLicense
- PersonDisability
- PersonEducation
- PersonEmployment
- PersonExamination
- PersonLanguage
- PersonLifeEvent
- PersonName
- PgmRebateTypBnftMapping
- PickTicket
- PickTicketAssignment
- PickTicketProduct
- PlanBenefit
- PlanBenefitItem
- PlatformLicenseDefinition
- PreliminaryApplicationRef
- PreventiveCareAgreement
- PriceAdjustmentSchedule
- PriceList
- Pricebook2
- PricebookEntry
- PricingHeader
- PricingLineItem
- PricingProduct
- PrivacyHold
- PrivacyHoldReason
- PrivacyJobSession
- PrivacyPolicy
- PrivacyRequest
- Problem
- ProblemDefinition
- ProblemGoalDefinition
- ProblemIncident
- ProcessException
- Producer
- ProducerCommission
- ProducerPolicyAssignment
- Product2
- ProductAttributeDefinition
- ProductCatalog
- ProductCategory
- ProductCategoryAttribute
- ProductCategoryServiceProcess
- ProductComponentGroup
- ProductConsumed
- ProductConsumedState
- ProductCoverage
- ProductEmissionsFactor
- ProductFaultCode
- ProductItem
- ProductItemTransaction
- ProductLaborCode
- ProductLicenseMap
- ProductOverridePathItem
- ProductQuantityRule
- ProductRelComponentOverride
- ProductRelatedMaterial
- ProductRelationshipType
- ProductRequest
- ProductRequestLineItem
- ProductRequired
- ProductSellingModelOption
- ProductServiceCampaign
- ProductServiceCampaignItem
- ProductTransfer
- ProductTransferState
- ProductWarrantyTerm
- Program
- ProgramEnrollment
- ProgramProduct
- ProgramRebateTypPayoutSrc
- ProgramRebateType
- ProgramRebateTypeBenefit
- ProgramRebateTypeFilter
- ProgramRebateTypePayout
- ProgramRebateTypeProduct
- ProgramRebateTypeReference
- ProgramTermApplnTimeline
- Promotion
- PromotionChannel
- PromotionLoyaltyPtnrProdt
- PromotionMarketSegment
- PromotionProduct
- PromotionProductCategory
- PromotionQualifier
- PromotionSegment
- PromotionSegmentBuyerGroup
- PromotionSegmentSalesStore
- PromotionTarget
- PromotionTier
- ProrationPolicy
- ProviderNetworkContract
- ProviderNetworkTier
- ProviderSearchSyncLog
- PublicApplicationParticipant
- PublicProgram
- PurchaserPlan
- PurchaserPlanAssn
- PurchaseQuantityRule
- PymtSchdDistributionMethod
- Quote
- QuoteDocument
- QuoteLineItemAttribute
- RebateClaim
- RebateMemberAggregateItem
- RebateMemberProductAggregate
- RebatePayment
- RebatePayoutAdjustment
- RebateProgram
- RebateProgramMember
- RebateProgramMemberPayout
- RebateProgramPayoutPeriod
- ReceivedDocument
- ReceivedDocumentType
- Recommendation
- RecordAlert
- RecordsetFilterCriteria
- RecordsetFilterCriteriaRule
- RecordsetFltrCritMonitor
- ReferencedDashboard
- Referral
- RefrigerantEmssnFctr
- RefundLinePayment
- RegionStatusDiscount
- RegulatoryAuthority
- RegulatoryAuthorizationType
- RegulatoryCodeAssessmentInd
- RegulatoryCodeUse
- RegulatoryCodeViolation
- RegulatoryTrxnFee
- RegulatoryTrxnFeeItem
- ReinsAgreementLineItem
- ReinsPolicyBordereauFact
- ReinsProtocolProdtComponent
- ReinsuranceAgreement
- ReinsuranceProtocol
- ReinsuranceProtocolAgreement
- RentalCarEmssnFctr
- RentalCarEnrgyUse
- ReportAnomalyEventStore
- ReportedConsumption
- ResourceAbsence
- ResourcePreference
- RetailLocationGroup
- RetailStore
- RetailVisitKpi
- ReturnOrder
- ReturnOrderItemAdjustment
- ReturnOrderLineItem
- RevRecogTreatmentItemGroup
- RevenueDistributionMethod
- RevenueElement
- RevenueElementDistribution
- RevenueRecogTreatmentItem
- RevenueRecognitionPolicy
- RevenueRecognitionTreatment
- RightsQuote
- RightsQuoteLineItem
- RightsQuoteLineMediaTitle
- SalesAgreement
- SalesChannel
- Scope3CrbnFtprnt
- Scope3EmssnSrc
- Scope3PcmtItem
- Scope3PcmtSummary
- Scorecard
- ScorecardAssociation
- SecuritiesHolding
- Seller
- SerializedProductTransaction
- ServiceAppointment
- ServiceAppointmentGroup
- ServiceContract
- ServiceCrew
- ServiceCrewMember
- ServiceReport
- ServiceResource
- ServiceResourceSkill
- ServiceTerritory
- ServiceTerritoryMember
- ServiceTerritoryRelationship
- SessionHijackingEventStore
- SettingUsageDefinition
- SettingUsageMap
- SharedSavingPaymentAgreement
- SharingRecordCollection
- SharingRecordCollectionItem
- Shift
- ShiftEngagementChannel
- ShiftPattern
- ShiftPatternEntry
- ShiftSegmentType
- ShiftTemplate
- ShiftWorkTopic
- Shipment
- SignatureTask
- SignatureTaskLineItem
- SkillLevelDefinition
- SkillRequirement
- Snippet
- SocialContributionSum
- SocialPersona
- SocialPost
- StandardCareFeeAgreement
- StnryAssetAnnualFact
- StnryAssetCrbnFtprnt
- StnryAssetCrbnFtprntItm
- StnryAssetEnrgyUse
- StnryAssetEnvrSrc
- StnryAssetWaterActvty
- StnryAssetWaterFtprnt
- StnryAssetWtrFtprntItm
- StoreActionPlanTemplate
- StoreAssortment
- StoreIntegratedService
- StoreProduct
- SuccessTeam
- Supplier
- SupplierProduct
- Survey
- SurveyEmailBranding
- SurveyInvitation
- SurveyQuestion
- SurveyQuestionChoice
- SurveyResponse
- SurveySubject
- SustainabilityCntrLine
- SustainabilityCredit
- SustainabilityPurchase
- SustainabilityScorecard
- SvcCatalogItemDef
- SvcCatalogReqRelatedItem
- SvcCatalogRequest
- Swarm
- SwarmMember
- TagCategory
- TagCategoryAssignment
- TaxDisclosureSummary
- TaxEngine
- TaxEngineInteractionLog
- TaxEngineProvider
- TaxRate
- Tenant
- TenantSecurityNotificationRule
- ThreatDetectionFeedback
- TimeSheet
- TimeSheetEntry
- TimeSlot
- TrackedCommunication
- TrackedCommunicationDetail
- TrainingCourseParticipant
- TransactionJournal
- TravelMode
- TrnCourse
- UnitOfMeasure
- UnitOfMeasureConversion
- UsageFactor
- UsageImpactFactor
- UsageImpactGroup
- UsageImpactGroupFactor
- UsageImpactGroupPgmMeasure
- UsageImpactGroupVersion
- User
- UserAccessPolicy
- UserAppMenuItem
- UserDefinedLabel
- UserDefinedLabelAssignment
- UserEsignVendorIdentifier
- UserFinancialAuthority
- UserLicenseDefinition
- UserLocationAssignment
- UserRole
- UserTerritory2AssocLog
- Vehicle
- VehicleAssetCrbnFtprnt
- VehicleAssetEmssnSrc
- VehicleAssetEnrgyUse
- VehicleDefinition
- VehicleUserAssignment
- VideoCall
- VideoCallParticipant
- VideoRecording
- ViolationEnforcementAction
- ViolationType
- ViolationTypeUse
- Visit
- Visitor
- VoiceCall
- VolumeDiscount
- VolunteerProject
- Voucher
- VoucherDefinition
- WarrantyTerm
- WarrantyTermCoverage
- WasteFootprint
- WasteFootprintItem
- WebCart
- WebStoreInventorySource
- WebStorePricebook
- WorkCapacityLimit
- WorkCapacityUsage
- WorkOrder
- WorkOrderLineItem
- WorkPlan
- WorkPlanSelectionRule
- WorkPlanTemplate
- WorkPlanTemplateEntry
- WorkProcedure
- WorkProcedureStep
- WorkStep
- WorkStepTemplate
- WorkType
- WorkTypeCareSpecialty
- WorkTypeExtension
- WorkTypeGroup
- WorkTypeGroupMember
- WorkTypeGroupRole
- WorkerCompCoverageClass
- WstDispoEmssnFctrSet
- WstDispoEmssnFctrSetItm

<!-- document id=8b9d6d123f248c6f72827d1ca7641445accf5f1954da90495dea8e1dec75db06 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_nav_item.md -->

# Navigation Item

The metadata for a single navigation item (tab).

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d141921e51">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d141921e54">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d141921e57">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d141921e60">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d141921e63">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">availableInClassic</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">Boolean</td>

              <td class="entry" headers="d141921e57" data-title="Description">If <samp class="codeph nolang">true</samp>, the tab is available for
                Salesforce Classic.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Medium, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">availableInLightning</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">Boolean</td>

              <td class="entry" headers="d141921e57" data-title="Description">If <samp class="codeph nolang">true</samp>, the tab is available for
                Lightning Experience.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Medium, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">color</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">Color of the navigation tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">content</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">Launch URL of the navigation tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">custom</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">Boolean</td>

              <td class="entry" headers="d141921e57" data-title="Description">If <samp class="codeph nolang">true</samp>, this navigation tab is a custom
                tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">developerName</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">API name of the navigation tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">iconUrl</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">URL of the icon of the navigation tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Medium, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">id</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">ID of the navigation tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">itemType</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">The navigation tab menu type. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">CanvasConnectedApp</samp>: The Canvas Collected
                    App menu type. This value matches Describe App Menu value <samp class="codeph nolang">CanvasConnectedApp</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ConnectedApp</samp>: The Connected App menu
                    type. This value matches Describe App Menu value <samp class="codeph nolang">ConnectedApp</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Entity</samp>: The Entity menu type as found
                    from search-driven sections. This value is not sourced from the Describe App
                    Menu.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FullSite</samp>: The Full Site tab menu type.
                    This value is not sourced from the Describe App Menu.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Help</samp>: The Help menu type. This value is
                    not sourced from the Describe App Menu.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ListView</samp>: The ListView menu type. This
                    value is not sourced from the Describe App Menu.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Logout</samp>: The Logout menu type. This value
                    is not sourced from the Describe App Menu.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NotificationSettings</samp>: The Notification
                    Settings menu type. This value is not sourced from the Describe App Menu.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Record</samp>: The Record menu type. This value
                    is not sourced from the Describe App Menu.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Standard</samp>: The Standard special case menu
                    type as found from search-driven sections. This value matches Describe App Menu
                    values <samp class="codeph nolang">Standard.*</samp>. The rest of the type
                    information is in <samp class="codeph nolang">standarddType</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TabApexPage</samp>: The Visualforce tab menu
                    type. This value matches Describe App Menu value <samp class="codeph nolang">Tab.apexPage</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TabAura</samp>: The Aura tab menu type. This
                    value matches Describe App Menu value <samp class="codeph nolang">Tab.aura</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TabFlexiPage</samp>: The Flexipage tab menu
                    item. This value matches Describe App Menu value <samp class="codeph nolang">Tab.flexiPage</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TabSObject</samp>: The SObject tab menu type.
                    This value matches Describe App Menu value <samp class="codeph nolang">Tab.sObject</samp>.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TabWeb</samp>: The web tab menu type. This type
                    is only available in Lightning Experience. This value is not sourced from the
                    Describe App Menu.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserProfile</samp>: The User Profile menu type.
                    This value is not sourced from the Describe App Menu.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">Localized label name of the navigation tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">objectApiName</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">Corresponding object API name of the navigation tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">objectLabel</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">The label of the corresponding object.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 44.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">objectLabelPlural</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">The plural label of the corresponding
                object.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 44.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">pageReference</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_page_reference.htm#ui_api_responses_page_reference" title="A page reference.">Page Reference</a></td>

              <td class="entry" headers="d141921e57" data-title="Description">Corresponding page reference for the navigation tab.</td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d141921e51" data-title="Property Name"><samp class="codeph nolang">standardType</samp></td>

              <td class="entry" headers="d141921e54" data-title="Type">String</td>

              <td class="entry" headers="d141921e57" data-title="Description">The subtype of a Standard menu type for the app. One of these values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Dashboards</samp></li>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                  <li class="li">
                    <samp class="codeph nolang">Development</samp>: Lightning Development
                    Experience
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AppLauncher</samp>: Lightning Experience App
                    Launcher
                  </li>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d141921e60" data-title="Filter Group and Version">Small, 43.0</td>

              <td class="entry" headers="d141921e63" data-title="Available Version">43.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_items.htm "An ordered list of navigation items (tabs) for the current user.")
- [App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_app.htm "The metadata for a single app.")

<!-- document id=8a2fe6caf23cc9105b69cc3ae01e8a65ddea0a2379dee03f0e43c491d1bc1bcd url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_navigation_item_collection_input.md -->

# Navigation Item Collection Input

A collection of all the navigation items (tabs) for an app. Pass this request body to get or update a user’s personalized navigation items.

JSON Example

{
  "navItems": \[{
    "id": "0QkRM00000058lN0AQ"
  }, {
    "id": "0QkRM00000058lR0AQ",
    "label": "My Top Account"
  }, {
    "pageReference": {
      "type": "standard\_\_objectPage",
      "attributes": {
        "objectApiName": "Dashboard",
        "actionName": "home"
      },
      "state": {}
    }
  }\]
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| navItems | [Navigation Item Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_navigation_item_input.htm "Represents the list of navigation items in the order that you want them to appear in the app.")\[\] | The list of navigation items in the order that you want them to appear in the app. | Required | 47.0 |

#### See Also

- [Update Personalized Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_update_nav_items.htm "Updates the order of a user’s personalized navigation items (tabs) and adds a navigation item to the list in the order specified.")

<!-- document id=1ed88cdfa3338bb8316a887bb2b7b368b257d779859d9e94a93d8765f4f2a450 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_navigation_item_input.md -->

# Navigation Item Input

Represents the list of navigation items in the order that you want them to appear in the app.

Example

PUT /services/data/v68.0/ui-api/apps/06mRM000000U6pOYAS/user-nav-items

{
  "navItems": \[{
    "id": "0QkRM00000058lN0AQ"
  }, {
    "id": "0QkRM00000058lR0AQ",
    "label": "My Top Account"
  }, {
    "pageReference": {
      "type": "standard\_\_objectPage",
      "attributes": {
        "objectApiName": "Dashboard",
        "actionName": "home"
      },
      "state": {}
    }
  }\]
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| id | String | The ID of the navigation item to include. | Required | 47.0 |
| label | String | The updated label for the navigation item in list views and records only. | Optional | 47.0 |
| pageReference | [Page Reference Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_page_reference_input.htm "To add a navigation item, include a pageReference. A pageReference is a JSON object that describes the navigation item’s page type, its attributes, and the state of the page.") | The page reference of the navigation item to add to the list. You can add one page reference per request. | Optional | 47.0 |

#### See Also

- [Get Personalized Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_user_nav_items.htm "Get a user’s personalized navigation items (tabs).")
- [Update Personalized Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_update_nav_items.htm "Updates the order of a user’s personalized navigation items (tabs) and adds a navigation item to the list in the order specified.")

<!-- document id=c2f74ba1c3e290be777a7ef8dc59f713ca9c0fae7d908bac737e57a28251a6ed url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_nav_items.md -->

# Navigation Items

An ordered list of navigation items (tabs) for the current user.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| navItems | [Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_item.htm#ui_api_responses_nav_item "The metadata for a single navigation item (tab).")\[\] | Metadata for navigation tabs. | Small, 43.0 | 43.0 |
| currentPageUrl | String | URL to the current page of navigation tabs. | Medium, 45.0 | 45.0 |
| nextPageUrl | String | URL to the next page of navigation tabs. | Medium, 45.0 | 45.0 |

#### See Also

- [Get All Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_all_nav_items.htm "Gets all navigation items (tabs) that the user has access to.")
- [Get Personalized Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_user_nav_items.htm "Get a user’s personalized navigation items (tabs).")
- [Update Personalized Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_update_nav_items.htm "Updates the order of a user’s personalized navigation items (tabs) and adds a navigation item to the list in the order specified.")

<!-- document id=16290db1fe529af659a8ebd5648eb88b9be1b34fea45e263dcbe70751749f296 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_object_action.md -->

# Object Action

The actions for an object.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| actions | [Platform Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_platform_action.htm#ui_api_responses_platform_action "The metadata, layout information, and data for a platform action.")\[\] | A list of actions associated with the object. | Small, 41.0 | 41.0 |
| links | String\[\] | The subcontext URLs of the current request | Big, 41.0 | 41.0 |
| url | String | The URL of the current request. | Big, 41.0 | 41.0 |

<!-- document id=72706ff3b2643e62004e7740a233a1ad69094e6b5f09a6fdedf3ad2c811e7f72 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_object_info.md -->

# Object Info

The metadata for an object.

![Important](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d146364e40">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d146364e42">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d146364e44">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d146364e46">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d146364e48">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">String</td>

              <td class="entry" headers="d146364e44" data-title="Description">The object's API name.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">associateEntityType</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">String</td>

              <td class="entry" headers="d146364e44" data-title="Description">If the object is associated with a parent object, the type of association it
                has to its parent, such as <samp class="codeph nolang">History</samp>. Otherwise,
                its value is <samp class="codeph nolang">null</samp>.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 50.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">associateParentEntity</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">String</td>

              <td class="entry" headers="d146364e44" data-title="Description">If the object is associated with a parent object, the parent object it’s
                associated with. Otherwise, its value is <samp class="codeph nolang">null</samp>.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 50.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">50.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">childRelationships</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_child_relationship.htm#ui_api_responses_child_relationship" title="The child relationship on a parent object. Relationships are connections between records. Use relationships to display data about related object records on a record's detail page.">Child Relationship</a>[]
              </td>

              <td class="entry" headers="d146364e44" data-title="Description">The object’s child relationships. </td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">compactLayoutable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can have compact layouts.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 60.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">createable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can be created.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">custom</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object is custom.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">defaultRecordTypeId</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">String</td>

              <td class="entry" headers="d146364e44" data-title="Description">The ID for the default record type for this object, if any. If there isn’t a
                default record type, this value is the master record type, which is <samp class="codeph nolang">012000000000000AAA</samp>. If the record is a nested record
                (for example, in a request for an Account, the User object is a nested record), the
                value is <samp class="codeph nolang">null</samp>.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">deleteable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can be deleted. Only available in API version
                41.0. In API version 42.0, we spelled it correctly.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0–41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">deletable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can be deleted.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">dependentFields</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Map&lt;String, Object&gt;</td>

              <td class="entry" headers="d146364e44" data-title="Description">
                <span class="ph" id="dependentFields"><a name="dependentFields"><!-- --></a>A map of the dependent fields tree structure. Each
                  nested object is another Map&lt;String, Object&gt;. When the object is empty, it
                  indicates a leaf of the tree, which is a field that doesn’t control other fields.
                  An object can have multiple independent trees, which means this property can have
                  multiple root objects.</span>
                <div class="p">
                  <span class="ph" id="dependentFields2"><a name="dependentFields2"><!-- --></a>Imagine an object with the
                    picklists Continents__c, Countries__c, and Cities__c. Continents__c is the root.
                    Cities__c is a leaf. Continents__c and Countries__c are controlling fields.
                    Countries__c and Cities__c are dependent
                    picklists.</span>
                  <div class="codeSection nolang">
                    <pre class="codeblock nolang" id="dependentFieldsCode"><a name="dependentFieldsCode"><!-- --></a>"dependentFields" : {
    "Continents__c" : {
      "Countries__c" : {
        "Cities__c" : { }
      }
    }
  },</pre>
                  </div>
                </div>
                <p class="p"><span class="ph" id="dependentFields3"><a name="dependentFields3"><!-- --></a>A field dependency causes the
                    values in a picklist to be dynamically filtered based on the value selected by
                    the user in another field. The field that drives filtering is called the
                    "controlling field." Standard and custom checkboxes and picklists with at least
                    one and less than 300 values can be controlling fields. The field that has its
                    values filtered is called the "dependent field." Custom picklists and
                    multi-select picklists can be dependent fields. </span></p>
              </td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Big, 42.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">feedEnabled</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can have feeds.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">fields</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Map&lt;String, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field.htm#ui_api_responses_field" title="A field's metadata.">Field</a>&gt;</td>

              <td class="entry" headers="d146364e44" data-title="Description">A map of field API name to information about the field. This map only contains
                fields relevant to the requested layout and mode.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">keyPrefix</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">String</td>

              <td class="entry" headers="d146364e44" data-title="Description">The key prefix for IDs of this object.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">String</td>

              <td class="entry" headers="d146364e44" data-title="Description">The object's display label.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">labelPlural</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">String</td>

              <td class="entry" headers="d146364e44" data-title="Description">The plural form of the object's display label.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">layoutable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can have a layout.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">mruEnabled</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can appear in Most Recently Used lists.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">nameFields</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">String[]</td>

              <td class="entry" headers="d146364e44" data-title="Description">A collection of the API names of the fields used to identify the name field for
                standard and custom objects. Typically there is one name field per object, except
                where <samp class="codeph nolang">FirstName</samp> and <samp class="codeph nolang">LastName</samp> fields are used.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">queryable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the context user can query the object.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">recordTypeInfos</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Map&lt;String, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_type_info.htm#ui_api_responses_record_type_info" title="Information about a record type.">Record Type Info</a>&gt;</td>

              <td class="entry" headers="d146364e44" data-title="Description">A map of record type IDs to information about the record type. All record types
                are visible whether the user has access to them.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">searchable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can be searched.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">searchLayoutable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can have search layouts.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 60.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">60.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">themeInfo</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_info.htm#ui_api_responses_theme_info" title="Color and icon information for a theme.">Theme Info</a></td>

              <td class="entry" headers="d146364e44" data-title="Description">Theme information for the object.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d146364e40" data-title="Property Name"><samp class="codeph nolang">updateable</samp></td>

              <td class="entry" headers="d146364e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d146364e44" data-title="Description">Indicates whether the object can be updated.</td>

              <td class="entry" headers="d146364e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d146364e48" data-title="Available Version">41.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [Get Record Data and Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm "Get layout information, metadata, and data to build UI for a single record or for a collection of records.")
- [Get Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info.htm "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.")
- [Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Record UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_ui.htm "The layout information, field information, and data for a record.")
- [Record Defaults](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults.htm "The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records.")

<!-- document id=c040138cea87e3a3c433c5c0d226c42c20cb7a1fddfb9423bb42114aba955eda url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_object_info_directory.md -->

# Object Info Directory

A directory of objects that are supported by User Interface API and available to the context user.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| objects | Map<String, [Object Info Directory Entry](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info_directory_entry.htm#ui_api_responses_object_info_directory_entry "An entry in the Object Info Directory, which is a directory of objects that User Interface API supports and that the context user can access.")\> | A map of objects supported by User Interface API to their object info directory entries. | Small, 42.0 | 42.0 |

#### See Also

- [Get a Directory of Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info_directory.htm "Get a directory of objects that are supported by User Interface API and accessible to the context user. The directory includes a /ui-api/object-info/{objectApiName} resource for each supported object.")

<!-- document id=93f833c929eabf41a10c8c5e5bfd0387503c6a47a8cdb8991ef1948771841d7e url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_object_info_directory_entry.md -->

# Object Info Directory Entry

An entry in the Object Info Directory, which is a directory of objects that User Interface API supports and that the context user can access.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | The API name of the object. | Small, 42.0 | 42.0 |
| keyPrefix | String | The key prefix of the object. | Small, 47.0 | 47.0 |
| label | String | The label of the object. | Small, 42.0 | 42.0 |
| labelPlural | String | The plural label of the object. | Small, 42.0 | 42.0 |
| nameFields | String\[\] | A list of the API names of the name fields of the object. Most objects have one name field. For example, the Order object has one name field, OrderNumber. However, objects that use a first and last name have multiple name fields. For example, the Contact object has these name fields: FirstName, LastName, and Name. | Small, 47.0 | 47.0 |
| objectInfoUrl | String | The URL to get a full object info response for this object (/ui-api/object-info/{objectApiName}). | Small, 42.0 | 42.0 |

#### See Also

- [Object Info Directory](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info_directory.htm "A directory of objects that are supported by User Interface API and available to the context user.")

<!-- document id=ac1162100181a83c7864406c6a29ad079e2283bbf4e875c8515e8363ea05d8ae url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_opportunity_stage_picklist_values.md -->

# Opportunity Stage Picklist Value Attributes

Additional picklist value attributes for opportunity stages.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d150663e39">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d150663e42">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d150663e45">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d150663e48">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d150663e51">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d150663e39" data-title="Property Name"><samp class="codeph nolang">closed</samp></td>

              <td class="entry" headers="d150663e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d150663e45" data-title="Description">Indicates whether this opportunity stage value represents a closed opportunity.
                Multiple opportunity stage values can represent a closed opportunity.</td>

              <td class="entry" headers="d150663e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d150663e51" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d150663e39" data-title="Property Name"><samp class="codeph nolang">defaultProbability</samp></td>

              <td class="entry" headers="d150663e42" data-title="Type">Double</td>

              <td class="entry" headers="d150663e45" data-title="Description">The default percentage estimate of the confidence in closing a specific
                opportunity for this opportunity stage value. May be <samp class="codeph nolang">null</samp> if forecasting is not enabled for the org. </td>

              <td class="entry" headers="d150663e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d150663e51" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d150663e39" data-title="Property Name"><samp class="codeph nolang">forecastCategory​Name</samp></td>

              <td class="entry" headers="d150663e42" data-title="Type">String</td>

              <td class="entry" headers="d150663e45" data-title="Description">The default forecast category value for this opportunity stage value. May be
                <samp class="codeph nolang">null</samp> if forecasting is not enabled for the
                org.
              </td>

              <td class="entry" headers="d150663e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d150663e51" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d150663e39" data-title="Property Name"><samp class="codeph nolang">picklistAtrributes​ValueType</samp></td>

              <td class="entry" headers="d150663e42" data-title="Type">String</td>

              <td class="entry" headers="d150663e45" data-title="Description">The value is <samp class="codeph nolang">OpportunityStage</samp>. Indicates
                that these value attributes are associated with the stage of an opportunity.<p class="p">For
                  more information, see the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_opportunitystage.htm" target="_blank">OpportunityStage object
                    documentation</a>.</p>
                <p class="p">The property <samp class="codeph nolang">picklistAtrributes​ValueType</samp> contains a typographical
                  error.</p>
              </td>

              <td class="entry" headers="d150663e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d150663e51" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d150663e39" data-title="Property Name"><samp class="codeph nolang">won</samp></td>

              <td class="entry" headers="d150663e42" data-title="Type">Boolean</td>

              <td class="entry" headers="d150663e45" data-title="Description">Indicates whether this opportunity stage value represents a won opportunity.
                Multiple opportunity stage values can represent a won opportunity.</td>

              <td class="entry" headers="d150663e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d150663e51" data-title="Available Version">41.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Picklist Value](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_value.htm "A single picklist value.")

<!-- document id=9fb9051a43c2dffc5b4e40ce07848349158c3973fea262d8456978e10e0a84d1 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_page_reference.md -->

# Page Reference

A page reference.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| attributes | Map<String, Object> | Values for each attribute specified by the page definition. | Small, 43.0 | 43.0 |
| state | Map<String, Object> | Optional parameters that are not integral to the resolution of the reference. | Small, 43.0 | 43.0 |
| type | String | Name of the corresponding page definition. | Small, 43.0 | 43.0 |

<!-- document id=5e50a49a8f4ac1034850f883fbe18928998adeccc121e4bb72a865f6d5054227 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_page_reference_input.md -->

# Page Reference Input

To add a navigation item, include a pageReference. A pageReference is a JSON object that describes the navigation item’s page type, its attributes, and the state of the page.

Example

PUT /services/data/v68.0/ui-api/apps/06mRM000000U6pOYAS/user-nav-items

The request body contains the list of navigation items in the order they should appear. To add a navigation item, include a pageReference describing the item.

{
  "navItems": \[{
    "id": "0QkRM00000058lN0AQ"
  }, {
    "id": "0QkRM00000058lR0AQ",
    "label": "My Top Account"
  }, {
    "pageReference": {
      "type": "standard\_\_objectPage",
      "attributes": {
        "objectApiName": "Dashboard",
        "actionName": "home"
      },
      "state": {}
    }
  }\]
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| type | String | The page reference type generates a unique URL format and defines attributes that apply to all pages of that type. See [PageReference Types](https://developer.salesforce.com/docs/component-library/documentation/lwc/lwc.reference_page_reference_type "HTML (New Window)"). | Required | 47.0 |
| attributes | Map<String, Object> | Map of values for each attribute specified by the page definition, for example, objectAPIName or actionName. | Required | 47.0 |
| state | Map<String, Object> | Map of conditional values that customize content on the page, such as filterName. | Optional | 47.0 |

#### See Also

- [Navigation Item Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_navigation_item_input.htm "Represents the list of navigation items in the order that you want them to appear in the app.")

<!-- document id=8631d41d6aea77d1ac347a6689448f331aeaa8b20e9877a567a400308c57de4c url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_perform_action_input.md -->

# Perform Action Input

Perform a quick action that creates or updates a record.

JSON example

This example uses a request body to create a Contact for an Account.

POST /services/data/v68.0/ui-api/actions/perform-quick-action/Account.CreateContact

{
  "apiName": "Contact",
  "contextId": "001RO000003zKtEYAU",  
  "fields": {
    "LastName": "Rogers"
    "Title": "VP, Facilities"
  }
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d31441e80">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d31441e83">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d31441e86">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d31441e89">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d31441e92">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d31441e80" data-title="Name"><samp class="codeph nolang">allowSaveOnDuplicate</samp></td>

                  <td class="entry" headers="d31441e83" data-title="Type">Boolean</td>

                  <td class="entry" headers="d31441e86" data-title="Description">Specifies whether to save a duplicate record (<samp class="codeph nolang">true</samp>), or not (<samp class="codeph nolang">false</samp>). The default value
                    is <samp class="codeph nolang">false</samp>.</td>

                  <td class="entry" headers="d31441e89" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d31441e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d31441e80" data-title="Name"><samp class="codeph nolang">apiName</samp></td>

                  <td class="entry" headers="d31441e83" data-title="Type">String</td>

                  <td class="entry" headers="d31441e86" data-title="Description">To API name of the object to create or update. </td>

                  <td class="entry" headers="d31441e89" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d31441e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d31441e80" data-title="Name"><samp class="codeph nolang">contextId</samp></td>

                  <td class="entry" headers="d31441e83" data-title="Type">String</td>

                  <td class="entry" headers="d31441e86" data-title="Description">The ID of the related record for the quick action.</td>

                  <td class="entry" headers="d31441e89" data-title="Required or Optional">Required for performing object-specific quick actions <p class="p">Optional for performing
                      global quick actions</p>
                  </td>

                  <td class="entry" headers="d31441e92" data-title="Available Version">57.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d31441e80" data-title="Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d31441e83" data-title="Type">Map&lt;String, Object&gt;</td>

                  <td class="entry" headers="d31441e86" data-title="Description">Map of field names to field values.</td>

                  <td class="entry" headers="d31441e89" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d31441e92" data-title="Available Version">57.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Perform Quick Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_perform_action.htm "Perform a quick action that creates or updates a record.")
- [Update a Record with a Quick Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_update_action.htm "Perform an Update a Record quick action. To perform a quick action that creates or updates a record, you can also use the POST method.")

<!-- document id=0ad4ed270939b9b8a761302394388554c1b8056ce878d871800627d2437187b3 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_perform_action.md -->

# Perform Quick Actions

Perform a quick action that creates or updates a record.

Resource

/ui-api/actions/perform-quick-action/${actionApiName}

actionApiName—The API name of a quick action.

Available Version

57.0

HTTP Method

POST

Example

This example uses a request body to create a Contact for an Account.

POST /services/data/v68.0/ui-api/actions/perform-quick-action/Account.CreateContact

{
  "apiName": "Contact",
  "contextId": "001RO000003zKtEYAU",  
  "fields": {
    "LastName": "Rogers"
    "Title": "VP, Facilities"
  }
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| performQuickActionInput | [Perform Action Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_perform_action_input.htm "Perform a quick action that creates or updates a record.") | The data for the quick action. | Required | 57.0 |

Response Body

[Quick Action Execution](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_perform_action.htm "The results that are returned when a quick action executes.")

<!-- document id=3462faafaa18ddaeca4c6f52d4d68c2c970c9055ae5551bae3b022b81477e9b4 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_picklist_value.md -->

# Picklist Value

A single picklist value.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d152753e28">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d152753e30">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d152753e32">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d152753e34">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d152753e36">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d152753e28" data-title="Property Name"><samp class="codeph nolang">attributes</samp></td>
              <td class="entry" headers="d152753e30" data-title="Type">Either <samp class="codeph nolang">null</samp> or one of these response bodies:<ul class="ul bulletList">
                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_case_status_picklist_values.htm" title="Additional picklist value attributes for case statuses.">Case Status Picklist Value Attributes</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lead_status_picklist_values.htm#ui_api_responses_lead_status_picklist_values" title="Additional picklist value attributes for lead statuses.">Lead Status Picklist Value Attributes</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_opportunity_stage_picklist_values.htm#ui_api_responses_opportunity_stage_picklist_values" title="Additional picklist value attributes for opportunity stages.">Opportunity Stage Picklist Value Attributes</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_workstep_picklist_values.htm" title="Additional picklist value attributes for work step statuses.">Work Step Status Picklist Value Attributes</a></li>

                </ul>
              </td>
              <td class="entry" headers="d152753e32" data-title="Description">
                <p class="p">This property might contain a nested response body to help consumers understand
                  the meaning of the picklist value.</p>

              </td>
              <td class="entry" headers="d152753e34" data-title="Filter Group and Version">Small, 41.0<p class="p">The Work Step Picklist Value Attributes type is available in API version 58.0
                  and later.</p>
              </td>
              <td class="entry" headers="d152753e36" data-title="Available Version">41.0<p class="p">The Work Step Picklist Value Attributes type is available in API version 58.0 and
                  later.</p>
              </td>
            </tr>
            <tr>
              <td class="entry" headers="d152753e28" data-title="Property Name"><samp class="codeph nolang">label</samp></td>
              <td class="entry" headers="d152753e30" data-title="Type">String</td>
              <td class="entry" headers="d152753e32" data-title="Description">The displayable value of the picklist to use in a UI.</td>
              <td class="entry" headers="d152753e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d152753e36" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d152753e28" data-title="Property Name"><samp class="codeph nolang">validFor</samp></td>
              <td class="entry" headers="d152753e30" data-title="Type">Integer[]</td>
              <td class="entry" headers="d152753e32" data-title="Description">If the picklist is a dependent picklist, the property contains a list of the controlling
                value indexes for which this value is valid. If the picklist is an independent
                picklist, the list is empty.</td>
              <td class="entry" headers="d152753e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d152753e36" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d152753e28" data-title="Property Name"><samp class="codeph nolang">value</samp></td>
              <td class="entry" headers="d152753e30" data-title="Type">String</td>
              <td class="entry" headers="d152753e32" data-title="Description">The value of the picklist to use in the API.</td>
              <td class="entry" headers="d152753e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d152753e36" data-title="Available Version">41.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [Picklist Values](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_values.htm "The picklist values for a field, scoped to a record type. If a picklist is dependent, this response includes the values of its immediate controlling field and how they map to the picklist.")

<!-- document id=8e59efaa984bad0e2d89bc216e26278a32c7f017b75ed0624e074363851d9cea url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_picklist_values.md -->

# Picklist Values

The picklist values for a field, scoped to a record type. If a picklist is dependent, this response includes the values of its immediate controlling field and how they map to the picklist.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d153428e28">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d153428e30">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d153428e32">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d153428e34">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d153428e36">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d153428e28" data-title="Property Name"><samp class="codeph nolang">controllerValues</samp></td>
              <td class="entry" headers="d153428e30" data-title="Type">Map&lt;String, Integer&gt;</td>
              <td class="entry" headers="d153428e32" data-title="Description">
                <div class="p">If the picklist is dependent, this property is a map of its immediate controlling
                  field’s picklist values to their indexes. <ul class="ul bulletList">
                    <li class="li">If the controlling field is a picklist, the String is the picklist value and
                      the integer is the value’s index.</li>

                    <li class="li">If the controlling field is a checkbox, the values in the map are <samp class="codeph nolang">"false": 0</samp> and <samp class="codeph nolang">"true": 1</samp>.</li>

                  </ul>
                </div>

                <p class="p">If the picklist is independent, the map is empty.</p>

              </td>
              <td class="entry" headers="d153428e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d153428e36" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d153428e28" data-title="Property Name"><samp class="codeph nolang">defaultValue</samp></td>
              <td class="entry" headers="d153428e30" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_value.htm#ui_api_responses_picklist_value" title="A single picklist value.">Picklist Value</a></td>
              <td class="entry" headers="d153428e32" data-title="Description">The default value for the picklist, or <samp class="codeph nolang">null</samp> if there
                isn't one.</td>
              <td class="entry" headers="d153428e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d153428e36" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d153428e28" data-title="Property Name"><samp class="codeph nolang">url</samp></td>
              <td class="entry" headers="d153428e30" data-title="Type">String</td>
              <td class="entry" headers="d153428e32" data-title="Description">A User Interface API resource that represents this payload.</td>
              <td class="entry" headers="d153428e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d153428e36" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d153428e28" data-title="Property Name"><samp class="codeph nolang">values</samp></td>
              <td class="entry" headers="d153428e30" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_value.htm#ui_api_responses_picklist_value" title="A single picklist value.">Picklist Value</a>[]
              </td>
              <td class="entry" headers="d153428e32" data-title="Description">A list of values for this object, record type, field combination.</td>
              <td class="entry" headers="d153428e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d153428e36" data-title="Available Version">41.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [Picklist Values Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_values_collection.htm "A collection of picklist values for all the picklists of a specified record type.")
- [Get Values for a Picklist Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values.htm "If a field’s dataType property is equal to Picklist or MultiPicklist, use this resource to get its values.")
- [Get Values for All Picklist Fields of a Record Type](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm "Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request.")
- [Build UI for Picklists](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_dependent_picklist.htm "User Interface API exposes properties and resources that make it easy for a client to build picklists and dependent picklists.")

<!-- document id=f30c3fd711bddc3e981359af7d7e2e31f3f394636a7807d6debb313ea9e95ad6 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_picklist_values_collection.md -->

# Picklist Values Collection

A collection of picklist values for all the picklists of a specified record type.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| picklistFieldValues | Map<String, [Picklist Values](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_values.htm#ui_api_responses_picklist_values "The picklist values for a field, scoped to a record type. If a picklist is dependent, this response includes the values of its immediate controlling field and how they map to the picklist.")\> | A map of field names to Picklist Values response bodies. This map contains all the picklist values for all the picklists of a specified record type, including dependent picklists. If a field isn’t a picklist, it isn’t represented in the map. | Small, 42.0 | 42.0 |

#### See Also

- [Get Values for All Picklist Fields of a Record Type](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm "Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents__c, Countries__c, Cities__c), use this resource to get all the values for each picklist in one request.")
- [Build UI for Picklists](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_dependent_picklist.htm "User Interface API exposes properties and resources that make it easy for a client to build picklists and dependent picklists.")

<!-- document id=84a6aca0ea5f99ce017c86a7ef9a01ed1997934f461113e296ccbd67e6386b96 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_platform_action.md -->

# Platform Action

The metadata, layout information, and data for a platform action.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d154391e44">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d154391e47">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d154391e50">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d154391e53">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d154391e56">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">actionListContext</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The context of the action. One of these values: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Chatter</samp></li>

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

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

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

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

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

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

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

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

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

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">actionTarget</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The URL to invoke or describe the action when the action is invoked. Applies
                only to quick actions.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Big, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">actionTargetType</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The type of the target when this action is invoked. One of these values: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Describe</samp>—applies to actions with a
                    user interface, such as quick actions
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Invoke</samp>—applies to actions with no
                    user interface, such as action links or invocable actions
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Visualforce</samp>—applies to standard
                    buttons overridden by a Visualforce page
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Big, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The API name of the action.<p class="p">In API version 46.0 and later, for global actions
                  the prefix <samp class="codeph nolang">Global.</samp> is prepended to the API
                  name.</p>
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">externalId</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">External information associated with the action.<sup class="ph sup">1</sup>
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">iconUrl</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The URL of the action’s icon image.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">id</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The ID of this platform action record, which is the 18-character PlatformAction
                SObject ID, with a prefix of <samp class="codeph nolang">0JV</samp>.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">isMassAction</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">Indicates whether the action can be performed on multiple records.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The label to display for this action.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">lwcComponent</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The Lightning web component associated with this action.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 56.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">56.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">primaryColor</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The primary color of the icon for this action, in Hex color code. For example,
                <samp class="codeph nolang">7F8DE1</samp>.
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">relatedListRecordId</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">When the <samp class="codeph nolang">actionListContext</samp> property is
                <samp class="codeph nolang">RelatedListRecord</samp>, this field represents the
                ID of the record in an object's related list.
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">relatedSourceObject</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">When the <samp class="codeph nolang">actionListContext</samp> property is
                <samp class="codeph nolang">RelatedList</samp> or <samp class="codeph nolang">RelatedListRecord</samp>, this field represents the API name of the related
                list to which the action belongs.
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">section</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The section of the user interface the action resides in. One of these values: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ActivityComposer</samp></li>

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">sourceObject</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The object that this action is associated with. Either an API name or record
                ID, depending on the resource.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">subtype</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The subtype of the action. For quick actions, one of these values: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Canvas</samp></li>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                </ul>
                For custom buttons, one of these values: <ul class="ul bulletList">
                  <li class="li">flow</li>

                  <li class="li">javascript</li>

                  <li class="li">page</li>

                  <li class="li">sControl</li>

                  <li class="li">url</li>

                </ul>
                For action links, one of these values: <ul class="ul bulletList">
                  <li class="li">Api</li>

                  <li class="li">ApiAsync</li>

                  <li class="li">Download</li>

                  <li class="li">Ui</li>

                </ul>
                Standard buttons and productivity actions have no subtype.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">targetObject</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The target object that is created when the action is invoked.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">targetUrl</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The target URL for custom button actions.</td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d154391e44" data-title="Property Name"><samp class="codeph nolang">type</samp></td>

              <td class="entry" headers="d154391e47" data-title="Type">String</td>

              <td class="entry" headers="d154391e50" data-title="Description">The type of the action. One of these values: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">CustomButton</samp>—A button that opens a URL or
                    Visualforce page or executes JavaScript.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ProductivityAction</samp>—A pre-defined
                    Salesforce action, attached to a limited set of objects.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">QuickAction</samp>—A global or object-specific
                    action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">StandardButton</samp>—A pre-defined Salesforce
                    button, such as <strong class="ph uicontrol">New</strong>, <strong class="ph uicontrol">Edit</strong>, and
                    <strong class="ph uicontrol">Delete</strong>.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d154391e53" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d154391e56" data-title="Available Version">41.0</td>

            </tr>

          </tbody>

        </table>

1The format for a quick action is:

OrgId:SourceObject::Context:deviceFormat::QuickActionDefinitionId

For example:

00Dxx0000001gGh:x01xx0000000007AAA::Record:Phone:09Dxx00000000B6

The format for a standard action is:

OrgId:SourceObject::Context:deviceFormat::StandardButton:ApiName

<!-- document id=db103d07b83056353b4e3872d4d2fd59f0629b80f63227c56e670ee1f969105f url=/legacydeveloper/current/en-us/uiapi/ui_api_features_records_idempotent.md -->

# Prevent Record Duplication with Idempotent Record Writes

Use idempotent record writes to avoid duplication of records and server operations, which can occur when an app or client encounters a network connection issue.

To make a request idempotent, include an Idempotency-Key value in your request header. By making a request idempotent, your records on the server remain in the same state even if an identical request is made once or multiple times. Salesforce uses server storage to store the cached response of an idempotent request.

Only the /ui-api/records/{recordId} resource supports idempotent record writes for the POST, PATCH, and DELETE methods. The following table describes idempotent record write support for specific UI API resources.

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




        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader  " id="d3235e54">UI API Resource</th>

            <th class="featureTableHeader  " id="d3235e57">POST</th>

            <th class="featureTableHeader  " id="d3235e60">PATCH</th>

            <th class="featureTableHeader  " id="d3235e63">DELETE</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d3235e54" data-title="UI API Resource"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_create.htm" title="Create or clone a record."><samp class="codeph nolang">/ui-api/records</samp></a></td>

            <td class="entry" headers="d3235e57" data-title="POST"><img class="image" src="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/checkmark_16x16.png" alt="Yes"></td>

            <td class="entry" headers="d3235e60" data-title="PATCH"></td>

            <td class="entry" headers="d3235e63" data-title="DELETE"></td>

          </tr>

          <tr>
            <td class="entry" headers="d3235e54" data-title="UI API Resource"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_patch.htm" title="Update a record's data."><samp class="codeph nolang">/ui-api/records/{recordId}</samp></a></td>

            <td class="entry" headers="d3235e57" data-title="POST"><img class="image" src="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/checkmark_16x16.png" alt="Yes"></td>

            <td class="entry" headers="d3235e60" data-title="PATCH"><img class="image" src="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/checkmark_16x16.png" alt="Yes"></td>

            <td class="entry" headers="d3235e63" data-title="DELETE"><img class="image" src="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/checkmark_16x16.png" alt="Yes"></td>

          </tr>

          <tr>
            <td class="entry" headers="d3235e54" data-title="UI API Resource"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm" title="Upload documents and images or update the file with a new version."><samp class="codeph nolang">/ui-api/records/content-documents/​content-versions</samp></a></td>

            <td class="entry" headers="d3235e57" data-title="POST"><img class="image" src="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/checkmark_16x16.png" alt="Yes"></td>

            <td class="entry" headers="d3235e60" data-title="PATCH"></td>

            <td class="entry" headers="d3235e63" data-title="DELETE"></td>

          </tr>

          <tr>
            <td class="entry" headers="d3235e54" data-title="UI API Resource"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm" title="Upload documents and images or update the file with a new version."><samp class="codeph nolang">/ui-api/records/content-documents/​${contentDocumentId}/content-versions</samp></a></td>

            <td class="entry" headers="d3235e57" data-title="POST"><img class="image" src="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/checkmark_16x16.png" alt="Yes"></td>

            <td class="entry" headers="d3235e60" data-title="PATCH"></td>

            <td class="entry" headers="d3235e63" data-title="DELETE"></td>

          </tr>

        </tbody>

      </table>

When a unique Idempotency-Key request header is passed to a supported resource, the response for a server data mutation operation is stored. Subsequently, next time a request is sent to the same resource with the same Idempotency-Key value, the cached response is returned instead of performing a server data mutation operation.

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

#### Note

An idempotent request supports a response size up to 9 MB. If your request results in a larger response size, idempotency isn’t honored, but the request doesn’t fail. Retrying the same request results in duplication on the server.

Idempotent record writes save server processing costs by returning cached response for POST, PATCH, and DELETE operations.

## Include an Idempotency Key Value

In your request header, pass in an [Idempotency-Key value](https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-idempotency-key-header) in the [UUID v4 format](https://datatracker.ietf.org/doc/html/rfc4122). You can use a library that supports UUID v4 generation, including the [Java UUID utility](https://docs.oracle.com/javase/7/docs/api/java/util/UUID.html).

curl --location --request POST 'https://MyDomainName.my.salesforce.com/services/data/v56.0/ui-api/records' \\
--header 'Authorization: Bearer AuthToken' \\
--header 'Content-Type: application/json' \\
--header '**Idempotency-Key: 12cfe4e6-e477-4de8-aa4e-95d31aa2be24**' \\
--header 'Cookie: BrowserId=yVVAfz9GEeuRCtc5jOsncA; CookieConsentPolicy=0:0' \\
--data-raw '{
    "apiName": "ResourceAbsence",
    "fields": {
        "CreatedDate": "2022-12-01T14:52:16.000Z",
        "LastModifiedDate": "2022-12-01T14:52:16.000Z",
        "ResourceId": "0Hnxx0000004C92CAE",
        "Start": "2022-12-02T14:52:16.000Z",
        "End": "2022-12-03T14:52:16.000Z"
    }
}'

![Tip](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note_tip.png)

#### Tip

We recommend that you use a unique Idempotency-Key header value for each unique operation. The idempotency key doesn't provide idempotency indefinitely and auto-expires after 30 days if the same key is reused.

When the idempotency key expires after 30 days, the cached record that’s associated with the idempotency key is deleted. If the same idempotency key is used again after it’s deleted, the key is treated as a new idempotency key. A new cached response is then stored when an idempotent request is received the first time.

## Example: Upload a File With An Idempotency Key

Let’s look at how you can [upload a file](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm "Upload documents and images or update the file with a new version.") using an idempotency key. To send the idempotent request, include Idempotency-Key in your request header.

curl -H "X-PrettyPrint: 1" \\
-F 'json={"title":"Example image", "description":"Your description"}' \\
-F "fileData=@image.jpg;type=application/octet-stream" \\
-X POST https://MyDomainName.my.salesforce.com/services/data/v58.0/ui-api/records/content-documents/content-versions \\
-H 'Authorization: Bearer AuthToken' \\
-H 'Idempotency-Key: YourKey'

When you send the request, notice the id values in the contentDocument, contentDocumentLinks, and contentVersion fields. If you resend the request using the same idempotency key, the response is returned without any server-side operations and the id values remain the same, indicating that the file doesn’t get uploaded a second time.

## HTTP Status Error Codes

An idempotent request returns [2XX status codes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_errors.htm "The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred.") for a successful operation. It can also return one of these HTTP status error codes.

400

You can receive one of the following errors.

- Idempotency not supported—Remove the Idempotency-Key header and retry the operation.
- Idempotency-Key is not in valid format—Generate a new Idempotency-Key header value and retry the operation.

409

Either a different user has issued the same request earlier or this duplicate request is issued within a short time because an earlier request terminated abruptly. If you include a Retry-After header, a follow-up request is sent.

422

The Idempotency-Key header value is already used by the same user for a different request. Generate a new Idempotency-Key value and retry the operation.

5XX

A server error has occurred. If you include a Retry-After header, a follow-up request is sent.

<!-- document id=eb55ed5f94be1c7429c2e911e4cf197bbf7bb1847a343fe647280ec9d42750cb url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_perform_action.md -->

# Quick Action Execution

The results that are returned when a quick action executes.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| contextId | String | The ID of the related record for the quick action. | Small, 57.0 | 57.0 |
| feedItemId | String | The ID of the feed item that the action created. | Small, 57.0 | 57.0 |
| id | String | The ID of the record that the action created or updated. | Small, 57.0 | 57.0 |
| isCreated | Boolean | Specifies whether the action created records (true), or not (false). | Small, 57.0 | 57.0 |
| isSuccess | Boolean | Specifies whether the action executed successfully (true), or not (false). | Small, 57.0 | 57.0 |
| successMessage | String | The action’s success message. | Small, 57.0 | 57.0 |

#### See Also

- [Perform Quick Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_perform_action.htm "Perform a quick action that creates or updates a record.")
- [Update a Record with a Quick Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_update_action.htm "Perform an Update a Record quick action. To perform a quick action that creates or updates a record, you can also use the POST method.")

<!-- document id=c05aa50e0eb13d830e875fe9f6f4c6c0e727315d1f3283a901abea89f65c0668 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_quick_action_layout.md -->

# Quick Action Layout

The record layout used by the quick action.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| actionApiName | String | The name of the quick action. | Small, 58.0 | 58.0 |
| layout | [Record Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout.htm#ui_api_responses_record_layout "The layout information for a record.") | Information about the layout used by the quick action. | Small, 58.0 | 58.0 |

#### See Also

- [Get a Quick Action Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_quick_action_layout.htm "Get information about the record layout used by a Create a Record or Update a Record quick action.")

<!-- document id=79db667ab84a4ecbcdfb14b0c9db40eeb915c398d963c0fa5d2bda6bb0c25a0f url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record.md -->

# Record

The field data, API name, child relationship data, and record type information for a record.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d157599e28">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d157599e30">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d157599e32">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d157599e34">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d157599e36">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type">String</td>

              <td class="entry" headers="d157599e32" data-title="Description">The API name for this record.</td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">childRelationships</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type">Map&lt;String, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_responses_record_collection.htm" target="_blank">Record
                  Collection</a>&gt;</td>

              <td class="entry" headers="d157599e32" data-title="Description">The child relationship data for this record.</td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">fields</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type">Map&lt;String, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_responses_field_value.htm" target="_blank">Field Value</a>&gt;</td>

              <td class="entry" headers="d157599e32" data-title="Description">The field data for this record, matching the requested layout and mode.</td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">id</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type">String</td>

              <td class="entry" headers="d157599e32" data-title="Description">The ID of this record.</td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">lastModifiedById</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type">String</td>

              <td class="entry" headers="d157599e32" data-title="Description">The ID of the user who last updated this record.</td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 44.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">lastModifiedDate</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type">String</td>

              <td class="entry" headers="d157599e32" data-title="Description">The date and time when a user last modified this record. Date and time
                information is in ISO 8601 format.</td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 44.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">44.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">recordTypeId</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type">String</td>

              <td class="entry" headers="d157599e32" data-title="Description">The record type ID for this record.</td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 48.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">48.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">recordTypeInfo</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.uiapi.meta/uiapi/ui_api_responses_record_type_info.htm" target="_blank">Record Type
                  Info</a></td>

              <td class="entry" headers="d157599e32" data-title="Description">The record type info for this record, if any.<p class="p">This property is returned for
                  only two levels of nested records. Instead, use <samp class="codeph nolang">recordTypeId</samp>, which is returned for every record in a
                  response.</p>
              </td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d157599e28" data-title="Property Name"><samp class="codeph nolang">systemModstamp</samp></td>

              <td class="entry" headers="d157599e30" data-title="Type">String</td>

              <td class="entry" headers="d157599e32" data-title="Description">The date and time when a user or an automated process (such as a trigger) last
                modified this record. Date and time information is in ISO 8601 format.</td>

              <td class="entry" headers="d157599e34" data-title="Filter Group and Version">Small, 44.0</td>

              <td class="entry" headers="d157599e36" data-title="Available Version">44.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [Record UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_ui.htm "The layout information, field information, and data for a record.")
- [List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_record_collection.htm "A collection of list view records.")
- [Record Defaults](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults.htm "The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records.")
- [Batch Result Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_result.htm "The results of one subrequest in a batch request.")
- [Create or Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_create.htm "Create or clone a record.")
- [Update a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_patch.htm "Update a record's data.")
- [Get a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_get.htm "Get a record’s data.")
- [Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.")

<!-- document id=71c6998802cefb432f9b887ed661af46f59cd8700e2aa9626b479e30cc6b3e30 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_collection.md -->

# Record Collection

A paginated collection of Record response bodies.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| count | Integer | The total count of records returned. | Small, 41.0 | 41.0 |
| currentPageToken | String | Token identifying the current page. | Small, 44.0 | 44.0 |
| currentPageUrl | String | User Interface API URL identifying the current page. | Small, 41.0 | 41.0 |
| nextPageToken | String | Token identifying the next page, or null if there isn’t a next page. | Small, 44.0 | Small, 44.0 |
| nextPageUrl | String | User Interface API URL identifying the next page. | Small, 41.0 | Small, 41.0 |
| previousPageToken | String | Token identifying the previous page, or null if there isn’t a previous page. | Small, 44.0 | 44.0 |
| previousPageUrl | String | User Interface API URL identifying the previous page. | Small, 41.0 | 41.0 |
| records | [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.")\[\] | A collection of records. | Small, 41.0 | 41.0 |

#### See Also

- [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm "The field data, API name, child relationship data, and record type information for a record.")
- [Get Child Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_child_relationships.htm "Get child records for a specified record and child relationship name. Relationships are connections between records. On a record detail page, each record in a related list has a child relationship to the parent record.")
- [Lookup Values](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lookup_values.htm "Records, organized by object type, and metadata in a lookup relationship.")

<!-- document id=d1cd5a503b1f17d0bc00155ae3ccfd835c160c8e7dad1336c9d21f1f557a1b67 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_defaults.md -->

# Record Defaults

The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| layout | [Record Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout.htm#ui_api_responses_record_layout "The layout information for a record.") | Record layout information. | Medium, 41.0 | 41.0 |
| objectInfo | [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.") | Object metadata. | Big, 41.0 | 41.0-41.0 |
| objectInfos | Map<String, [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.")\> | A map of object metadata. | Big, 42.0 | 42.0 |
| record | [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.") | Pre-populated record data. | Small, 41.0 | 41.0 |

#### See Also

- [Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Create or Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_create.htm "Create or clone a record.")

<!-- document id=38d74edd42ab02bfd05984ba0b52418c6b01a1d63ef21cbd196a1ff786da05f9 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_defaults_template_clone.md -->

# Record Defaults Template Clone

A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| objectInfos | Map<String, [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.")\> | A map of object metadata. | Big, 49.0 | 49.0 |
| record | [Record Template Clone](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_template_clone.htm "A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records.") | Pre-populated record data. | Small, 49.0 | 49.0 |

#### See Also

- [Get Default Values to Clone a Record—Lightweight](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_template_clone.htm "Get the default values for fields for cloning a record. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.")

<!-- document id=9f53b2a981a001d2452a5688e5b2408373250d145c333d9a9f518d915a2c060a url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_defaults_template_create.md -->

# Record Defaults Template Create

A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| objectInfos | Map<String, [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.")\> | A collection of object metadata. | Big, 49.0 | 49.0 |
| record | [Record Template Create](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_template_create.htm "A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records.") | Pre-populated record data. | Small, 49.0 | 49.0 |

#### See Also

- [Get Default Values to Create a Record—Lightweight](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_template_create.htm "Get the default values for fields for a new record of a specified object and optional record type. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.")

<!-- document id=5b501489bb24f856ecc96bbd8eb5ace73768f41d9f95b7db039784dfb38f4aed url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_exception_error.md -->

# Record Exception Error

Information about a record exception error.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d161848e52">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d161848e55">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d161848e58">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d161848e61">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d161848e64">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d161848e52" data-title="Property Name"><samp class="codeph nolang">constituentField</samp></td>

              <td class="entry" headers="d161848e55" data-title="Type">String</td>

              <td class="entry" headers="d161848e58" data-title="Description">If the field is a constituent of a compound field, this property contains the
                API name of the constituent field, and the <samp class="codeph nolang">field</samp> property contains the API name of the compound field.<p class="p">If the
                  field is not a constituent of a compound field, or if no field applies to the
                  error, the value is <samp class="codeph nolang">null</samp>.</p>
              </td>

              <td class="entry" headers="d161848e61" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d161848e64" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d161848e52" data-title="Property Name"><samp class="codeph nolang">duplicateRecordError</samp></td>

              <td class="entry" headers="d161848e55" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_record_error.htm#ui_api_responses_duplicate_record_error" title="Information about duplicate record errors. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record.">Duplicate Record Error</a></td>

              <td class="entry" headers="d161848e58" data-title="Description">Information about possible duplicate records. When the error code is <samp class="codeph nolang">DUPLICATES_DETECTED</samp>, this property might contain a
                value.</td>

              <td class="entry" headers="d161848e61" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d161848e64" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d161848e52" data-title="Property Name"><samp class="codeph nolang">errorCode</samp></td>

              <td class="entry" headers="d161848e55" data-title="Type">String</td>

              <td class="entry" headers="d161848e58" data-title="Description">An error status code.</td>

              <td class="entry" headers="d161848e61" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d161848e64" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d161848e52" data-title="Property Name">
                <samp class="codeph nolang">field</samp>
              </td>

              <td class="entry" headers="d161848e55" data-title="Type">String</td>

              <td class="entry" headers="d161848e58" data-title="Description"> A field API name. If no field applies to the error, the value is <samp class="codeph nolang">null</samp>. </td>

              <td class="entry" headers="d161848e61" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d161848e64" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d161848e52" data-title="Property Name">
                <samp class="codeph nolang">fieldLabel</samp>
              </td>

              <td class="entry" headers="d161848e55" data-title="Type">String</td>

              <td class="entry" headers="d161848e58" data-title="Description"> A field label. If no field applies to the error, the value is <samp class="codeph nolang">null</samp>. </td>

              <td class="entry" headers="d161848e61" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d161848e64" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d161848e52" data-title="Property Name">
                <samp class="codeph nolang">message</samp>
              </td>

              <td class="entry" headers="d161848e55" data-title="Type">String</td>

              <td class="entry" headers="d161848e58" data-title="Description">An error message.</td>

              <td class="entry" headers="d161848e61" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d161848e64" data-title="Available Version">41.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Record Exceptions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_exception.htm "A collection of record exception errors.")

<!-- document id=9f447b9227c27362b2e249d585375e195c7198e7fac64c2b100801fbf082e1a7 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_exception.md -->

# Record Exceptions

A collection of record exception errors.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| errors | [Record Exception Error](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_exception_error.htm#ui_api_responses_record_exception_error "Information about a record exception error.")\[\] | General errors. | Small, 41.0 | 41.0 |
| fieldErrors | Map<String, [Record Exception Error](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_exception_error.htm#ui_api_responses_record_exception_error "Information about a record exception error.")\[\]> | A map of field IDs to field-specific errors. | Small, 41.0 | 41.0 |

#### See Also

- [Error with Output](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_error_with_output.htm "Contains extra information about errors. In rare cases, an error message isn't enough to describe the reason for a failure. For example, when a conflicting precondition exists, the error result can include the information about the cause of the conflict.")

<!-- document id=3a2d52361c6a257cacc25c70ed6c95e4d9722a0c9df1509a297b5d5cc4ce626f url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_record_input.md -->

# Record Input

A description of a record to use in a request to create or update a record or in a request to check for duplicate records.

Example

POST /ui-api/records

{
  "apiName": "Account",
  "fields": {
    "Name": "Universal Containers"
  }
}

To provide an address, provide the individual fields as separate inputs. The compound field is only available in the response.

{
  "apiName": "Account",
  "fields" : {
    "Name": "Local Boxes",
    "BillingState": "WA",
    "BillingStreet" : "123 Main Street",
    "BillingCountry" : "USA"
  }
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d32098e83">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d32098e86">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d32098e89">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d32098e92">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d32098e95">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d32098e83" data-title="Name"><samp class="codeph nolang">allowSaveOnDuplicate</samp></td>

                  <td class="entry" headers="d32098e86" data-title="Type">Boolean</td>

                  <td class="entry" headers="d32098e89" data-title="Description">Specifies whether to save a duplicate record (<samp class="codeph nolang">true</samp>), or not (<samp class="codeph nolang">false</samp>). The
                    default value is <samp class="codeph nolang">false</samp>.<p class="p">Don’t specify
                      this property when checking for duplicate records.</p>
                  </td>

                  <td class="entry" headers="d32098e92" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d32098e95" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d32098e83" data-title="Name"><samp class="codeph nolang">apiName</samp></td>

                  <td class="entry" headers="d32098e86" data-title="Type">String</td>

                  <td class="entry" headers="d32098e89" data-title="Description">To create a record, specify the API name of an Object from which to
                    create the record. To update a record, use <samp class="codeph nolang">null</samp> or don’t pass this property. To check for duplicate records,
                    specify the API name of the object for which you’re performing the duplicate
                    check.</td>

                  <td class="entry" headers="d32098e92" data-title="Required or Optional">Required to create a record.<p class="p">Required to check for duplicate
                      records.</p>
                  </td>

                  <td class="entry" headers="d32098e95" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d32098e83" data-title="Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d32098e86" data-title="Type">Map&lt;String, Object&gt;</td>

                  <td class="entry" headers="d32098e89" data-title="Description">Map of field names to field values.<p class="p">Format data types according to
                      these rules: </p>
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Address</samp>—JSON String.
                        Addresses are compound fields and must be broken up into their constituent
                        fields. See the previous example.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Boolean</samp>—JSON Boolean,
                        <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Currency</samp>—JSON Number (for
                        example, <samp class="codeph nolang">67.54</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Date</samp>—JSON string (for
                        example, <samp class="codeph nolang">2020-04-20</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">DateTime</samp>—JSON string in ISO
                        8601 format (for example, <samp class="codeph nolang">2012-02-18T06:40:41.000Z</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Double</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Email</samp>—JSON String (for
                        example, <samp class="codeph nolang">joe@smith.com</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">EncryptedString</samp>—JSON
                        String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Int</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Location</samp>—JSON String.
                        Location fields are compound fields and must be broken up into their
                        constituent fields.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">MultiPicklist</samp>—JSON String
                        (for example, <samp class="codeph nolang">Dog;Cat;Fish)</samp>.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Percent</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Phone</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Picklist</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Reference</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">String</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">TextArea</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Time</samp>—JSON String in format
                        <samp class="codeph nolang">HH:MM:SS</samp>
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Url</samp>—JSON String
                      </li>

                    </ul>
                    <p class="p">To specify the main record type, either don’t specify the <samp class="codeph nolang">RecordTypeId</samp> field, or set it to <samp class="codeph nolang">null</samp>.</p>
                  </td>

                  <td class="entry" headers="d32098e92" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d32098e95" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Create or Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_create.htm "Create or clone a record.")
- [Update a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_patch.htm "Update a record's data.")
- [Check for Duplicate Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_predupe_create.htm "Before updating or creating a record, you can check whether a duplicate record exists. Use the response to learn whether to block or allow the action, and whether to warn the user.")
- [Lookup Post Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_lookup_post_input.htm "Get lookup field suggestions.")

<!-- document id=4496c26f40b6d7b0ad6ae4c6359e90896ffc5f04c4f9ccd5fa6ef9a70f5dfff5 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout.md -->

# Record Layout

The layout information for a record.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d162701e33">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d162701e35">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d162701e37">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d162701e39">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d162701e41">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">id</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The layout ID.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">layoutType</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The layout type for the record. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Compact</samp>—Use this value to get a layout
                    that contains a record’s key fields.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Full</samp>—(Default) Use this value to get a
                    full layout.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">mode</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The access mode for the record. This value determines which fields to get from
                a layout. Layouts have different fields for create, edit, and view modes. For
                example, formula fields are rendered in view mode, but not in create mode because
                they’re calculated at run time, like formulas in a spreadsheet. One of these values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Create</samp>—Use this mode if you intend to
                    build UI that lets a user create a record. This mode is used by the <samp class="codeph nolang">/ui-api/record-defaults/create/{apiName}</samp>
                    resource.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Edit</samp>—Use this mode if you intend to build
                    UI that lets a user edit a record. This mode is used by the <samp class="codeph nolang">/ui-api/record-defaults/clone/{recordId}</samp>
                    resource.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">View</samp>—(Default) Use this mode to build UI
                    that displays a record.
                  </li>

                </ul>
              </td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">objectApiName</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The API name of the object that the layout is associated with.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">recordTypeId</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">String</td>

              <td class="entry" headers="d162701e37" data-title="Description">The record type ID for this record.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">saveOptions</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_save_option.htm" title="The save option for a record layout. Save options define behavior that occurs when objects are created or modified using the given layout. For example, for Cases and Leads, a “UseDefaultAssignmentRule” save option is exposed to control whether assignment rules are applied when Cases or Leads are created or edited.">Record Layout Save Option</a>[]
              </td>

              <td class="entry" headers="d162701e37" data-title="Description">The save options for the layout.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 51.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">51.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d162701e33" data-title="Property Name"><samp class="codeph nolang">sections</samp></td>

              <td class="entry" headers="d162701e35" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_section.htm#ui_api_responses_record_layout_section" title="A section in a record layout.">Record Layout Section</a>[]
              </td>

              <td class="entry" headers="d162701e37" data-title="Description">A collection of layout sections.</td>

              <td class="entry" headers="d162701e39" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d162701e41" data-title="Available Version">41.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [Record UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_ui.htm "The layout information, field information, and data for a record.")
- [Record Defaults](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults.htm "The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records.")
- [Quick Action Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_quick_action_layout.htm "The record layout used by the quick action.")
- [Get Record Layout Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_layout.htm "Get metadata about page layouts for the specified object type.")
- [Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.")
- [Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.")

<!-- document id=49902e705bf2a192d7c2bad1da75bc6ba5de6d52ee7e7210e804d3f9c0d0bfad url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout_component.md -->

# Record Layout Component

A concrete record layout component.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d163811e39">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d163811e42">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d163811e45">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d163811e48">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d163811e51">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d163811e39" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d163811e42" data-title="Type">String</td>

              <td class="entry" headers="d163811e45" data-title="Description">If a field powers this component, this property contains the API name of the field.</td>

              <td class="entry" headers="d163811e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d163811e51" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d163811e39" data-title="Property Name"><samp class="codeph nolang">componentType</samp></td>

              <td class="entry" headers="d163811e42" data-title="Type">String</td>

              <td class="entry" headers="d163811e45" data-title="Description">One of these values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Canvas</samp></li>

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

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d163811e48" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d163811e51" data-title="Available Version">41.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.")

<!-- document id=51a720bfcfc0e78ccc1226cbcd8742566c0c45252c95ff3588f4b45cda43ed2e url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout_item.md -->

# Record Layout Item

An item in a record layout.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d164218e37">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d164218e40">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d164218e43">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d164218e46">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d164218e49">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d164218e37" data-title="Property Name"><samp class="codeph nolang">editableForNew</samp></td>

              <td class="entry" headers="d164218e40" data-title="Type">Boolean</td>

              <td class="entry" headers="d164218e43" data-title="Description">Indicates whether the item can be edited when creating a record.</td>

              <td class="entry" headers="d164218e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d164218e49" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d164218e37" data-title="Property Name"><samp class="codeph nolang">editableForUpdate</samp></td>

              <td class="entry" headers="d164218e40" data-title="Type">Boolean</td>

              <td class="entry" headers="d164218e43" data-title="Description">Indicates whether the item can be edited when updating a record.</td>

              <td class="entry" headers="d164218e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d164218e49" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d164218e37" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d164218e40" data-title="Type">String</td>

              <td class="entry" headers="d164218e43" data-title="Description">The text label for the item.</td>

              <td class="entry" headers="d164218e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d164218e49" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d164218e37" data-title="Property Name"><samp class="codeph nolang">layoutComponents</samp></td>

              <td class="entry" headers="d164218e40" data-title="Type">Collection of components. Collection can contain any of these components:<a name="AbstractRecordLayoutComponent"><!-- --></a>
                <ul class="ul bulletList" id="AbstractRecordLayoutComponent">
                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_canvas_layout_component.htm#ui_api_responses_canvas_layout_component" title="A canvas component on a record page layout.">Canvas Layout Component</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_custom_link_layout_component.htm#ui_api_responses_custom_link_layout_component" title="A custom link component on a record page layout.">Custom Link Layout Component</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field_layout_component.htm#ui_api_responses_field_layout_component" title="A field in a record layout.">Field Layout Component</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_component.htm#ui_api_responses_record_layout_component" title="A concrete record layout component.">Record Layout Component</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_report_layout_component.htm#ui_api_responses_report_layout_component" title="A report chart component on a record layout page.">Report Layout Component</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_visualforce_layout_component.htm#ui_api_responses_visualforce_layout_component" title="A Visualforce component on a record layout page.">Visualforce Layout Component</a></li>

                </ul>
              </td>

              <td class="entry" headers="d164218e43" data-title="Description">A collection of components that make up the item.</td>

              <td class="entry" headers="d164218e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d164218e49" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d164218e37" data-title="Property Name"><samp class="codeph nolang">lookupIdApiName</samp></td>

              <td class="entry" headers="d164218e40" data-title="Type">String</td>

              <td class="entry" headers="d164218e43" data-title="Description">The ID field name of a lookup field.</td>

              <td class="entry" headers="d164218e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d164218e49" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d164218e37" data-title="Property Name"><samp class="codeph nolang">required</samp></td>

              <td class="entry" headers="d164218e40" data-title="Type">Boolean</td>

              <td class="entry" headers="d164218e43" data-title="Description">Indicates whether the field is required in a layout when creating or updating a
                record. This information is useful to know if you wanted to render required fields
                with a different treatment, such as a red outline.</td>

              <td class="entry" headers="d164218e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d164218e49" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d164218e37" data-title="Property Name"><samp class="codeph nolang">sortable</samp></td>

              <td class="entry" headers="d164218e40" data-title="Type">Boolean</td>

              <td class="entry" headers="d164218e43" data-title="Description">Indicates whether the layout item is sortable.</td>

              <td class="entry" headers="d164218e46" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d164218e49" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d164218e37" data-title="Property Name"><samp class="codeph nolang">uiBehavior</samp></td>

              <td class="entry" headers="d164218e40" data-title="Type">String</td>

              <td class="entry" headers="d164218e43" data-title="Description">Indicates the layout item behavior on the specified layout. The value doesn't
                reflect user-level or profile-level access. Available values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Edit</samp>—The layout field can be
                    edited but isn’t required.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Required</samp>—The layout field can be
                    edited and is required.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Readonly</samp>—The layout field is
                    read-only.
                  </li>

                </ul>
                <p class="p">This field applies only to page layouts and mini layouts. For other types of
                  layouts, such as compact layouts or quick action layouts, this field is <samp class="codeph nolang">null</samp>.</p>
              </td>

              <td class="entry" headers="d164218e46" data-title="Filter Group and Version">Small, 63.0</td>

              <td class="entry" headers="d164218e49" data-title="Available Version">63.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Record Layout Row](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_row.htm "A row in a record layout.")

<!-- document id=2da65ff38f6a2b08746f01d4d2f85a5b96e6cbe287434e1ee9b0b4c1ae39d508 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout_row.md -->

# Record Layout Row

A row in a record layout.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| layoutItems | [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm#ui_api_responses_record_layout_item "An item in a record layout.")\[\] | A collection of items in the row, from left to right. Might not extend to the last column. | Small, 41.0 | 41.0 |

#### See Also

- [Record Layout Section](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_section.htm "A section in a record layout.")

<!-- document id=7b9ef0dc66f81907c9bdaab52629f6eda5e142c680a503c7c121da789c2e9bcf url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout_save_option.md -->

# Record Layout Save Option

The save option for a record layout. Save options define behavior that occurs when objects are created or modified using the given layout. For example, for Cases and Leads, a “UseDefaultAssignmentRule” save option is exposed to control whether assignment rules are applied when Cases or Leads are created or edited.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| defaultValue | Boolean | Indicates whether the save option defaults to enabled (true) or not (false). | Small, 51.0 | 51.0 |
| isDisplayed | Boolean | Indicates whether the save option is displayed in the layout or not. | Small, 51.0 | 51.0 |
| label | String | Label for the save option. | Small, 51.0 | 51.0 |
| name | String | API name for the save option. | Small, 51.0 | 51.0 |
| restHeaderName | String | REST API header for the save option. | Small, 51.0 | 51.0 |
| soapHeaderName | String | SOAP API header for the save option. | Small, 51.0 | 51.0 |

<!-- document id=a7049c6a2a6eca58d50916e6c8f6bd3cb06c633272c357bf9325156d72aac3ef url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout_section.md -->

# Record Layout Section

A section in a record layout.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d166457e28">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d166457e30">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d166457e32">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d166457e34">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d166457e36">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d166457e28" data-title="Property Name"><samp class="codeph nolang">collapsible</samp></td>

              <td class="entry" headers="d166457e30" data-title="Type">Boolean</td>

              <td class="entry" headers="d166457e32" data-title="Description">Indicates whether the section can be collapsed.</td>

              <td class="entry" headers="d166457e34" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d166457e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d166457e28" data-title="Property Name"><samp class="codeph nolang">columns</samp></td>

              <td class="entry" headers="d166457e30" data-title="Type">Integer</td>

              <td class="entry" headers="d166457e32" data-title="Description">The number of columns in the section.</td>

              <td class="entry" headers="d166457e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d166457e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d166457e28" data-title="Property Name"><samp class="codeph nolang">heading</samp></td>

              <td class="entry" headers="d166457e30" data-title="Type">String</td>

              <td class="entry" headers="d166457e32" data-title="Description">The heading text for the section.</td>

              <td class="entry" headers="d166457e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d166457e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d166457e28" data-title="Property Name"><samp class="codeph nolang">id</samp></td>

              <td class="entry" headers="d166457e30" data-title="Type">String</td>

              <td class="entry" headers="d166457e32" data-title="Description">The ID of the section.</td>

              <td class="entry" headers="d166457e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d166457e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d166457e28" data-title="Property Name"><samp class="codeph nolang">layoutRows</samp></td>

              <td class="entry" headers="d166457e30" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_row.htm#ui_api_responses_record_layout_row" title="A row in a record layout.">Record Layout Row</a>[]
              </td>

              <td class="entry" headers="d166457e32" data-title="Description">A collection of the rows in the section.</td>

              <td class="entry" headers="d166457e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d166457e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d166457e28" data-title="Property Name"><samp class="codeph nolang">rows</samp></td>

              <td class="entry" headers="d166457e30" data-title="Type">Integer</td>

              <td class="entry" headers="d166457e32" data-title="Description">The number of rows in the section.</td>

              <td class="entry" headers="d166457e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d166457e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d166457e28" data-title="Property Name"><samp class="codeph nolang">tabOrder</samp></td>

              <td class="entry" headers="d166457e30" data-title="Type">String</td>

              <td class="entry" headers="d166457e32" data-title="Description">Indicates the tab order for the items in the section during view and edit.
                Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">LeftRight</samp></li>

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

                </ul>
              </td>

              <td class="entry" headers="d166457e34" data-title="Filter Group and Version">Small, 63.0</td>

              <td class="entry" headers="d166457e36" data-title="Available Version">63.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d166457e28" data-title="Property Name"><samp class="codeph nolang">useHeading</samp></td>

              <td class="entry" headers="d166457e30" data-title="Type">Boolean</td>

              <td class="entry" headers="d166457e32" data-title="Description">Indicates whether the heading text is expected to be displayed.</td>

              <td class="entry" headers="d166457e34" data-title="Filter Group and Version">Medium, 41.0</td>

              <td class="entry" headers="d166457e36" data-title="Available Version">41.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [Record Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout.htm "The layout information for a record.")

<!-- document id=f855e3056b5963db5ba23e6cbbc5fda74b037aa17b3621d84e7b69aac9d2c163 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout_section_user_state.md -->

# Record Layout Section User State

The user state information for a record layout section.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| collapsed | Boolean | Indicates whether the section is initially displayed as collapsed (true) or expanded (false). | Small, 41.0 | 41.0 |
| id | String | The ID of a layout section. | Small, 41.0 | 41.0 |

#### See Also

- [Record UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_ui.htm "The layout information, field information, and data for a record.")

<!-- document id=5a3c014aba1b7b45bf4986d0ef038db46da9f6ce5a7efeeedf972510625ebbb3 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_layout_user_state.md -->

# Record Layout User State

The user state information for a record layout.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| id | String | The ID of a layout. | Small, 41.0 | 41.0 |
| sectionUserStates | Map<String, [Record Layout Section User State](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_section_user_state.htm#ui_api_responses_record_layout_section_user_state "The user state information for a record layout section.")\> | A map of layout section user states, keyed to section IDs. | Small, 41.0 | 41.0 |

<!-- document id=61e63ca4fb38671a946780a56520b64c34a35e57d39df1ac2afbb4dcb023f073 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_template_clone.md -->

# Record Template Clone

A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d168225e54">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d168225e57">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d168225e60">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d168225e63">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d168225e66">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d168225e54" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d168225e57" data-title="Type">String</td>

              <td class="entry" headers="d168225e60" data-title="Description">The record's object API name.</td>

              <td class="entry" headers="d168225e63" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d168225e66" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d168225e54" data-title="Property Name"><samp class="codeph nolang">cloneSourceId</samp></td>

              <td class="entry" headers="d168225e57" data-title="Type">String</td>

              <td class="entry" headers="d168225e60" data-title="Description">The ID of the cloned record. This top-level property returns the same result as
                <samp class="codeph nolang">CloneSourceId</samp> in the <samp class="codeph nolang">fields</samp> property.
              </td>

              <td class="entry" headers="d168225e63" data-title="Filter Group and Version">Small, 52.0</td>

              <td class="entry" headers="d168225e66" data-title="Available Version">52.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d168225e54" data-title="Property Name"><samp class="codeph nolang">fields</samp></td>

              <td class="entry" headers="d168225e57" data-title="Type">Map&lt;String, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field_value.htm" title="The raw and displayable field values for a field in a record.">Field Value</a>&gt;</td>

              <td class="entry" headers="d168225e60" data-title="Description">A map of field data for the record.<p class="p">The response includes only requested
                  fields and <samp class="codeph nolang">CloneSourceId</samp>. If you don’t pass
                  any fields, the response includes only <samp class="codeph nolang">CloneSourceId</samp>.</p>
              </td>

              <td class="entry" headers="d168225e63" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d168225e66" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d168225e54" data-title="Property Name"><samp class="codeph nolang">recordTypeId</samp></td>

              <td class="entry" headers="d168225e57" data-title="Type">String</td>

              <td class="entry" headers="d168225e60" data-title="Description">The RecordType ID of the record.</td>

              <td class="entry" headers="d168225e63" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d168225e66" data-title="Available Version">49.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Record Defaults Template Clone](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults_template_clone.htm "A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records.")

<!-- document id=5d03fb6122c7b1d544a37bee927b21d511a5410731ffefe568ababc5ad531aee url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_template_create.md -->

# Record Template Create

A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d168848e54">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d168848e57">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d168848e60">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d168848e63">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d168848e66">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d168848e54" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d168848e57" data-title="Type">String</td>

              <td class="entry" headers="d168848e60" data-title="Description">The record’s object API name.</td>

              <td class="entry" headers="d168848e63" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d168848e66" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d168848e54" data-title="Property Name"><samp class="codeph nolang">fields</samp></td>

              <td class="entry" headers="d168848e57" data-title="Type">Map&lt;String, <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field_value.htm" title="The raw and displayable field values for a field in a record.">Field Value</a>&gt;</td>

              <td class="entry" headers="d168848e60" data-title="Description">A map of field data for the record.<p class="p">If you don’t pass any fields, the
                  response doesn’t include any fields.</p>
              </td>

              <td class="entry" headers="d168848e63" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d168848e66" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d168848e54" data-title="Property Name"><samp class="codeph nolang">recordTypeId</samp></td>

              <td class="entry" headers="d168848e57" data-title="Type">String</td>

              <td class="entry" headers="d168848e60" data-title="Description">The RecordType ID of the record.</td>

              <td class="entry" headers="d168848e63" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d168848e66" data-title="Available Version">49.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Record Defaults Template Create](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults_template_create.htm "A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records.")

<!-- document id=ba20c06b83006c5c7c05b3c87b3792d379557acb842deb425eef9865c5eb55f6 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_type_info.md -->

# Record Type Info

Information about a record type.

![Important](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| available | Boolean | Indicates whether this record type is available to the context user when creating a record. | Small, 41.0 | 41.0 |
| defaultRecordTypeMapping | Boolean | Indicates whether this record type mapping is the default for the associated object. | Small, 41.0 | 41.0 |
| master | Boolean | Indicates whether this record type is the master record type. The master record type is the default record type that’s used when a record has no custom record type associated with it. | Small, 41.0 | 41.0 |
| name | String | The UI label of the record type. The label can be translated into any language that Salesforce supports. | Small, 41.0 | 41.0 |
| recordTypeId | String | The ID of the record type. | Small, 41.0 | 41.0 |

#### See Also

- [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm "The field data, API name, child relationship data, and record type information for a record.")
- [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm "The metadata for an object.")

<!-- document id=ef04fe92b3b091e3482a2827b1dc3b7fe0928d3153c844bd18284a556bfe28eb url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_record_ui.md -->

# Record UI

The layout information, field information, and data for a record.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| layoutUserStates | Map<String, [Record Layout User State](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_user_state.htm "The user state information for a record layout.")\> | A map of layout IDs to user state information. | Medium, 41.0 | 41.0 |
| layouts | Map<String, Map<String, Map<String, Map<String, [Record Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout.htm#ui_api_responses_record_layout "The layout information for a record.")\>>>> | A map of object API names to layout information for each object. | Medium, 41.0 | 41.0 |
| objectInfos | Map<String, [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm#ui_api_responses_object_info "The metadata for an object.")\> | A map of object API names to each object’s metadata. | Big, 41.0 | 41.0 |
| records | Map<String, [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.")\> | A map of record IDs to each record’s data. | Small, 41.0 | 41.0 |

#### See Also

- [Get Record Data and Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm "Get layout information, metadata, and data to build UI for a single record or for a collection of records.")

<!-- document id=4cddbfb1e3e32c00e5fdbf09d8cef54386e0c79dee156be04dca9f6005be8b2b url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record.md -->

# Records

Use these resources to get metadata and data about objects and records. These resources make it easy to build Salesforce UI.

- **[Get Record Data and Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_ui.htm)**  
    Get layout information, metadata, and data to build UI for a single record or for a collection of records.
- **[Get Record Layout Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_layout.htm)**  
    Get metadata about page layouts for the specified object type.
- **[Get a Directory of Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info_directory.htm)**  
    Get a directory of objects that are supported by User Interface API and accessible to the context user. The directory includes a /ui-api/object-info/{objectApiName} resource for each supported object.
- **[Get Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info.htm)**  
    Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.
- **[Get a Batch of Object Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info_batch.htm)**  
    Get metadata about specific objects. The response includes a batch of metadata describing fields, child relationships, record type, and theme. You can request up to 2,000 objects in an object metadata request.
- **[Get Values for a Picklist Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values.htm)**  
    If a field’s dataType property is equal to Picklist or MultiPicklist, use this resource to get its values.
- **[Get Values for All Picklist Fields of a Record Type](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_picklist_values_collection.htm)**  
    Use this resource to get the values for all the picklist fields of a specific record type. This resource is especially useful for getting dependent picklist values. For example, if an object has a tree of dependent picklists (Continents\_\_c, Countries\_\_c, Cities\_\_c), use this resource to get all the values for each picklist in one request.
- **[Get Child Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_child_relationships.htm)**  
    Get child records for a specified record and child relationship name. Relationships are connections between records. On a record detail page, each record in a related list has a child relationship to the parent record.
- **[Get a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_get.htm)**  
    Get a record’s data.
- **[Get a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch.htm)**  
    Get data for a batch of records.
- **[Create or Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_create.htm)**  
    Create or clone a record.
- **[Create a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_post.htm)**  
    Create multiple records. You can create, update, and delete up to 200 records in a single request.
- **[Get Default Values to Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_clone.htm)**  
    Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.
- **[Get Default Values to Clone a Record—Lightweight](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_template_clone.htm)**  
    Get the default values for fields for cloning a record. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.
- **[Get Default Values to Create a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_create.htm)**  
    Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.
- **[Get Default Values to Create a Record—Lightweight](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_defaults_template_create.htm)**  
    Get the default values for fields for a new record of a specified object and optional record type. You must specify the fields you want returned. This resource doesn’t use or return layout information. After getting the default values, make a request to POST /ui-api/records to create the record.
- **[Update a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_patch.htm)**  
    Update a record's data.
- **[Update a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_update.htm)**  
    Update multiple records. You can create, update, and delete up to 200 records in a single request.
- **[Delete a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_delete.htm)**  
    Delete a record.
- **[Delete a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_delete.htm)**  
    Delete multiple records. You can create, update, and delete up to 200 records in a single request.
- **[Get Lookup Field Suggestions With POST](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_post.htm)**  
    When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You must specify dependent lookup field values used by lookup filters in the \`sourceRecord\` request body parameter.
- **[Check for Duplicate Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_predupe_create.htm)**  
    Before updating or creating a record, you can check whether a duplicate record exists. Use the response to learn whether to block or allow the action, and whether to warn the user.
- **[Get Duplicate Management Configuration for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_duplicates_get.htm)**  
    Learn whether duplicate management is configured for the specified object. If duplicate management is configured, learn about the object's duplicate rules and matching rules. Use the information in the response to know when to check for duplicate records.
- **[Upload a File](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_contentversion.htm)**  
    Upload a file such as a document or image.
- **[Upload a New File Version](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_contentdocument.htm)**  
    Upload a new document or image version.

<!-- document id=b2a6ba02d7dc062fed81c3dbbd7d6c429c53cb26f5e93bdd4fa659aeb88660f5 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_reference_to_info.md -->

# Reference To Info

Information about a reference field's referenced types and the name field names of those types.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | The object API name of a type being referenced in a relationship. | Small, 41.0 | 41.0 |
| nameFields | String\[\] | A collection of names of the name fields for this object type. Combined with the relationship name, you can determine how to query this type's name fields, for example, Parent.Name. Typically there is one name field per object, except where FirstName and LastName fields are used. | Small, 41.0 | 41.0 |

#### See Also

- [Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field.htm "A field's metadata.")

<!-- document id=21adde01416b4b02f9a814286f885487379af5ea9a6155337ed819da3214e582 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_related_list_column.md -->

# Related List Column

A column in a related list.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d171043e51">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d171043e54">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d171043e57">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d171043e60">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d171043e63">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d171043e51" data-title="Property Name"><samp class="codeph nolang">dataType</samp></td>

              <td class="entry" headers="d171043e54" data-title="Type">String</td>

              <td class="entry" headers="d171043e57" data-title="Description">Field type. One of these values:<a name="RecordFieldDataType"><!-- --></a>
                <ul class="ul bulletList" id="RecordFieldDataType">
                  <li class="li">
                    <samp class="codeph nolang">address</samp>
                  </li>

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

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

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

                  <li class="li">
                    <samp class="codeph nolang">complexvalue</samp>—Complex Value type
                    (cvt)
                  </li>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

                </ul>
              </td>

              <td class="entry" headers="d171043e60" data-title="Filter Group and Version">Small, 57.0</td>

              <td class="entry" headers="d171043e63" data-title="Available Version">57.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d171043e51" data-title="Property Name"><samp class="codeph nolang">fieldApiName</samp></td>

              <td class="entry" headers="d171043e54" data-title="Type">String</td>

              <td class="entry" headers="d171043e57" data-title="Description">The API name for the field.</td>

              <td class="entry" headers="d171043e60" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d171043e63" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d171043e51" data-title="Property Name"><samp class="codeph nolang">filterable</samp></td>

              <td class="entry" headers="d171043e54" data-title="Type">Boolean</td>

              <td class="entry" headers="d171043e57" data-title="Description">Indicates whether this column is filterable (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

              <td class="entry" headers="d171043e60" data-title="Filter Group and Version">Small, 57.0</td>

              <td class="entry" headers="d171043e63" data-title="Available Version">57.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d171043e51" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

              <td class="entry" headers="d171043e54" data-title="Type">String</td>

              <td class="entry" headers="d171043e57" data-title="Description">The label of the field.</td>

              <td class="entry" headers="d171043e60" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d171043e63" data-title="Available Version">42.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d171043e51" data-title="Property Name"><samp class="codeph nolang">lookupId</samp></td>

              <td class="entry" headers="d171043e54" data-title="Type">String</td>

              <td class="entry" headers="d171043e57" data-title="Description">The ID of the field if the field is a reference. If the field isn’t a
                reference, the value can be null.</td>

              <td class="entry" headers="d171043e60" data-title="Filter Group and Version">Small, 49.0</td>

              <td class="entry" headers="d171043e63" data-title="Available Version">49.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d171043e51" data-title="Property Name"><samp class="codeph nolang">picklistValues</samp></td>

              <td class="entry" headers="d171043e54" data-title="Type">String[]</td>

              <td class="entry" headers="d171043e57" data-title="Description">The picklist values for this field. <samp class="codeph nolang">Null</samp>
                if the field isn’t a picklist field.</td>

              <td class="entry" headers="d171043e60" data-title="Filter Group and Version">Small, 57.0</td>

              <td class="entry" headers="d171043e63" data-title="Available Version">57.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d171043e51" data-title="Property Name"><samp class="codeph nolang">quickFilterOperator</samp></td>

              <td class="entry" headers="d171043e54" data-title="Type">String</td>

              <td class="entry" headers="d171043e57" data-title="Description">The operator used for quick filters on this column.</td>

              <td class="entry" headers="d171043e60" data-title="Filter Group and Version">Small, 57.0</td>

              <td class="entry" headers="d171043e63" data-title="Available Version">57.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d171043e51" data-title="Property Name"><samp class="codeph nolang">sortable</samp></td>

              <td class="entry" headers="d171043e54" data-title="Type">Boolean</td>

              <td class="entry" headers="d171043e57" data-title="Description">Indicates whether the list column is sortable.</td>

              <td class="entry" headers="d171043e60" data-title="Filter Group and Version">Small, 42.0</td>

              <td class="entry" headers="d171043e63" data-title="Available Version">42.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Related List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm "Metadata that describes a related list.")
- [Get Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_md.htm "Returns metadata for a related list in a page layout.")
- [Update Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_md_patch.htm "Update metadata for a related list in a page layout.")

<!-- document id=fc8448e2d559d3681280e28193c597b4390214d194c230c543b7ed4b8418a8dd url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_related_list_metadata.md -->

# Related List Info

Metadata that describes a related list.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| cloneable | Boolean | Indicates whether the related list can be cloned. | Small, 50.0 | 50.0 |
| createable | Boolean | Indicates whether a new related list for this related list’s object can be created. | Small, 50.0 | 50.0 |
| deletable | Boolean | Indicates whether the related list can be deleted. | Small, 50.0 | 50.0 |
| displayColumns | [Related List Column](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_column.htm "A column in a related list.")\[\] | All display columns for this related list. | Small, 50.0 | 50.0 |
| fieldApiName | String | The API name of the field in the child object that links to the parent object. | Small, 51.0 | 51.0 |
| fields | String\[\] | Related list fields queried. If a field is specified and the user doesn’t have access to it or it doesn’t exist, an error occurs. | Small, 57.0 | 57.0 |
| filterable | Boolean | Indicates whether users can apply quick filters to the related list. | Small, 58.0 | 58.0 |
| filterLogicString | String | The filter logic string, such as (1 OR 2) and 3. Related lists don’t support saved filters, so the value is always empty. | Small, 50.0 | 50.0 |
| filteredByInfo | [List Filter by Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_filter_by_info.htm#ui_api_responses_list_filter_by_info "Information used to filter a list.")\[\] | Filtering information for the related list. Related lists don’t support saved filters, so the value is always empty. | Small, 50.0 | 50.0 |
| label | String | The related list display label. For example, Contracts. | Small, 50.0 | 50.0 |
| listReference | [Related List Reference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_reference.htm "The related list referenced by the collection or metadata.") | A reference to the related list. | Small, 50.0 | 50.0 |
| objectApiNames | String\[\] | The API names for the objects returned in the related list. The objects returned depend on the parent object’s layout. | Small, 51.0 | 51.0 |
| orderedByInfo | [List Order By Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_order_by_info.htm#ui_api_responses_list_order_by_info "Ordering information for a list.")\[\] | Ordering information for the related list. | Small, 50.0 | 50.0 |
| optionalFields | String\[\] | Additional related list fields queried. If a field is specified and the user doesn’t have access to it, no error occurs. | Small, 57.0 | 57.0 |
| restrictColumnsToLayout | Boolean | Indicates whether metadata was retrieved for only the list columns in the page layout (true) or all columns (false). | Small, 57.0 | 57.0 |
| updateable | Boolean | Indicates whether the related list can be updated. | Small, 50.0 | 50.0 |
| userPreferences | [List User Preference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_user_preference.htm#ui_api_responses_list_user_preference "User preferences for the list view.") | User preferences for the related list. | Small, 50.0 | 50.0 |
| visibility | String | The related list’s visibility. Related lists are always Public. | Small, 50.0 | 50.0 |
| visibilityEditable | Boolean | Indicates whether the visibility of the related list can be edited. The value is always false. | Small, 50.0 | 50.0 |

#### See Also

- [Get Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_md.htm "Returns metadata for a related list in a page layout.")
- [Update Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_md_patch.htm "Update metadata for a related list in a page layout.")

<!-- document id=4170aa003da3b71f2d9bf5e90068c7ff25a6c85ec5686dca6b4a42277ff3691f url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_related_list_summary.md -->

# Related List Info Summary

A summary of a related list for an object.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| entityLabel | String | The label for the related list object. | Small, 50.0 | 50.0 |
| entityLabelPlural | String | The plural label for the related list object. | Small, 50.0 | 50.0 |
| fieldApiName | String | The API name of the field in the child object that links to the parent object. | Small, 50.0 | 50.0 |
| keyPrefix | String | The key prefix for IDs of the object that populates the list. This can be null for some related lists. | Small, 50.0 | 50.0 |
| label | String | The related list label. | Small, 50.0 | 50.0 |
| objectApiName | String | The API name for the object. | Small, 50.0 | 50.0 |
| parentFieldApiName | String | The name of the field that relates the object to the parent object. | Small, 50.0 | 50.0 |
| relatedListId | String | The ID of the related list. | Small, 50.0 | 50.0 |
| relatedListInfoUrl | String | The URL to fetch the metadata for the related list. | Small, 50.0 | 50.0 |
| themeInfo | [Theme Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_info.htm "Color and icon information for a theme.") | The theme info for the related list object. | Small, 50.0 | 50.0 |

#### See Also

- [Related List Info Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_summary_collection.htm "A collection of related lists for a given object.")

<!-- document id=ac8961091573227808dbbb27924b14eea2b5db14a5e0ae67e0b0f86ee14256d6 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_related_list_summary_collection.md -->

# Related List Info Summary Collection

A collection of related lists for a given object.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| parentObjectApiName | String | The API name of the parent object. | Small, 50.0 | 50.0 |
| parentRecordTypeId | ID | The record type ID of the parent. | Small, 50.0 | 50.0 |
| relatedLists | [Related List Summary](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_summary.htm "A summary of a related list for an object.") | Related list information. | Small, 50.0 | 50.0 |

#### See Also

- [Get Related Lists for an Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_object.htm "Returns the related lists in an object’s default layout.")

<!-- document id=d6598fa5e7c345c8af604f5511461d24cb0686cf0e97b91bfaf2a9e6b687c46f url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_related_list_input.md -->

# Related List Input

A related list to update.

Example

This example uses a request body to update the metadata for the Contracts related list for the Account object:

PATCH /services/data/v68.0/ui-api/related-list-info/Account/Contracts

{ 
  "orderedByInfo" : \[{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }\],
  "userPreferences" : {
    "columnWidths" : {
        "Name" : -1
    },
    "columnWrap" : {
        "Name" : false
    }
  }
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| orderedByInfo | [List Order By Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm "Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.")\[\] | A related list’s ordering information. In API version 63.0 and later, you can sort by up to five fields. | Optional | 50.0 |
| userPreferences | [List User Preference Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_user_preference_input.htm "A related list user preferences to update.") | A related list’s user preferences. | Optional | 50.0 |

#### See Also

- [Update Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_md_patch.htm "Update metadata for a related list in a page layout.")
- [List Order By Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm "Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.")
- [List User Preference Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_user_preference_input.htm "A related list user preferences to update.")

<!-- document id=2fedc5004db73836708de27f72a8d313dae32e491b6cc711771cb635648042b1 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_related_list_record_collection.md -->

# Related List Record Collection

A collection of related list records.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| count | Integer | The total count of records returned. | Small, 50.0 | 50.0 |
| columnLabels | Map<String, String> | Map of column API name to column label. | Small, 65.0 | 65.0 |
| currentPageToken | String | The token for the current page of records. | Small, 50.0 | 50.0 |
| currentPageUrl | String | The URL of the current page of records. | Small, 50.0 | 50.0 |
| fields | String\[\] | The list of fields requested when these records were fetched. If a field isn’t available to the user, an error occurs. | Small, 50.0 | 50.0 |
| listInfoETag | String | An [ETag](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_intro.htm#ui_api_get_started_intro "Learn the high-level facts about how to use User Interface API. How do you authenticate? How is the API versioned? What are the rate limits? All the information you need, available at a glance.") that indicates whether the metadata has changed. | Small, 50.0 | 50.0 |
| listReference | [Related List Reference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_reference.htm "The related list referenced by the collection or metadata.") | The reference to the related list that contains the records. | Small, 50.0 | 50.0 |
| nextPageToken | String | The token for the next page of records. | Small, 50.0 | 50.0 |
| nextPageUrl | String | The URL of the next page of records. | Small, 50.0 | 50.0 |
| optionalFields | String\[\] | The list of optional fields requested when these records were fetched. If a field isn’t available to the user, no error occurs and the field isn’t included in the response. | Small, 50.0 | 50.0 |
| pageSize | Integer | The number of list records viewed at one time. The default value is 50. | Small, 50.0 | 50.0 |
| previousPageToken | String | The token for the previous page of records. | Small, 50.0 | 50.0 |
| previousPageUrl | String | The URL of the previous page of records. | Small, 50.0 | 50.0 |
| records | [Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.")\[\] | A collection of records. | Small, 50.0 | 50.0 |
| sortBy | String | The API name of the field the list view is sorted by. If the name is preceded with \-, the sort order is descending. | Small, 50.0 | 50.0 |
| where | String | The filter applied to returned records, in GraphQL syntax. For example, { and: \[ { StageName: { eq: "Prospecting" } }, { Account: { Name: { eq: "Dickenson plc" } } } \] } filters an Opportunity related list to show only opportunities in the Prospecting stage that are linked to the “Dickenson plc” account. | Small, 55.0 | 55.0 |

#### See Also

- [Get Related List Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records.htm "Returns record data for up to 1,999 records in a related list via URL parameters.")
- [Get Related List Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_get.htm "Returns record data for up to 1,999 records in a related list. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.")

<!-- document id=765a74d401f13243a73cdbfc84a8fda4131b8e6cf43e57ff2a0ee849d79bb906 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_related_list_record_count.md -->

# Related List Record Count

The number of records in a given related list.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| count | Integer | The number of records in the related list. | Small, 50.0 | 50.0 |
| hasMore | Boolean | Indicates whether there are more records than the provided count. | Small, 50.0 | 50.0 |
| listReference | [Related List Reference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_reference.htm "The related list referenced by the collection or metadata.") | The related list referenced. | Small, 50.0 | 50.0 |

#### See Also

- [Get Related List Record Count](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_count.htm "Returns the record count for a related list.")

<!-- document id=f35b6271429523227ba88dbf824fff03c88d276e9a042c9657567f10a926de6d url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_related_list_record_batch_input.md -->

# Related List Records Batch Input

Get record data for a batch of related lists.

JSON example

To get record data for the Contacts and Opportunities related lists for the account record 001xx000003GYOpAAO, use the following request.

POST /ui-api/related-list-records/batch/001xx000003GYOpAAO

{
    "relatedListParameters":
    \[
        {
            "relatedListId": "Contacts",
            "fields": \["Name", "Id", "Birthdate"\],
            "optionalFields": \["Email"\],
            "sortBy": \["CreatedDate"\],
            "pageSize": 10,
            "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}"
        },
        {
            "relatedListId": "Opportunities",
            "fields": \["Name", "Id"\],
            "optionalFields": \["Email"\],
            "sortBy": \["CreatedDate"\],
            "pageSize": 10,
            "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}"
        }
    \]
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d33414e84">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d33414e87">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d33414e90">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d33414e93">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d33414e96">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d33414e84" data-title="Parameter Name"><samp class="codeph nolang">relatedListId</samp></td>

                  <td class="entry" headers="d33414e87" data-title="Type">String</td>

                  <td class="entry" headers="d33414e90" data-title="Description"><span class="ph" id="relatedListId_param_desc"><a name="relatedListId_param_desc"><!-- --></a>The ID of the related list that you
                      want to get records for.</span></td>

                  <td class="entry" headers="d33414e93" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d33414e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d33414e84" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d33414e87" data-title="Type">String[]</td>

                  <td class="entry" headers="d33414e90" data-title="Description"><span class="ph" id="fields_param_desc"><a name="fields_param_desc"><!-- --></a>Fields queried for the records returned. These
                      fields are included in the response body and don’t create visible columns.
                      If the field isn’t available to the user, an error occurs.</span></td>

                  <td class="entry" headers="d33414e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d33414e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d33414e84" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d33414e87" data-title="Type">String[]</td>

                  <td class="entry" headers="d33414e90" data-title="Description"><span class="ph" id="optionalFields_param_desc"><a name="optionalFields_param_desc"><!-- --></a>Additional fields queried for the
                      records returned. These fields are included in the response body and don’t
                      create visible columns. If the field isn’t available to the user, no error
                      occurs and the field isn’t included in the records.</span></td>

                  <td class="entry" headers="d33414e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d33414e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d33414e84" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d33414e87" data-title="Type">Integer</td>

                  <td class="entry" headers="d33414e90" data-title="Description"><span class="ph" id="pageSize_param_desc"><a name="pageSize_param_desc"><!-- --></a>The number of records from all lists in the
                      request viewed at one time. The default value is 50. Value can be
                      1–1999.</span></td>

                  <td class="entry" headers="d33414e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d33414e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d33414e84" data-title="Parameter Name"><samp class="codeph nolang">sortBy</samp></td>

                  <td class="entry" headers="d33414e87" data-title="Type">String[]</td>

                  <td class="entry" headers="d33414e90" data-title="Description">
                    <span class="ph" id="sortBy_param_desc"><a name="sortBy_param_desc"><!-- --></a>The API names of the fields that the related
                      list is sorted by. If the name is preceded with <samp class="codeph nolang">-</samp>, the sort order is descending. For example, <samp class="codeph nolang">Name</samp> sorts by name in ascending order.
                      <samp class="codeph nolang">-CreatedDate</samp> sorts by created date in
                      descending order.</span>
                    <p class="p">In API version 63.0 and later, you can sort by up
                      to five fields. If a field is invalid or isn’t accessible to the context
                      user, this parameter is ignored, but no error occurs.</p>
                  </td>

                  <td class="entry" headers="d33414e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d33414e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d33414e84" data-title="Parameter Name"><samp class="codeph nolang">where</samp></td>

                  <td class="entry" headers="d33414e87" data-title="Type">String</td>

                  <td class="entry" headers="d33414e90" data-title="Description">The filter applied to returned records, in GraphQL syntax. For example,
                    <samp class="codeph nolang">{ and: [ { StageName: { eq: "Prospecting" } },
                      { Account: { Name: { eq: "Dickenson plc" } } } ] }</samp> filters an
                    Opportunity related list to show only opportunities in the Prospecting stage
                    that are linked to the “Dickenson plc” account.
                  </td>

                  <td class="entry" headers="d33414e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d33414e96" data-title="Available Version">55.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Get a Batch of Related List Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_batch_get.htm "Returns record data for a batch of related lists. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.")

<!-- document id=2805a7ccb7e255efff5001f03c950494c593d6c33f17cb81f21bf2a33a7aa732 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_related_list_record_input.md -->

# Related List Records Input

Get record data for up to 1,999 records in a related list.

JSON example

To get record data for the Contacts related list for the account record 001xx000003GYOpAAO, use the following request.

POST /ui-api/related-list-records/001xx000003GYOpAAO/Contacts

{
 "fields": \["Name", "Id", "Birthdate"\],
 "optionalFields": \["Email"\],
 "sortBy": \["CreatedDate"\],
 "pageSize": 10,
 "where": "{ Account: { AnnualRevenue: { gt: 10000000 } }}"
}

Properties

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d34315e84">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d34315e87">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d34315e90">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d34315e93">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d34315e96">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d34315e84" data-title="Parameter Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d34315e87" data-title="Type">String[]</td>

                  <td class="entry" headers="d34315e90" data-title="Description"><span class="ph" id="fields_param_desc"><a name="fields_param_desc"><!-- --></a>Fields queried for the records returned. These
                      fields are included in the response body and don’t create visible columns.
                      If the field isn’t available to the user, an error occurs.</span></td>

                  <td class="entry" headers="d34315e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d34315e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d34315e84" data-title="Parameter Name"><samp class="codeph nolang">includeColumn​Labels</samp></td>

                  <td class="entry" headers="d34315e87" data-title="Type">Boolean</td>

                  <td class="entry" headers="d34315e90" data-title="Description">Indicates whether to include column labels in the results for
                    localization (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). If unspecified, defaults to <samp class="codeph nolang">false</samp>.</td>

                  <td class="entry" headers="d34315e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d34315e96" data-title="Available Version">65.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d34315e84" data-title="Parameter Name"><samp class="codeph nolang">optionalFields</samp></td>

                  <td class="entry" headers="d34315e87" data-title="Type">String[]</td>

                  <td class="entry" headers="d34315e90" data-title="Description"><span class="ph" id="optionalFields_param_desc"><a name="optionalFields_param_desc"><!-- --></a>Additional fields queried for the
                      records returned. These fields are included in the response body and don’t
                      create visible columns. If the field isn’t available to the user, no error
                      occurs and the field isn’t included in the records.</span></td>

                  <td class="entry" headers="d34315e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d34315e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d34315e84" data-title="Parameter Name"><samp class="codeph nolang">pageSize</samp></td>

                  <td class="entry" headers="d34315e87" data-title="Type">Integer</td>

                  <td class="entry" headers="d34315e90" data-title="Description"><span class="ph" id="pageSize_param_desc"><a name="pageSize_param_desc"><!-- --></a>The number of list records viewed at one
                      time. The default value is 50. Value can be 1–1999.</span></td>

                  <td class="entry" headers="d34315e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d34315e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d34315e84" data-title="Parameter Name"><samp class="codeph nolang">pageToken</samp></td>

                  <td class="entry" headers="d34315e87" data-title="Type">String</td>

                  <td class="entry" headers="d34315e90" data-title="Description"><span class="ph" id="pageToken_param_desc"><a name="pageToken_param_desc"><!-- --></a>The token for additional pages of records
                      beyond the first page. To fetch another page, use the value returned by
                      <samp class="codeph nolang">nextPageToken</samp>from the previous
                      page.</span></td>

                  <td class="entry" headers="d34315e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d34315e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d34315e84" data-title="Parameter Name"><samp class="codeph nolang">sortBy</samp></td>

                  <td class="entry" headers="d34315e87" data-title="Type">String[]</td>

                  <td class="entry" headers="d34315e90" data-title="Description">
                    <span class="ph" id="sortBy_param_desc"><a name="sortBy_param_desc"><!-- --></a>The API names of the fields that the related
                      list is sorted by. If the name is preceded by <samp class="codeph nolang">-</samp>, the sort order is descending. For example, <samp class="codeph nolang">Name</samp> sorts by name in ascending order.
                      <samp class="codeph nolang">-CreatedDate</samp> sorts by created date in
                      descending order.</span>
                    <p class="p">In API version 63.0 and later, you can sort by up
                      to five fields. If a field is invalid or isn’t accessible to the context
                      user, this parameter is ignored, but no error occurs.</p>
                  </td>

                  <td class="entry" headers="d34315e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d34315e96" data-title="Available Version">55.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d34315e84" data-title="Parameter Name"><samp class="codeph nolang">where</samp></td>

                  <td class="entry" headers="d34315e87" data-title="Type">String</td>

                  <td class="entry" headers="d34315e90" data-title="Description">The filter applied to returned records, in GraphQL syntax. For example,
                    <samp class="codeph nolang">{ and: [ { StageName: { eq: "Prospecting" } },
                      { Account: { Name: { eq: "Dickenson plc" } } } ] }</samp> filters an
                    Opportunity related list to show only opportunities in the Prospecting stage
                    that are linked to the “Dickenson plc” account.
                  </td>

                  <td class="entry" headers="d34315e93" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d34315e96" data-title="Available Version">55.0</td>

                </tr>

              </tbody>

            </table>

#### See Also

- [Get Related List Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_get.htm "Returns record data for up to 1,999 records in a related list. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.")

<!-- document id=7c47f7a08728d69bdb22baa09df0ac8fcdc523dc8ad0ba97e5c52605abb4726c url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_related_list_reference.md -->

# Related List Reference

The related list referenced by the collection or metadata.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| id | String | ID of the related list reference. | Small, 50.0 | 50.0 |
| inContextOfRecordId | String | ID of the parent record for the related list. | Small, 50.0 | 50.0 |
| listViewApiName | String | API name of the related list, for example, Contacts. | Small, 50.0 | 50.0 |
| objectApiName | String | API name of the [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") related list object, such as Contact. | Small, 50.0 | 50.0 |
| parentObjectApiName | String | API name for the parent object of the related list. | Small, 50.0 | 50.0 |
| recordTypeId | String | Record type ID for the parent of the related list. | Small, 50.0 | 50.0 |
| relatedListId | String | ID of the related list. | Small, 50.0 | 50.0 |
| type | String | Type of related list. | Small, 50.0 | 50.0 |

#### See Also

- [Related List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm "Metadata that describes a related list.")
- [Related List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_record_collection.htm "A collection of related list records.")
- [Related List Record Count](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_record_count.htm "The number of records in a given related list.")

<!-- document id=88c5f50bc92cfa2400c9639b7cf6cd6ce58882ce1cce7d1ace296f3caab4d6bf url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_related_list_user_preferences.md -->

# Related List User Preferences

User preferences for a related list.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| columnWidths | Map<String, Integer> | Column width preferences for the related list. \-1 indicates default width. | Small, 55.0 | 55.0 |
| columnWrap | Map<String, Boolean> | Indicates whether the column text wraps. | Small, 55.0 | 55.0 |
| orderedBy | [List Order By Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_order_by_info.htm "Ordering information for a list.")\[\] | Ordering information for the related list. | Small, 55.0 | 55.0 |
| preferencesId | String | The related list ID for the user preferences. | Small, 55.0 | 55.0 |

#### See Also

- [Get Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_preferences_get.htm "Returns user preferences for a related list.")
- [Update Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_preferences_patch.htm "Updates user preferences for a related list.")

<!-- document id=6988da7a700300c6fc2469360a10896e4dbe7efb93b3974f02bce2c0486a7075 url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_related_list_user_preferences_input.md -->

# Related List User Preferences Input

User preferences to update for a related list.

JSON example

To update user preferences for a Contact related list on an Account, use this request with a request body.

PATCH /services/data/v68.0/ui-api/related-list-preferences/Account.RelatedContactList

{ 
  "columnWidths" : {
    "Name" : 200
  },
  "columnWrap" : {
     "Name" : false
  },
  "orderedBy" : \[{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }\]
}

Properties

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| columnWidths | Map<String, Integer> | Column width preferences for the related list. \-1 indicates default width. | Small, 55.0 | 55.0 |
| columnWrap | Map<String, Boolean> | Indicates whether the column text wraps. | Small, 55.0 | 55.0 |
| orderedBy | [List Order By Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm "Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.")\[\] | Ordering information for the related list. In API version 63.0 and later, you can sort by up to five fields. | Small, 55.0 | 55.0 |

#### See Also

- [Update Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_preferences_patch.htm "Updates user preferences for a related list.")

<!-- document id=cfdb35a3efa49b2981c6e0a4d84e354bc167d3142a6bd53980c79904e6ea6375 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_report_layout_component.md -->

# Report Layout Component

A report chart component on a record layout page.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | If a field powers this component, this property contains the API name of the field. | Small, 41.0 | 41.0 |
| cacheData | Boolean | Indicates whether to cache data (true) or not (false). | Small, 41.0 | 41.0 |
| componentType | String | The value is ReportChart. | Small, 41.0 | 41.0 |
| error | String | An error message. | Small, 41.0 | 41.0 |
| filter | String | A filter for the report. | Small, 41.0 | 41.0 |
| hideOnError | Boolean | Indicates whether to hide the component when there's an error (true) or not (false). | Small, 41.0 | 41.0 |
| placeholder | String | A placeholder for the report. | Small, 41.0 | 41.0 |
| reportId | String | The component's report ID. | Small, 41.0 | 41.0 |
| showTitle | Boolean | Indicates whether to show the title of the report (true) or not (false). | Small, 41.0 | 41.0 |
| size | String | The size of the component. | Small, 41.0 | 41.0 |

#### See Also

- [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.")

<!-- document id=d95843e400689fb89ba0e206f68b01ed9a126f0152bad72c9521c6e8354d05ef url=/legacydeveloper/current/en-us/uiapi/ui_api_appendices_retired_resources.md -->

# Retired Resources

These User Interface API resources are retired.

- **[Get Lookup Field Suggestions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_get.htm)**  
    When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.
- **[Get Lookup Field Suggestions for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_object_get.htm)**  
    When a user edits a lookup field, use this resource to search for and display suggestions for a specified object. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups.
- **[Get List Views for an Object (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_object.htm)**  
    Get a collection of list views associated with an object.
- **[Get List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_records_md.htm)**  
    Get record data and metadata for a list view.
- **[Get Most Recently Used List View Records (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_mru_list_views_records.htm)**  
    Get record data for an object’s most recently used (MRU) list view.
- **[Get Most Recently Used List View Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_mru_list_views_md.htm)**  
    Get metadata for an object’s most recently viewed (MRU) list view.
- **[Get Most Recently Used List View Records and Metadata (Deprecated)](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_mru_list_views_records_md.htm)**  
    Get record data and metadata for an object’s most recently used (MRU) list view.

<!-- document id=fab11ca684cbf32b7ecd240908b7b93e0d8604078a8524e0a597db10cbc84ae9 url=/legacydeveloper/current/en-us/uiapi/ui_api_appendices_retired_outputs.md -->

# Retired Response Bodies

These User Interface API response bodies are retired.

- **[List UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_ui.htm)**  
    The record data and metadata for a list view.
- **[List View Summary](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_view_summary.htm)**  
    A summary of list views for an object.
- **[List View Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_view_summary_collection.htm)**  
    A collection of list views for a given object.

<!-- document id=63da183b2c06ac7ae625857e605d07ee58a4fb7bb845b1821d84d86554f17381 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_session_csrf.md -->

# Session CSRF Token

Get the Cross-Site Request Forgery (CSRF) token for your session to protect requests from malicious third-party sites forgeries.

Resource

/ui-api/session/csrf

Available version

67.0

HTTP methods

GET

Response body for GET

[CSRF Token](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_csrf_token.htm "Cross-Site Request Forgery (CSRF) token.")

<!-- document id=bbe2abe1317d018ea6e607d57470bc8a041b04cb282506bf96a9ed50d10512f8 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_batch_results_simplified.md -->

# Simplified Batch Results

The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.

| Property | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| results | [Batch Result Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_result.htm#ui_api_responses_batch_result "The results of one subrequest in a batch request.")\[\] | Collection of batch result items | Small, 50.0 | 50.0 |

#### See Also

- [Get a Batch of Related List Record Counts](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_count_batch.htm "Returns the record count for a batch of related lists.")
- [Get a Batch of Related List Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_info_batch.htm "Returns metadata for a batch of related lists in a page layout.")
- [Get a Batch of Related List Records with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_batch.htm "Returns record data for a batch of related lists via URL parameters.")
- [Get a Batch of Related List Records with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_records_batch_get.htm "Returns record data for a batch of related lists. This resource uses the POST method to let you enter request parameters in the request body instead of the URL.")
- [Get a Batch of List View Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views_md_batch.htm "Get metadata for a batch of list views.")
- [Get a Batch of Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_preferences_batch_get.htm "Returns a batch of user preferences for a related list.")
- [Get a Batch of Related List Actions with URL Parameters](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_lists_batch.htm "Get the actions on a batch of related lists for a record via URL parameters.")
- [Get a Batch of Related List Actions with a Request Body](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_related_list_actions_batch_get.htm "Get the actions on a batch of related lists for a record. This resource uses the POST method so you can enter request parameters in the request body instead using complex URL parameters.")

<!-- document id=7eb3f8af768ade60156038aefe0a939c6bb2dae8099107117edb9ba3f9645462 url=/legacydeveloper/current/en-us/uiapi/ui_api_errors.md -->

# Status Codes and Error Responses

The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred.

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


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d8964e39">HTTP Status Code</th>

              <th class="featureTableHeader vertical-align-top " id="d8964e42">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">200</td>

              <td class="entry" headers="d8964e42" data-title="Description">Success with GET, PATCH, or HEAD request</td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">201</td>

              <td class="entry" headers="d8964e42" data-title="Description">Success with POST request</td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">204</td>

              <td class="entry" headers="d8964e42" data-title="Description">Success with DELETE</td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">400</td>

              <td class="entry" headers="d8964e42" data-title="Description">The request could not be understood, usually because the ID is
                not valid for the particular resource. If the request is for a batch
                record operation, see the corresponding usage guidelines.<ul class="ul bulletList">
                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_post.htm" title="Create multiple records. You can create, update, and delete up to 200 records in a single request.">Create a Batch of Records</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_update.htm" title="Update multiple records. You can create, update, and delete up to 200 records in a single request.">Update a Batch of Records</a></li>

                  <li class="li"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_delete.htm" title="Delete multiple records. You can create, update, and delete up to 200 records in a single request.">Delete a Batch of Records</a></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">401</td>

              <td class="entry" headers="d8964e42" data-title="Description">The session ID or OAuth token has expired or is invalid. Or, if
                the request is made by a guest user, the resource isn’t accessible
                to guest users. The response body contains the <samp class="codeph nolang">message</samp> and <samp class="codeph nolang">errorCode</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">403</td>

              <td class="entry" headers="d8964e42" data-title="Description">The request has been refused. Verify that the context user has
                the appropriate permissions to access the requested data, or that
                the context user is not an external user.</td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">404</td>

              <td class="entry" headers="d8964e42" data-title="Description">Either the specified resource was not found, or the resource has
                been deleted. </td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">409</td>

              <td class="entry" headers="d8964e42" data-title="Description">A conflict has occurred. For example, an attempt was made to
                update a request to join a group, but that request had already been
                approved or rejected.</td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">410</td>

              <td class="entry" headers="d8964e42" data-title="Description">The requested resource has been retired or removed. Delete or
                update any references to the resource.</td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">412</td>

              <td class="entry" headers="d8964e42" data-title="Description">A precondition has failed. For example, in a batch request, if
                <samp class="codeph nolang">haltOnError</samp> is <samp class="codeph nolang">true</samp> and a subrequest fails,
                subsequent subrequests return 412.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">500</td>

              <td class="entry" headers="d8964e42" data-title="Description">An error has occurred within Lightning Platform, so the request
                could not be completed. Contact Salesforce Customer Support.</td>

            </tr>

            <tr>
              <td class="entry" headers="d8964e39" data-title="HTTP Status Code">503</td>

              <td class="entry" headers="d8964e42" data-title="Description">Too many requests in an hour or the server is down for
                maintenance. </td>

            </tr>

          </tbody>

        </table>

## Example

This request requires a 15 or 18 character record ID, but this record ID doesn't contain enough characters.

GET /ui-api/record-ui/003R000000

The response body is:

HTTP/1.1 400 Bad Request
Date: Tue, 29 Nov 2016 00:16:36 GMT
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Content-Security-Policy: reflected-xss block;report-uri /\_/ContentDomainCSPNoAuth?type=xss
Content-Security-Policy: referrer origin-when-cross-origin
Set-Cookie: BrowserId=q27CK9tSSCeI3klUaYMo6A;Path=/;Domain=.salesforce.com;Expires=Sat, 28-Jan-2017 00:16:36 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked


\[ {
  "errorCode" : "ILLEGAL\_QUERY\_PARAMETER\_VALUE",
  "message" : "recordId should be a valid record ID: 003R000000"
} \]

<!-- document id=93dc501aac5ed78f1ea6f74c161af62cecee39ea8ba0fbd512002ebb3f7699db url=/legacydeveloper/current/en-us/uiapi/ui_api_get_started_supported_objects.md -->

# Supported Objects

User Interface API supports all custom objects and external objects and many standard objects.

To get a directory of objects that are supported by the API and accessible to the context user, use the [/ui-api/object-info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info_directory.htm#ui_api_resources_object_info_directory "Get a directory of objects that are supported by User Interface API and accessible to the context user. The directory includes a /ui-api/object-info/{objectApiName} resource for each supported object.") resource.

To understand how the API operates on supported objects, let’s look at some examples.

This resource gets object metadata. It operates on any supported object.

GET /ui-api/object-info/{objectApiName}

This example gets Account metadata.

GET /ui-api/object-info/Account

This resource gets record data and metadata. It operates on any supported object record.

GET /ui-api/record-ui/{recordIds}

This example gets data and metadata to display an Opportunity record.

GET /ui-api/record-ui/006RM000002XCd1YAG

Most User Interface API resources support these objects. Related lists resources support every object supported by User Interface API. The list views and most recently used list views resources support smaller sets of objects. For a list of all supported objects, see [All Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_all_supported_objects.htm "User Interface API supports many standard objects as well as all custom and external objects.").

- **[All Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_all_supported_objects.htm)**  
    User Interface API supports many standard objects as well as all custom and external objects.
- **[List View Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_list_view_supported_objects.htm)**  
    List views support a subset of the standard objects that User Interface API supports.
- **[Most Recently Used List View Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_mru_list_view_supported_objects.htm)**  
    Most recently used (MRU) list views support a subset of the standard objects that User Interface API supports.

#### See Also

- [Get a Directory of Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_object_info_directory.htm "Get a directory of objects that are supported by User Interface API and accessible to the context user. The directory includes a /ui-api/object-info/{objectApiName} resource for each supported object.")

<!-- document id=d6e41515897b127a9ee13ad2e852de9639b1bdb189be1893c5400dc6b70b2ef1 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_theme.md -->

# Theme

A set of images and banners that make up a theme. Banners display across the top of a page and have a higher aspect ratio than images.

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





        <thead class="thead sorted" align="left">
          <tr>
            <th class="featureTableHeader vertical-align-top " id="d182043e48">Property</th>

            <th class="featureTableHeader vertical-align-top " id="d182043e51">Type</th>

            <th class="featureTableHeader vertical-align-top " id="d182043e54">Description</th>

            <th class="featureTableHeader vertical-align-top " id="d182043e57">Filter Group and Version</th>

            <th class="featureTableHeader vertical-align-top " id="d182043e60">Available Version</th>

          </tr>

        </thead>

        <tbody class="tbody">
          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">brandColor</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type">String</td>

            <td class="entry" headers="d182043e54" data-title="Description">The brand color of the theme.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">brandImage</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_image.htm#ui_api_responses_theme_image" title="A theme image at three sizes: small, medium, and large. Specific sizes may change slightly, so code accordingly.">Theme Image</a></td>

            <td class="entry" headers="d182043e54" data-title="Description">The brand image of the theme.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">brandImageDark​Mode</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_image.htm#ui_api_responses_theme_image" title="A theme image at three sizes: small, medium, and large. Specific sizes may change slightly, so code accordingly.">Theme Image</a></td>

            <td class="entry" headers="d182043e54" data-title="Description">The dark mode version of the brand image of the theme.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 67.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">67.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">defaultGroupBanner</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_banner.htm#ui_api_responses_theme_banner" title="A theme banner image. Theme banners have a higher aspect ratio than theme images. The banner size may change slightly, so code accordingly.">Theme Banner</a></td>

            <td class="entry" headers="d182043e54" data-title="Description">The default banner for groups. The group banner displays on a group’s home
              page.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">defaultGroupImage</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_image.htm#ui_api_responses_theme_image" title="A theme image at three sizes: small, medium, and large. Specific sizes may change slightly, so code accordingly.">Theme Image</a></td>

            <td class="entry" headers="d182043e54" data-title="Description">The default image for groups. The group image displays beside a group
              name.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">defaultPageBanner</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_banner.htm#ui_api_responses_theme_banner" title="A theme banner image. Theme banners have a higher aspect ratio than theme images. The banner size may change slightly, so code accordingly.">Theme Banner</a></td>

            <td class="entry" headers="d182043e54" data-title="Description">The default banner for pages other than group and user pages.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">defaultUserBanner</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_banner.htm#ui_api_responses_theme_banner" title="A theme banner image. Theme banners have a higher aspect ratio than theme images. The banner size may change slightly, so code accordingly.">Theme Banner</a></td>

            <td class="entry" headers="d182043e54" data-title="Description">The default user banner of the theme. The user banner displays on a user’s home
              page.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">defaultUserImage</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_image.htm#ui_api_responses_theme_image" title="A theme image at three sizes: small, medium, and large. Specific sizes may change slightly, so code accordingly.">Theme Image</a></td>

            <td class="entry" headers="d182043e54" data-title="Description">The default user image of the theme. The user image displays beside a
              username.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">density</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type">String</td>

            <td class="entry" headers="d182043e54" data-title="Description">The display density in the user interface. One of these values:<a name="density"><!-- --></a>
              <ul class="ul bulletList" id="density">
                <li class="li">
                  <samp class="codeph nolang">ViewOne</samp>—User interface elements have
                  a lower density on the page, which means they have more white space between them.
                  In Lightning Experience, this setting is called <strong class="ph b">Comfy</strong>.
                </li>

                <li class="li">
                  <samp class="codeph nolang">ViewTwo</samp>—User interface elements have
                  a higher density on the page, which means they have the least amount of white
                  space between them. In Lightning Experience, this setting is called
                  <strong class="ph b">Compact</strong>.
                </li>

              </ul>
            </td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 44.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">44.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">headerColor</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type">String</td>

            <td class="entry" headers="d182043e54" data-title="Description">The header color of the theme.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">linkColor</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type">String</td>

            <td class="entry" headers="d182043e54" data-title="Description">The link color of the theme.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

          <tr>
            <td class="entry" headers="d182043e48" data-title="Property"><samp class="codeph nolang">pageColor</samp></td>

            <td class="entry" headers="d182043e51" data-title="Type">String</td>

            <td class="entry" headers="d182043e54" data-title="Description">The page color of the theme.</td>

            <td class="entry" headers="d182043e57" data-title="Filter Group and Version">Small, 42.0</td>

            <td class="entry" headers="d182043e60" data-title="Available Version">42.0</td>

          </tr>

        </tbody>

      </table>

#### See Also

- [Get Active Theme](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_themes_active.htm "Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection.")

<!-- document id=c381e6dfba25eb7fe96c78c4ccddf5fc8a5da68e51815835eb1f503ebbf8fd18 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_theme_banner.md -->

# Theme Banner

A theme banner image. Theme banners have a higher aspect ratio than theme images. The banner size may change slightly, so code accordingly.

| Property | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| fullSizeUrl | String | The URL of the banner image. | Small, 42.0 | 42.0 |

#### See Also

- [Theme](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme.htm "A set of images and banners that make up a theme. Banners display across the top of a page and have a higher aspect ratio than images.")

<!-- document id=69c8b06463ab3c60f1a9eefb8c069c413da5052d7ffc375db84583165ce983f9 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_theme_image.md -->

# Theme Image

A theme image at three sizes: small, medium, and large. Specific sizes may change slightly, so code accordingly.

| Property | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| largeUrl | String | The URL of the large image. | Small, 42.0 | 42.0 |
| mediumUrl | String | The URL of the medium image. | Small, 42.0 | 42.0 |
| smallUrl | String | The URL of the small image. | Small, 42.0 | 42.0 |

#### See Also

- [Theme](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme.htm "A set of images and banners that make up a theme. Banners display across the top of a page and have a higher aspect ratio than images.")

<!-- document id=137a0e3bc1a59ae0aa73ab3d0d9d2225ecede0eab8e51a52abaa8eaa17936ecf url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_theme_info.md -->

# Theme Info

Color and icon information for a theme.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| color | String | Color | Small, 41.0 | 41.0 |
| iconUrl | String | Icon URL | Small, 41.0 | 41.0 |

#### See Also

- [Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm "The metadata for an object.")
- [Related List Info Summary](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_summary.htm "A summary of a related list for an object.")

<!-- document id=f83102a19df2de54e37fae8ad61342a615d3d56f0eb2e4c5458008727f56716d url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorites_batch_update.md -->

# Update a Batch of Favorites

Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted.

Resource

/ui-api/favorites/batch

Available Version

41.0

HTTP Method

PUT

Request Body

JSON example

{
  favorites: \[
  {
    id: "0MVR00000004DhnOAE",
    name: "Q4 Perf"
  }, { 
    id: "0MVR00000004DhsOAE"
  }, {
    id: "0MVR00000004DiGOAU"
  }, {
    id: "0MVR000000001e2OAA",
    name: "Office Group"
  }, {
    id: "0MVR00000004GGlOAM"
  }}\]
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| favorites | [Favorite Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_batch_input.htm#ui_api_requests_favorite_batch_input "Represents a single favorite when updating favorites in batch.")\[\] | The list of favorites to keep and update. | Required | 41.0 |

Response Body

[Favorite Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite_collection.htm#ui_api_responses_favorite_collection "A list of favorites.")

<!-- document id=439b373351b680795a34ddba1608b37c9ea7cd7143c2052d0808340a0edd471f url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_records_batch_update.md -->

# Update a Batch of Records

Update multiple records. You can create, update, and delete up to 200 records in a single request.

Resource

/ui-api/records/batch

Available Version

59.0

HTTP Method

POST

Example

This example updates multiple records.

POST /ui-api/records/batch

{
  "allOrNone": false,
  "operations": \[
    {
      "type": "Update",
      "records": \[
        {
          "fields": {
            "Id": "001xx000003Gaf9AAC",
            "NumberOfEmployees": 1000
          }
        },
        {
          "fields": {
            "Id": "001xx000003GanDAAS",
            "NumberOfEmployees": 5000
          }
        },
      \]
    },
  \]
}

Request Body

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| recordInput | [Batch Record Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_input.htm "A description of multiple operations for a request to create, update, or delete a batch of records.") | The batch of record input. | Required | 59.0 |

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d79433e177">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d79433e180">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d79433e183">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d79433e186">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d79433e189">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d79433e177" data-title="Name"><samp class="codeph nolang">useDefaultRule</samp></td>

                  <td class="entry" headers="d79433e180" data-title="Type">Boolean</td>

                  <td class="entry" headers="d79433e183" data-title="Description">
                    <p class="p">For a Case or Lead, specifies whether to use the default (<samp class="codeph nolang">active</samp>) assignment rule. If you specify
                      <samp class="codeph nolang">useDefaultRule</samp>, don’t specify an
                      <samp class="codeph nolang">assignmentRuleId</samp>.
                    </p>

                    <p class="p">For an Account, specifies whether to apply the default territory assignment
                      rules. </p>

                    <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

                    <p class="p">See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_header_assignmentruleheader.htm" target="_blank" title="HTML (New Window)">AssignmentRuleHeader</a> in <em class="ph i">SOAP API Developer Guide</em>.</p>

                  </td>

                  <td class="entry" headers="d79433e186" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d79433e189" data-title="Available Version">64.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results.htm#ui_api_responses_batch_results "The results from a request to a batch resource. Results include information for each subrequest in the batch.")

Usage

When updating a batch of records, you must include the Id field. Don’t include the apiName field in [Batch Operation Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_operation_input.htm "Represents the operation type and record data to create, update, and delete in a batch.").

You can’t perform multiple operations on the same record in one request. An update operation using an Id value that’s used in another update or delete operation can’t be processed. Otherwise, a 400 HTTP status code with an INVALID\_BATCH\_REQUEST error is returned.

Receiving a 400 HTTP status code with an INVALID\_INPUT error can be caused by one of these reasons.

- The operations field is missing or empty.
- The operation type is missing.
- The operations field doesn’t contain a records field or the records field is empty.

#### See Also

- [Create a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_post.htm "Create multiple records. You can create, update, and delete up to 200 records in a single request.")
- [Delete a Batch of Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_batch_delete.htm "Delete multiple records. You can create, update, and delete up to 200 records in a single request.")

<!-- document id=a967a741c79ac702d697b7f989eee41c1cdb94608bc86831bd83b263711e3a72 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorite_update.md -->

# Update a Favorite

Update a favorite.

Resource

/ui-api/favorites/${favoriteId}

favoriteId—The ID of a favorite.

Available Version

41.0

HTTP Method

PATCH

Example

This example uses a request body to update a favorite.

{
  name: "Red Accounts",
  sortOrder: 1
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| name | String | The name of the favorite. | You must specify either name or sortOrder. You may specify both. | 41.0 |
| sortOrder | Integer | The sort order of the favorite, from 1 to N. | You must specify either name or sortOrder. You may specify both. | 41.0 |

Request Body

[Favorite Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_input.htm "A favorite to create or update.")

Response Body

[Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite.htm "A single favorite.")

<!-- document id=e72db5e8b37b898218ace8896f86317f2bc933d41585d156531be7335c131617 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_record_patch.md -->

# Update a Record

Update a record's data.

User Interface API enforces Salesforce validation rules. If a validation rule fails, the response is an [Error with Output](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_error_with_output.htm#ui_api_responses_error_with_output "Contains extra information about errors. In rare cases, an error message isn't enough to describe the reason for a failure. For example, when a conflicting precondition exists, the error result can include the information about the cause of the conflict.").

When you make a PATCH request to update a record, make sure that the record hasn’t changed since the user started editing it. To find out whether it’s safe to save a record, pass the [If-Unmodified-Since](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Unmodified-Since "HTML (New Window)") HTTP header in the request.

As of API version 43.0, if you pass read-only fields in a request body, the response is an [Error with Output](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_error_with_output.htm#ui_api_responses_error_with_output "Contains extra information about errors. In rare cases, an error message isn't enough to describe the reason for a failure. For example, when a conflicting precondition exists, the error result can include the information about the cause of the conflict.").

/ui-api/records/{recordId}

Available Version

41.0

HTTP Method

PATCH

Example

This example passes a request body to update the name of an Account.

PATCH /ui-api/records/001R0000003Gjrt

{
    "fields": {
    "Name": "Universal Containers"
  }
}

To provide an address, provide the individual fields as separate inputs. The compound field is only available in the response.

{
    "fields" : {
    "Name": "Local Boxes",
    "BillingState": "WA",
    "BillingStreet" : "123 Main Street",
    "BillingCountry" : "USA"
  }
}

Request Parameters

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d73538e140">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d73538e143">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d73538e146">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d73538e149">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d73538e152">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d73538e140" data-title="Parameter Name"><samp class="codeph nolang">allowSaveOnDuplicate</samp></td>

                  <td class="entry" headers="d73538e143" data-title="Type">Boolean</td>

                  <td class="entry" headers="d73538e146" data-title="Description">Specifies whether to save a duplicate record. The default value is
                    <samp class="codeph nolang">false</samp>.
                  </td>

                  <td class="entry" headers="d73538e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d73538e152" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73538e140" data-title="Parameter Name"><samp class="codeph nolang">handleOwnerChange</samp></td>

                  <td class="entry" headers="d73538e143" data-title="Type">Boolean</td>

                  <td class="entry" headers="d73538e146" data-title="Description">Specifies whether to return a <samp class="codeph nolang">204 No
                      Content</samp> HTTP status code if the context user loses access to the
                    record during the update. The default value is <samp class="codeph nolang">false</samp>. When <samp class="codeph nolang">false</samp>, if the
                    context user loses access to the record during the update, the update
                    completes successfully, however the resource returns an incorrect <samp class="codeph nolang">404 Not found</samp> HTTP status code.</td>

                  <td class="entry" headers="d73538e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d73538e152" data-title="Available Version">60.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73538e140" data-title="Parameter Name"><samp class="codeph nolang">includeFieldsInBody</samp></td>

                  <td class="entry" headers="d73538e143" data-title="Type">Boolean</td>

                  <td class="entry" headers="d73538e146" data-title="Description">Specifies whether to return a field that’s defined in the request body
                    but not in the layout. The default value is <samp class="codeph nolang">false</samp>. When set to <samp class="codeph nolang">true</samp>,
                    fields that are not in the layout are also included in the response
                    body.</td>

                  <td class="entry" headers="d73538e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d73538e152" data-title="Available Version">59.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73538e140" data-title="Parameter Name">
                    <samp class="codeph nolang">triggerOtherEmail</samp>
                  </td>

                  <td class="entry" headers="d73538e143" data-title="Type">Boolean</td>

                  <td class="entry" headers="d73538e146" data-title="Description">For a Case, specifies whether to send email to users outside the
                    organization. In the Salesforce user interface, this email can be triggered by
                    creating, editing, or deleting a contact for a Case.<p class="p">The default value is
                      <samp class="codeph nolang">false</samp>.
                    </p>
                    <p class="p">See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_header_emailheader.htm" target="_blank" title="HTML (New Window)">EmailHeader</a>
                      in <em class="ph i">SOAP API Developer Guide</em>.</p>
                  </td>

                  <td class="entry" headers="d73538e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d73538e152" data-title="Available Version">51.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73538e140" data-title="Parameter Name"><samp class="codeph nolang">triggerUserEmail</samp></td>

                  <td class="entry" headers="d73538e143" data-title="Type">Boolean</td>

                  <td class="entry" headers="d73538e146" data-title="Description">For a Case or a Lead, specifies whether to send email to users in the
                    organization. In the Salesforce user interface, this email can be triggered by
                    various events: resetting a password, creating a user, changing the Case
                    owner, or adding comments to a Case.<p class="p">For Case owner changes, also set
                      <samp class="codeph nolang">useDefaultRule=true</samp>, or no email is
                      sent.
                    </p>
                    <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>
                    <p class="p">See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_header_emailheader.htm" target="_blank" title="HTML (New Window)">EmailHeader</a>
                      in <em class="ph i">SOAP API Developer Guide</em>.</p>
                  </td>

                  <td class="entry" headers="d73538e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d73538e152" data-title="Available Version">51.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73538e140" data-title="Parameter Name"><samp class="codeph nolang">useDefaultRule</samp></td>

                  <td class="entry" headers="d73538e143" data-title="Type">Boolean</td>

                  <td class="entry" headers="d73538e146" data-title="Description">
                    <p class="p">For a Case or Lead, specifies whether to use the default (<samp class="codeph nolang">active</samp>) assignment rule. If you specify
                      <samp class="codeph nolang">useDefaultRule</samp>, don’t specify an
                      <samp class="codeph nolang">assignmentRuleId</samp>.
                    </p>

                    <p class="p">For an Account, specifies whether to apply the default territory assignment
                      rules. </p>

                    <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

                    <p class="p">See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_header_assignmentruleheader.htm" target="_blank" title="HTML (New Window)">AssignmentRuleHeader</a> in <em class="ph i">SOAP API Developer Guide</em>.</p>

                  </td>

                  <td class="entry" headers="d73538e149" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d73538e152" data-title="Available Version">51.0</td>

                </tr>

              </tbody>

            </table>

Request Body

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d73538e392">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d73538e395">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d73538e398">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d73538e401">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d73538e404">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d73538e392" data-title="Name"><samp class="codeph nolang">allowSaveOnDuplicate</samp></td>

                  <td class="entry" headers="d73538e395" data-title="Type">Boolean</td>

                  <td class="entry" headers="d73538e398" data-title="Description">Specifies whether to save a duplicate record (<samp class="codeph nolang">true</samp>), or not (<samp class="codeph nolang">false</samp>). The
                    default value is <samp class="codeph nolang">false</samp>.<p class="p">Don’t specify
                      this property when checking for duplicate records.</p>
                  </td>

                  <td class="entry" headers="d73538e401" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d73538e404" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73538e392" data-title="Name"><samp class="codeph nolang">apiName</samp></td>

                  <td class="entry" headers="d73538e395" data-title="Type">String</td>

                  <td class="entry" headers="d73538e398" data-title="Description">To create a record, specify the API name of an Object from which to
                    create the record. To update a record, use <samp class="codeph nolang">null</samp> or don’t pass this property. To check for duplicate records,
                    specify the API name of the object for which you’re performing the duplicate
                    check.</td>

                  <td class="entry" headers="d73538e401" data-title="Required or Optional">Required to create a record.<p class="p">Required to check for duplicate
                      records.</p>
                  </td>

                  <td class="entry" headers="d73538e404" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d73538e392" data-title="Name"><samp class="codeph nolang">fields</samp></td>

                  <td class="entry" headers="d73538e395" data-title="Type">Map&lt;String, Object&gt;</td>

                  <td class="entry" headers="d73538e398" data-title="Description">Map of field names to field values.<p class="p">Format data types according to
                      these rules: </p>
                    <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Address</samp>—JSON String.
                        Addresses are compound fields and must be broken up into their constituent
                        fields. See the previous example.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Boolean</samp>—JSON Boolean,
                        <samp class="codeph nolang">true</samp> or <samp class="codeph nolang">false</samp>
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Currency</samp>—JSON Number (for
                        example, <samp class="codeph nolang">67.54</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Date</samp>—JSON string (for
                        example, <samp class="codeph nolang">2020-04-20</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">DateTime</samp>—JSON string in ISO
                        8601 format (for example, <samp class="codeph nolang">2012-02-18T06:40:41.000Z</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Double</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Email</samp>—JSON String (for
                        example, <samp class="codeph nolang">joe@smith.com</samp>)
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">EncryptedString</samp>—JSON
                        String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Int</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Location</samp>—JSON String.
                        Location fields are compound fields and must be broken up into their
                        constituent fields.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">MultiPicklist</samp>—JSON String
                        (for example, <samp class="codeph nolang">Dog;Cat;Fish)</samp>.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Percent</samp>—JSON Number
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Phone</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Picklist</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Reference</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">String</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">TextArea</samp>—JSON String
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Time</samp>—JSON String in format
                        <samp class="codeph nolang">HH:MM:SS</samp>
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Url</samp>—JSON String
                      </li>

                    </ul>
                    <p class="p">To specify the main record type, either don’t specify the <samp class="codeph nolang">RecordTypeId</samp> field, or set it to <samp class="codeph nolang">null</samp>.</p>
                  </td>

                  <td class="entry" headers="d73538e401" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d73538e404" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Response Body

[Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm#ui_api_responses_record "The field data, API name, child relationship data, and record type information for a record.")

#### See Also

- [Upload Binary Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_binary_upload.htm "If a record has a Base64 field, you can upload binary data to the field when you create or update a record.")

<!-- document id=50c5c9bd7d8e797126bbdb7b2a40d341973f18e10abd40b0a8dd30ab27593a13 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_update_action.md -->

# Update a Record with a Quick Action

Perform an Update a Record quick action. To perform a quick action that creates or updates a record, you can also use the POST method.

Resource

/ui-api/actions/perform-quick-action/${actionApiName}

actionApiName—The API name of a quick action.

Available Version

58.0

HTTP Method

PATCH

Example

This example updates fields on an Account.

PATCH /services/data/v68.0/ui-api/actions/perform-quick-action/Account.UpdateAccount

{
 "apiName": "Account",
 "contextId": "001RO000003zKsYYAU",  
 "fields": {
   "Type": "Prospect",
   "Phone": "(785) 241-6200"
 }
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| performQuickActionInput | [Perform Action Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_perform_action_input.htm "Perform a quick action that creates or updates a record.") | The data for the quick action. | Required | 58.0 |

Response Body

[Quick Action Execution](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_perform_action.htm "The results that are returned when a quick action executes.")

#### See Also

- [Perform Quick Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_perform_action.htm "Perform a quick action that creates or updates a record.")

<!-- document id=b3826feb96cbd9da87a40a9846b9e3f24e6032c405bda1a61e37fe82b7389d58 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_apps_id_update.md -->

# Update Last Selected App

Returns metadata for an app, and saves an app as the last selected for a user.

Resource

/ui-api/apps/${appId}

Available Version

43.0

HTTP Method

PATCH

Example

As an example, let’s say that the user has an app with an ID of 06mRM000000AFIrYAO. To get metadata for this app, make this request:

PATCH /services/data/v68.0/ui-api/apps/06mRM000000AFIrYAO?formFactor=Large

The PATCH request doesn’t require a request body. The request returns metadata for the app and its associated navigation tabs. It also updates the last selected app to be this app.

Request parameters for PATCH

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





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d39821e114">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d39821e117">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d39821e120">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d39821e123">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d39821e126">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d39821e114" data-title="Parameter Name"><samp class="codeph nolang">formFactor</samp></td>

                  <td class="entry" headers="d39821e117" data-title="Type">String</td>

                  <td class="entry" headers="d39821e120" data-title="Description">The form factor for each app that the user has access to.<a name="form_factor_values_ul"><!-- --></a>
                    <ul class="ul bulletList" id="form_factor_values_ul">
                      <li class="li">
                        <samp class="codeph nolang">Large</samp>—App supports the
                        desktop display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Medium</samp>—App supports the
                        tablet display size.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Small</samp>—App supports the phone
                        display size.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d39821e123" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d39821e126" data-title="Available Version">43.0</td>

                </tr>

              </tbody>

            </table>

Response body for PATCH

[App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_app.htm "The metadata for a single app.")

<!-- document id=dc1ed5b63d2e11abb75a551e7b3ae35c3e086daf4021ae59f036c024a3b28e17 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_views_md_patch.md -->

# Update List View Metadata

Update list view metadata.

Resource

/ui-api/list-info/${objectApiName}/${listViewApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- listViewApiName—The API name of a list view, such as AllAccounts.

Available Version

61.0

HTTP Method

PATCH

Example

This example uses a request body to update the metadata for a list view. The object API name is Account and the list view API name is AllAccounts.

PATCH /services/data/v68.0/ui-api/list-info/Account/AllAccounts

{
"filteredByInfo": \[
  {
  "fieldApiName": "Name",
  "operandLabels": \[ "This", "That"\],
  "operator": "Equals"
  },
  {
  "fieldApiName": "Phone",
  "operandLabels": \[ "919"\],
  "operator": "StartsWith"
  },
{
  "fieldApiName": "AnnualRevenue",
  "operandLabels": \[ "1000000"\],
  "operator": "GreaterThan"
  }
\],
"filterLogicString" : "(1 OR 2) AND 3",
"label": "Accounts opened this year",
"scope": {
  "apiName": "entity",
  "entityId": "00Gxx000000sjI8",
  "relatedEntityId": "701xx000003HZ7X"
},
"visibility": "Public"
}

Request parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| listInfoInput | [List Info Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_info_input.htm "Info to update a list.") | The list info to update. | Required | 61.0 |

Response Body

[List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm "Metadata that describes a list.")

<!-- document id=bce4ee97c3c0e252d0edd15a93cdb3fa2764cfa36623ee7f688a3e4fca5e0613 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_list_preferences_update.md -->

# Update List View Preferences

Update list view preferences.

Resource

/ui-api/list-preferences/${objectApiName}/${listViewApiName}

- objectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- listViewApiName—The API name of a list view, such as AllAccounts.

Available version

61.0

HTTP methods

PATCH

Example

This example updates list preferences for the All Accounts list view.

PATCH /services/data/v68.0/ui-api/list-preferences/Account/AllAccounts

{
"columnWidths" : {
  "Name" : 200
  },
"columnWrap" : {
  "Name" : false
  },
"orderedBy" : \[{
  "fieldApiName": "Name",
  "isAscending" : true
  }\]
}

Request parameters for PATCH

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| listPreferencesInput | [List Preferences Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_preferences_input.htm "List preferences to update.") | List preferences to update. | Required | 61.0 |

Response body for PATCH

[List Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_preferences.htm "List preferences.")

<!-- document id=d6c533f10c7a7f494571e27c76fc2f222cab6e04ea6169ed45c55dd548498d3e url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_apps_update_nav_items.md -->

# Update Personalized Navigation Items

Updates the order of a user’s personalized navigation items (tabs) and adds a navigation item to the list in the order specified.

Resource

/ui-api/apps/{appId}/user-nav-items

Available Version

47.0

HTTP Method

PUT

Example

To update the order that navigation items display in an app and add an item to the list, make this request using the app’s ID.

PUT /services/data/v68.0/ui-api/apps/06mRM000000U6pOYAS/user-nav-items

The request body contains the list of navigation items in the order they should appear. To add a navigation item, include a pageReference describing the item.

{
  "navItems": \[{
    "id": "0QkRM00000058lN0AQ"
  }, {
    "id": "0QkRM00000058lR0AQ",
    "label": "My Top Account"
  }, {
    "pageReference": {
      "type": "standard\_\_objectPage",
      "attributes": {
        "objectApiName": "Dashboard",
        "actionName": "home"
      },
      "state": {}
    }
  }\]
}

The request returns metadata for the navigation items associated with this app.

{
  "currentPageUrl": "/services/data/v68.0/ui-api/apps/06mRM000000U6pOYAS/user-nav-items?formFactor=large",
  "navItems": \[{
    "availableInClassic": true,
    "availableInLightning": true,
    "color": "2ECBBE",
    "content": "https://yourinstance.salesforce.com/00O/o",
    "custom": false,
    "developerName": "standard-report",
    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/report\_120.png",
    "id": "0QkRM00000058lN0AQ",
    "itemType": "Entity",
    "label": "Cars",
    "objectApiName": "Car\_\_c",
    "objectLabel": "Car",
    "objectLabelPlural": "Cars",
    "pageReference": {
      "attributes": {
        "objectApiName": "Car\_\_c",
        "actionName": "home"
      },
      "state": {},
      "type": "standard\_\_objectPage"
    },
    "standardType": null
  }, {
    "availableInClassic": false,
    "availableInLightning": true,
    "color": "7F8DE1",
    "content": "001RM000004QlpqYAC",
    "custom": true,
    "developerName": null,
    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/account\_120.png",
    "id": "0QkRM00000058lR0AQ",
    "itemType": "Record",
    "label": "My Top Account",
    "objectApiName": "Account",
    "objectLabel": "Account",
    "objectLabelPlural": "Accounts",
    "pageReference": {
      "attributes": {
        "recordId": "001RM000004QlpqYAC",
        "objectApiName": "Account",
        "actionName": "view"
      },
      "state": {},
      "type": "standard\_\_recordPage"
    },
    "standardType": null
  }, {
    "availableInClassic": true,
    "availableInLightning": true,
    "color": "EF6E64",
    "content": "https://yourinstance.salesforce.com/01Z/o",
    "custom": false,
    "developerName": "standard-Dashboard",
    "iconUrl": "https://yourinstance.salesforce.com/img/icon/t4v35/standard/dashboard\_120.png",
    "id": "0QkRM00000058ll0AA",
    "itemType": "Standard",
    "label": "Dashboards",
    "objectApiName": "Dashboard",
    "objectLabel": "Dashboard",
    "objectLabelPlural": "Dashboards",
    "pageReference": {
      "attributes": {
        "objectApiName": "Dashboard",
        "actionName": "home"
      },
      "state": {},
      "type": "standard\_\_objectPage"
    },
    "standardType": "Dashboards"
  }\],
  "nextPageUrl": null
}

Request Body

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| navItems | [Navigation Item Collection Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_navigation_item_collection_input.htm "A collection of all the navigation items (tabs) for an app. Pass this request body to get or update a user’s personalized navigation items.") | A list of navigation items (tabs) in the updated order they should appear. The updated order persists across desktop and mobile environments. | Required | 47.0 |

Response Body

[Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_items.htm "An ordered list of navigation items (tabs) for the current user.")

<!-- document id=415f3f315672f4ef6ba3cdc756ab0ae4f9b5a9692d02f78dbfc304596f7df137 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_info_md_patch.md -->

# Update Related List Metadata

Update metadata for a related list in a page layout.

Resource

/ui-api/related-list-info/${parentObjectApiName}/${relatedListId}

- parentObjectApiName—A [supported](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.") object, such as Account.
- relatedListId—The ID of a supported related list for that object, such as Contracts.

Available Version

50.0

HTTP Method

PATCH

Example

This example uses a request body to update the metadata for the Contracts related list for the Account object:

PATCH /services/data/v68.0/ui-api/related-list-info/Account/Contracts

{ 
  "orderedByInfo" : \[{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }\],
  "userPreferences" : {
    "columnWidths" : {
        "Name" : -1
    },
    "columnWrap" : {
        "Name" : false
    }
  }
}

Request Body

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| recordTypeId | Id | The ID of the record type (RecordType object) for the record. If not provided, the default record type is used. | Optional | 50.0 |
| relatedList​InfoInput | [Related List Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_input.htm "A related list to update.") | The updated related list metadata. | Required | 50.0 |

Response Body

[Related List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm "Metadata that describes a related list.")

<!-- document id=29d5178fbc1afaad1b7b15d7cb3ca2fc1fa85ce9c3cc510089e478dc1eb77fff url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_related_list_preferences_patch.md -->

# Update Related List User Preferences

Updates user preferences for a related list.

Resource

/ui-api/related-list-preferences/${preferencesId}

- preferencesId—The ID of user preferences for a related list, for example, Account.RelatedContactList.

Available Version

57.0

HTTP Method

PATCH

Example

To update user preferences for a Contact related list on an Account, use this request with a request body.

PATCH /services/data/v68.0/ui-api/related-list-preferences/Account.RelatedContactList

{ 
  "columnWidths" : {
    "Name" : 200
  },
  "columnWrap" : {
     "Name" : false
  },
  "orderedBy" : \[{ 
    "fieldApiName": "Name",
    "isAscending" : true
  }\]
}

Request Parameters

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| relatedListUser​PreferencesInput | [Related List User Preferences Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_user_preferences_input.htm "User preferences to update for a related list.") | The related list user preferences to update. | Required | 57.0 |

Response Body

[Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_user_preferences.htm "User preferences for a related list.")

<!-- document id=856e6f029ba5de8d932e7fb8c58ddbc5d709a85624d633e2c6d4ea179047d4db url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorites_usage_update.md -->

# Update Usage of a Favorite

Update the usage of an individual favorite. Increments the accessCount and sets the lastAccessDate to the current system time.

Resource

/ui-api/favorites/${favoriteId}/usage

favoriteId—The ID of a favorite.

Available Version

41.0

HTTP Method

PATCH

Response Body

[Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite.htm#ui_api_responses_favorite "A single favorite.")

<!-- document id=b249b03be92fae3de3316ea1e0473ef96d973923811892454667484e86606877 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_records_contentversion.md -->

# Upload a File

Upload a file such as a document or image.

Resource

/ui-api/records/content-documents/content-versions

Available Version

56.0

HTTP Method

POST

To upload a file or a new file version, provide the binary file in a multipart/form-data body part where name="fileData". See [Upload Binary Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_binary_upload.htm "If a record has a Base64 field, you can upload binary data to the field when you create or update a record.") and [Upload Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm "Upload documents and images or update the file with a new version.").

Request Parameters for POST

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| description | String | A description of the document or image to be uploaded. | Optional | 56.0 |
| title | String | The title of the document or image to be uploaded. | Optional | 56.0 |

Request Body for POST

Example for Uploading a File

POST /ui-api/records/content-documents/content-versions

{
  "description": "A description of the product",
  "title": "product\_image"
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| description | String | A description of the document or image to be uploaded. | Optional | 56.0 |
| title | String | The title of the document or image to be uploaded. | Optional | 56.0 |

Response Body

[Content Document Composite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_contentdocumentcomposite.htm "The file and its relationship to a record.")

<!-- document id=580bd00b467a8658e2ee63a1dd18194d515cf84552ce8448e51d8762187c823c url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_records_contentdocument.md -->

# Upload a New File Version

Upload a new document or image version.

Resource

/ui-api/records/content-documents/${contentDocumentId}/content-versions

contentDocumentId—The ID of a previously uploaded file.

Available Version

56.0

HTTP Method

POST

To upload a file or a new file version, provide the binary file in a multipart/form-data body part where name="fileData". See [Upload Binary Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_binary_upload.htm "If a record has a Base64 field, you can upload binary data to the field when you create or update a record.") and [Upload Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm "Upload documents and images or update the file with a new version.").

Request Parameters for POST

| Parameter Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| description | String | A description of the document or image to be uploaded. | Optional | 56.0 |
| title | String | The title of the document or image to be uploaded. | Optional | 56.0 |

Request body for POST

Example for Uploading a New Version of a File

POST /ui-api/records/content-documents/0692L00000BDVevQAH/content-versions

{
  "description": "Version 2 of the product image",
  "title": "product\_image"
}

Properties

| Name | Type | Description | Required or Optional | Available Version |
| --- | --- | --- | --- | --- |
| description | String | A description of the document or image to be uploaded. | Optional | 56.0 |
| title | String | The title of the document or image to be uploaded. | Optional | 56.0 |

Response Body

[Content Document Composite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_contentdocumentcomposite.htm "The file and its relationship to a record.")

<!-- document id=40a670410750b95004fc1766415026b9be347950bd66b990f67a6c00fff9f97d url=/legacydeveloper/current/en-us/uiapi/ui_api_features_records_binary_upload.md -->

# Upload Binary Files

If a record has a Base64 field, you can upload binary data to the field when you create or update a record.

The field determines the binary data file size limit. For example, the ContentNote.Content field has a different limit than the Attachment.Body field. For information about fields, see [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm "HTML (New Window)") in _Object Reference for Salesforce and Lightning Platform_.

There are two ways to upload a binary file in request.

- [Upload Binary Files in a Multipart/Form-Data Request](#multipart)
- [Upload Binary Files in a JSON Request Body](#json)

## Upload Binary Files in a Multipart/Form-Data Request

To upload a binary file, create a multipart request with a part that contains the JSON request body required by the resource, and a part for each file you want to upload. Each file must have its own part. To upload binary data to multiple fields, add a part for each field. The part names must match the field names.

Let’s [create](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_create.htm#ui_api_resources_records_create "Create or clone a record.") a ContentNote record and upload a binary file to its [Content](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentnote.htm "HTML (New Window)") field, which is the content or body of the note.

This [curl](https://curl.haxx.se/ "HTML (New Window)") example performs a multi-part request that contains the JSON request body and the binary file.

curl -v -H 'Authorization: Bearer 00Dxx0000001gER!ARoAQFFeB\_55d8B3Sh....' 
  -F 'json={"apiName": "ContentNote","fields": {"Title": "My List of Things"}};type=application/json' 
  -F 'Content=@note.txt;type=application/octet-stream' 
  -X POST 'http://{instance-name}.salesforce.com/services/data/v68.0/ui-api/records'

The first part, starting with \-F, contains the JSON request body that the /ui-api/records resource requires. The request body contains the API name of the record (ContentNote) and the title of the record (My List of Things). The part name must be json.

The second part, starting with the second \-F, contains the binary file. The part name must match the name of the Base64 field to which the data is uploaded. The ContentNote Base64 field name is Content, and the plain text file we’re uploading is note.txt.

## Upload Binary Files in a JSON Request Body

The JSON format doesn’t support binary data. To upload a binary file in a JSON payload, encode the file using [Base64](https://en.wikipedia.org/wiki/Base64) encoding.

In this sample Record Input JSON request body, the Content property contains the file as a Base64 encoded string.

{ 
"apiName": "ContentNote", 
"fields": { 
  "Content": "SGksIFRoaXMgaXMgYmFzZTY0",
  "Title": "Sample Title" 
  } 
}

This curl example creates a ContentNote record and uploads the file.

curl -X POST -H 'Authorization: Bearer 00Dxx0000001gER!ARoAQFFeB\_55d8B3Sh...' 
  -H 'Content-Type: application/json' -H "Content-type: application/json" 
  -d '{"apiName": "ContentNote","fields": {"Content": "SGksIFRoaXMgaXMgYmFzZTY0","Title": "Sample Title"} }' 
  'http://{instance-name}.salesforce.com/services/data/v68.0/ui-api/records'

#### See Also

- [Create or Clone a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_create.htm "Create or clone a record.")
- [Update a Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_patch.htm "Update a record's data.")

<!-- document id=49701d2099a3663735584af4533f8140cf5e6c0903b5527b95845de8d6c32393 url=/legacydeveloper/current/en-us/uiapi/ui_api_features_records_content_document.md -->

# Upload Files

Upload documents and images or update the file with a new version.

Salesforce stores files uploaded to a record or group as a ContentDocument. Each file has a ContentVersion record that corresponds to a specific version of the file. Additionally, ContentDocumentLink holds the polymorphic relationships between a file and where it's shared, such as a users, groups, and records. For information about working with files, see [ContentDocument](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm "HTML (New Window)") in _Object Reference for Salesforce and Lightning Platform_.

User Interface API provides two ways to upload a file in a request.

- [Upload a New File](#upload-file)
- [Upload a File Version](#upload-version)

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

#### Note

To prevent duplication of file uploads, such as in situations where the network connection is unstable, use [Idempotency Record Writes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_idempotent.htm "Use idempotent record writes to avoid duplication of records and server operations, which can occur when an app or client encounters a network connection issue.").

## Upload a New File

This request uploads an image with the .csv file extension. It creates a new ContentDocument, ContentVersion, and ContentDocumentLink in one request. After the file is uploaded, you can view it in [Files home](https://help.salesforce.com/s/articleView?id=experience.collab_files_using.htm&type=5&language=en_US).

Example POST Request

POST /ui-api/records/content-documents/content-versions

{
  "description": "My test file",
  "title": "CSV File"
}

Example CURL Request

curl -H "X-PrettyPrint: 1"
-F 'json={"title":"CSV File", "description":"My test file"};type=application/json'
-F 'fileData=@aa.csv;type=application/octet-stream'
-X POST https://{instance-name}.salesforce.com/services/data/v57.0/ui-api/records/content-documents/content-versions
-H 'Authorization: Bearer your\_access\_token\_here' 

Example Response

{
  "contentDocument" : {
    "apiName" : "ContentDocument",
    "childRelationships" : { },
    "eTag" : "32e236323d9e6feea5412bb694a9b33d",
    "fields" : {
      "CreatedDate" : {
        "displayValue" : "11/2/2022, 11:13 AM",
        "value" : "2022-11-02T18:13:53.000Z"
      },
      "Description" : {
        "displayValue" : null,
        "value" : "My test file"
      },
      "Id" : {
        "displayValue" : null,
        "value" : "069RM0000008MbJYAU"
      },
      "LastModifiedById" : {
        "displayValue" : null,
        "value" : "005RM000002dpIzYAI"
      },
      "LastModifiedDate" : {
        "displayValue" : "11/2/2022, 11:13 AM",
        "value" : "2022-11-02T18:13:53.000Z"
      },
      "SystemModstamp" : {
        "displayValue" : null,
        "value" : "2022-11-02T18:13:54.000Z"
      },
      "Title" : {
        "displayValue" : null,
        "value" : "CSV File"
      }
    },
    "id" : "069RM0000008MbJYAU",
    "lastModifiedById" : "005RM000002dpIzYAI",
    "lastModifiedDate" : "2022-11-02T18:13:53.000Z",
    "recordTypeId" : null,
    "recordTypeInfo" : null,
    "systemModstamp" : "2022-11-02T18:13:54.000Z",
    "weakEtag" : 1667412834000
  },
  "contentDocumentLinks" : \[ {
    "apiName" : "ContentDocumentLink",
    "childRelationships" : { },
    "eTag" : "a9e9ca5f7e2eb85af2aef5ed122350c2",
    "fields" : {
      "ContentDocumentId" : {
        "displayValue" : null,
        "value" : "069RM0000008MbJYAU"
      },
      "Id" : {
        "displayValue" : null,
        "value" : "06ARM00000095a72AA"
      },
      "LinkedEntityId" : {
        "displayValue" : null,
        "value" : "005RM000002dpIzYAI"
      },
      "ShareType" : {
        "displayValue" : "Inferred",
        "value" : "I"
      },
      "SystemModstamp" : {
        "displayValue" : null,
        "value" : "2022-11-02T18:13:54.000Z"
      }
    },
    "id" : "06ARM00000095a72AA",
    "lastModifiedById" : null,
    "lastModifiedDate" : null,
    "recordTypeId" : null,
    "recordTypeInfo" : null,
    "systemModstamp" : "2022-11-02T18:13:54.000Z",
    "weakEtag" : 1667412834000
  } \],
  "contentVersion" : {
    "apiName" : "ContentVersion",
    "childRelationships" : { },
    "eTag" : "0cbf5c6af463dbda0d0741eeda132d7a",
    "fields" : {
      "ContentSize" : {
        "displayValue" : null,
        "value" : "26224"
      },
      "CreatedDate" : {
        "displayValue" : "11/2/2022, 11:13 AM",
        "value" : "2022-11-02T18:13:53.000Z"
      },
      "Description" : {
        "displayValue" : null,
        "value" : "My test file"
      },
      "Id" : {
        "displayValue" : null,
        "value" : "068RM0000008SBhYAM"
      },
      "LastModifiedById" : {
        "displayValue" : null,
        "value" : "005RM000002dpIzYAI"
      },
      "LastModifiedDate" : {
        "displayValue" : "11/2/2022, 11:13 AM",
        "value" : "2022-11-02T18:13:53.000Z"
      },
      "SystemModstamp" : {
        "displayValue" : null,
        "value" : "2022-11-02T18:13:54.000Z"
      },
      "Title" : {
        "displayValue" : null,
        "value" : "CSV File"
      },
      "VersionDataUrl" : {
        "displayValue" : null,
        "value" : "https://{instance-name}.documentforce.com/sfc/servlet.shepherd/version/download/068RM0000008SBh"
      }
    },
    "id" : "068RM0000008SBhYAM",
    "lastModifiedById" : "005RM000002dpIzYAI",
    "lastModifiedDate" : "2022-11-02T18:13:53.000Z",
    "recordTypeId" : "012000000000000AAA",
    "recordTypeInfo" : null,
    "systemModstamp" : "2022-11-02T18:13:54.000Z",
    "weakEtag" : 1667412834000
  }

## Upload a File Version

This request uploads a new version of an image file with a new file name. It creates a new ContentVersion, and updates the existing objects to reference the new ContentVersion.

Example POST Request

POST /ui-api/records/content-documents/069RM0000008MbEYAU/content-versions

{
  "title": "Updated product image"
}

Example CURL Request

curl -H "X-PrettyPrint: 1" 
-F 'json={"title":"Updated product image"};type=application/json' 
-F 'fileData=@Test.PNG;type=application/octet-stream' 
-X POST 'https://{instance-name}.salesforce.com/services/data/v57.0/ui-api/records/content-documents/069RM0000008MbEYAU/content-versions' 
-H 'Authorization: Bearer your\_access\_token\_here'

Example Response

{
  "contentDocument" : {
    "apiName" : "ContentDocument",
    "childRelationships" : { },
    "eTag" : "8a5ed89e115ff7f99e4d00e6ec07c0f3",
    "fields" : {
      "CreatedDate" : {
        "displayValue" : "11/2/2022, 10:19 AM",
        "value" : "2022-11-02T17:19:28.000Z"
      },
      "Description" : {
        "displayValue" : null,
        "value" : null
      },
      "Id" : {
        "displayValue" : null,
        "value" : "069RM0000008MbEYAU"
      },
      "LastModifiedById" : {
        "displayValue" : null,
        "value" : "005RM000002dpIzYAI"
      },
      "LastModifiedDate" : {
        "displayValue" : "11/2/2022, 10:53 AM",
        "value" : "2022-11-02T17:53:59.000Z"
      },
      "SystemModstamp" : {
        "displayValue" : null,
        "value" : "2022-11-02T17:54:00.000Z"
      },
      "Title" : {
        "displayValue" : null,
        "value" : "Updated product image"
      }
    },
    "id" : "069RM0000008MbEYAU",
    "lastModifiedById" : "005RM000002dpIzYAI",
    "lastModifiedDate" : "2022-11-02T17:53:59.000Z",
    "recordTypeId" : null,
    "recordTypeInfo" : null,
    "systemModstamp" : "2022-11-02T17:54:00.000Z",
    "weakEtag" : 1667411640000
  },
  "contentDocumentLinks" : \[ {
    "apiName" : "ContentDocumentLink",
    "childRelationships" : { },
    "eTag" : "0e32a473e9bd0bb69eb23fb1c0d8115c",
    "fields" : {
      "ContentDocumentId" : {
        "displayValue" : null,
        "value" : "069RM0000008MbEYAU"
      },
      "Id" : {
        "displayValue" : null,
        "value" : "06ARM00000095a32AA"
      },
      "LinkedEntityId" : {
        "displayValue" : null,
        "value" : "001RM000005XNLIYA4"
      },
      "ShareType" : {
        "displayValue" : "Inferred",
        "value" : "I"
      },
      "SystemModstamp" : {
        "displayValue" : null,
        "value" : "2022-11-02T17:19:31.000Z"
      }
    },
    "id" : "06ARM00000095a32AA",
    "lastModifiedById" : null,
    "lastModifiedDate" : null,
    "recordTypeId" : null,
    "recordTypeInfo" : null,
    "systemModstamp" : "2022-11-02T17:19:31.000Z",
    "weakEtag" : 1667409571000
  }, {
    "apiName" : "ContentDocumentLink",
    "childRelationships" : { },
    "eTag" : "ccfa6db5bfad0c23d0aa613b69fbaec5",
    "fields" : {
      "ContentDocumentId" : {
        "displayValue" : null,
        "value" : "069RM0000008MbEYAU"
      },
      "Id" : {
        "displayValue" : null,
        "value" : "06ARM00000095a22AA"
      },
      "LinkedEntityId" : {
        "displayValue" : null,
        "value" : "005RM000002dpIzYAI"
      },
      "ShareType" : {
        "displayValue" : "Inferred",
        "value" : "I"
      },
      "SystemModstamp" : {
        "displayValue" : null,
        "value" : "2022-11-02T17:19:32.000Z"
      }
    },
    "id" : "06ARM00000095a22AA",
    "lastModifiedById" : null,
    "lastModifiedDate" : null,
    "recordTypeId" : null,
    "recordTypeInfo" : null,
    "systemModstamp" : "2022-11-02T17:19:32.000Z",
    "weakEtag" : 1667409572000
  } \],
  "contentVersion" : {
    "apiName" : "ContentVersion",
    "childRelationships" : { },
    "eTag" : "7b64a64ff99e3141f6fdbf7a5278d424",
    "fields" : {
      "ContentSize" : {
        "displayValue" : null,
        "value" : "324337"
      },
      "CreatedDate" : {
        "displayValue" : "11/2/2022, 10:53 AM",
        "value" : "2022-11-02T17:53:59.000Z"
      },
      "Description" : {
        "displayValue" : null,
        "value" : null
      },
      "Id" : {
        "displayValue" : null,
        "value" : "068RM000000228mYAA"
      },
      "LastModifiedById" : {
        "displayValue" : null,
        "value" : "005RM000002dpIzYAI"
      },
      "LastModifiedDate" : {
        "displayValue" : "11/2/2022, 10:53 AM",
        "value" : "2022-11-02T17:53:59.000Z"
      },
      "SystemModstamp" : {
        "displayValue" : null,
        "value" : "2022-11-02T17:54:01.000Z"
      },
      "Title" : {
        "displayValue" : null,
        "value" : "Updated product image"
      },
      "VersionDataUrl" : {
        "displayValue" : null,
        "value" : "https://{instance-name}.documentforce.com/sfc/servlet.shepherd/version/download/068RM000000228m"
      }
    },
    "id" : "068RM000000228mYAA",
    "lastModifiedById" : "005RM000002dpIzYAI",
    "lastModifiedDate" : "2022-11-02T17:53:59.000Z",
    "recordTypeId" : "012000000000000AAA",
    "recordTypeInfo" : null,
    "systemModstamp" : "2022-11-02T17:54:01.000Z",
    "weakEtag" : 1667411641000
  }
}

#### See Also

- [Upload a New File Version](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_contentdocument.htm "Upload a new document or image version.")
- [Upload a File](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_records_contentversion.htm "Upload a file such as a document or image.")

<!-- document id=34737861fb9bbc7195327246c7a6b26ce4fe2c90be239e33fe33098df6873d56 url=/legacydeveloper/current/en-us/uiapi/ui_api_appendices.md -->

# User Interface API Appendices

User Interface API supports all custom objects and external objects and many standard objects. Use these appendices to find more information on supported objects. You can also find retired resources, request bodies, and response bodies here.

- **[Supported Objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm)**  
    User Interface API supports all custom objects and external objects and many standard objects.
- **[Retired Resources](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_appendices_retired_resources.htm)**  
    These User Interface API resources are retired.
- **[Retired Response Bodies](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_appendices_retired_outputs.htm)**  
    These User Interface API response bodies are retired.

<!-- document id=f0e816e87e80edd6b0b484966882e9afe708d1255eef3e42862124af738cac23 url=/legacydeveloper/current/en-us/uiapi/ui_api_features_overview.md -->

# User Interface API Features

Learn to use User Interface API to work with various Salesforce features.

Build Salesforce UI for actions, apps, favorites, list views, and records.

- **[Work with Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records.htm)**  
    Use User Interface API to build UI that lets users create, read, update, and delete Salesforce records. Let’s look at two of the trickier aspects of the API: how to work with child relationships, and how to upload binary files to records.
- **[Work with Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_actions.htm)**  
    Use the Actions resources to get data and metadata about actions displayed in the Salesforce UI. Examples include standard and custom buttons, quick actions, and productivity actions.
- **[Manage Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_favorites.htm)**  
    Favorites let users access frequently used pages in Salesforce. Use User Interface API Favorites resources to manage favorites.
- **[Work with List Views](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_list_views.htm)**  
    Use the List View resources to get record data and metadata about list views displayed in the Salesforce UI.
- **[Manage Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_apps.htm)**  
    An app is a collection of items that work together to serve a particular function. Salesforce apps come in two flavors: Classic apps and Lightning apps. Classic apps are created and managed in Salesforce Classic. Lightning apps are created and managed in Lightning Experience. Admins customize both types of apps to match the way users work.

<!-- document id=54c01154e6afb5174e17b2749f870a280359ebcbd2597e50521a801c11f97a9f url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_nested.md -->

# User Interface API Nested Response Bodies

These response bodies are nested in top-level response bodies.

A request to a resource always returns an [HTTP status code](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_errors.htm#ui_api_errors "The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred."), whether the request was successful or not.

- **[Advanced Lookup Display Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_advanced_lookup_display_info.htm)**  
    Search lookups advanced display information.
- **[Advanced Lookup Display Info Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_advanced_lookup_display_info_field.htm)**  
    Search lookups advanced display field information.
- **[Advanced Lookup Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_advanced_lookup_info.htm)**  
    Advanced search lookup information.
- **[Batch Result Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_result.htm)**  
    The results of one subrequest in a batch request.
- **[Canvas Layout Component](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_canvas_layout_component.htm)**  
    A canvas component on a record page layout.
- **[Case Status Picklist Value Attributes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_case_status_picklist_values.htm)**  
    Additional picklist value attributes for case statuses.
- **[Child Relationship](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_child_relationship.htm)**  
    The child relationship on a parent object. Relationships are connections between records. Use relationships to display data about related object records on a record's detail page.
- **[Custom Link Layout Component](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_custom_link_layout_component.htm)**  
    A custom link component on a record page layout.
- **[Display Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_display_layout.htm)**  
    Search lookups target display layout metadata.
- **[Display Layout and Matching Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_display_layout_and_matching_info.htm)**  
    Search lookups target display layout and matching information.
- **[Duplicate Record Error](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_record_error.htm)**  
    Information about duplicate record errors. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record.
- **[Duplicate Result Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_result_info.htm)**  
    The result of the check for duplicate records. If duplicate records exist, returns the records' IDs and the duplicate rule that was used to match the records.
- **[Duplicate Rule](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_rule.htm)**  
    Describes a duplicate rule.
- **[Duplicate Rule Filter](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_rule_filter.htm)**  
    A duplicate rule filter.
- **[Duplicate Rule Filter Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicate_rule_filter_item.htm)**  
    A filter, or condition, for a duplicate rule. For example, a condition can specify that this rule applies only to movies that were produced in the United States.
- **[Error Message](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_error_message.htm)**  
    An error code and error message.
- **[Error with Output](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_error_with_output.htm)**  
    Contains extra information about errors. In rare cases, an error message isn't enough to describe the reason for a failure. For example, when a conflicting precondition exists, the error result can include the information about the cause of the conflict.
- **[Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field.htm)**  
    A field's metadata.
- **[Field Layout Component](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field_layout_component.htm)**  
    A field in a record layout.
- **[Field Value](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_field_value.htm)**  
    The raw and displayable field values for a field in a record.
- **[Filtered Lookup Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_filtered_lookup_info.htm)**  
    Metadata for a lookup filter.
- **[Lead Status Picklist Value Attributes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lead_status_picklist_values.htm)**  
    Additional picklist value attributes for lead statuses.
- **[List Column](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_column.htm)**  
    A column in a list.
- **[List Column Inline Edit Attributes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_column_inline_edit_attributes.htm)**  
    List column inline edit attributes.
- **[List Filter by Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_filter_by_info.htm)**  
    Information used to filter a list.
- **[List Info Share](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_share.htm)**  
    List info share.
- **[List Info Share Category](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_share_category.htm)**  
    List info share category.
- **[List Info Summary](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_summary.htm)**  
    List info summary.
- **[List Inline Edit Details](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_inline_edit_details.htm)**  
    List inline edit details.
- **[List Object Column](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_column.htm)**  
    List object column.
- **[List Object Picklist Value](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_picklist_value.htm)**  
    List object picklist value.
- **[List Object Quick Filter Overrides](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_quick_filter_overrides.htm)**  
    List object column quick filter overrides.
- **[List Object Scope](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_scope.htm)**  
    List object scope.
- **[List Object Scope Available Entity](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_scope_available_entity.htm)**  
    List object scope available entity, such as a group or queue.
- **[List Order By Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_order_by_info.htm)**  
    Ordering information for a list.
- **[List Reference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_reference.htm)**  
    The list view referenced by the collection or metadata.
- **[List Scope](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_scope.htm)**  
    List scope.
- **[List Scope Entity](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_scope_entity.htm)**  
    List scope entity.
- **[List Scope Related Entity](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_scope_related_entity.htm)**  
    List scope related entity.
- **[List User Preference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_user_preference.htm)**  
    User preferences for the list view.
- **[Location Field](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_location_field.htm)**  
    A complex location value for a record field.
- **[Lookup Metadata](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lookup_metadata.htm)**  
    Search lookups metadata.
- **[Lookup Metadata Target Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lookup_metadata_target_info.htm)**  
    Search lookups target metadata.
- **[Match](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_match.htm)**  
    A group of records that match the duplicate rules.
- **[Match Result](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_match_result.htm)**  
    A duplicate rule match. Duplicate rules are used to control whether and when you can save duplicate records within Salesforce. Duplicate rules tell Salesforce what action to take when you attempt to create a duplicate record. Each duplicate rule requires at least one matching rule to identify which existing records are possible duplicates.
- **[Match Result Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_match_result_info.htm)**  
    Information about the results of a match.
- **[Match Rule](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_match_rule.htm)**  
    A match rule defines how duplicate records are identified in duplicate rules and duplicate jobs. Learn about one of the match rules for the specified object, including the match rule's name and the fields that the match rule checks.
- **[Matching Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_matching_info.htm)**  
    Search lookups target matching information.
- **[Navigation Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_item.htm)**  
    The metadata for a single navigation item (tab).
- **[Object Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_action.htm)**  
    The actions for an object.
- **[Object Info Directory Entry](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info_directory_entry.htm)**  
    An entry in the Object Info Directory, which is a directory of objects that User Interface API supports and that the context user can access.
- **[Opportunity Stage Picklist Value Attributes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_opportunity_stage_picklist_values.htm)**  
    Additional picklist value attributes for opportunity stages.
- **[Page Reference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_page_reference.htm)**  
    A page reference.
- **[Picklist Value](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_value.htm)**  
    A single picklist value.
- **[Platform Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_platform_action.htm)**  
    The metadata, layout information, and data for a platform action.
- **[Record Exceptions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_exception.htm)**  
    A collection of record exception errors.
- **[Record Exception Error](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_exception_error.htm)**  
    Information about a record exception error.
- **[Record Layout Component](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_component.htm)**  
    A concrete record layout component.
- **[Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm)**  
    An item in a record layout.
- **[Record Layout Row](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_row.htm)**  
    A row in a record layout.
- **[Record Layout Save Option](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_save_option.htm)**  
    The save option for a record layout. Save options define behavior that occurs when objects are created or modified using the given layout. For example, for Cases and Leads, a “UseDefaultAssignmentRule” save option is exposed to control whether assignment rules are applied when Cases or Leads are created or edited.
- **[Record Layout Section](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_section.htm)**  
    A section in a record layout.
- **[Record Layout Section User State](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_section_user_state.htm)**  
    The user state information for a record layout section.
- **[Record Layout User State](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_user_state.htm)**  
    The user state information for a record layout.
- **[Record Template Clone](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_template_clone.htm)**  
    A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records.
- **[Record Template Create](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_template_create.htm)**  
    A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records.
- **[Record Type Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_type_info.htm)**  
    Information about a record type.
- **[Reference To Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_reference_to_info.htm)**  
    Information about a reference field's referenced types and the name field names of those types.
- **[Related List Column](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_column.htm)**  
    A column in a related list.
- **[Related List Info Summary](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_summary.htm)**  
    A summary of a related list for an object.
- **[Related List Reference](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_reference.htm)**  
    The related list referenced by the collection or metadata.
- **[Report Layout Component](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_report_layout_component.htm)**  
    A report chart component on a record layout page.
- **[Theme Banner](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_banner.htm)**  
    A theme banner image. Theme banners have a higher aspect ratio than theme images. The banner size may change slightly, so code accordingly.
- **[Theme Image](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_image.htm)**  
    A theme image at three sizes: small, medium, and large. Specific sizes may change slightly, so code accordingly.
- **[Theme Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme_info.htm)**  
    Color and icon information for a theme.
- **[Visualforce Layout Component](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_visualforce_layout_component.htm)**  
    A Visualforce component on a record layout page.
- **[Work Step Status Picklist Value Attributes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_workstep_picklist_values.htm)**  
    Additional picklist value attributes for work step statuses.

#### See Also

- [User Interface API Top-Level Response Bodies](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_top_level.htm "These response bodies are returned from requests to User Interface API resources. They may contain nested response bodies")

<!-- document id=52641f411011f08a5f93b842061c6cb1109d15e85ca66624a8f3a68cd34b5d2b url=/legacydeveloper/current/en-us/uiapi/ui_api_quick_start_postman.md -->

# User Interface API Quick Start

Use the Postman desktop app or web-based UI to easily explore and test the UI API and other Salesforce APIs against your orgs.

![Important](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name.

If you don’t already have an org, you can sign up for a [Salesforce Developer Edition](https://developer.salesforce.com/signup), also known as a _DE org_.

This quick start makes a request to the List UI resource, [/ui-api/list-info/${objectApiName}](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lists_object_get.htm "Get list views associated with an object."). This resource returns a collection of list info summaries for an object.

Before you connect Postman to Salesforce, [fork and configure the collection](https://github.com/forcedotcom/postman-salesforce-apis/blob/master/install-with-app.md).

These steps use the Postman desktop app to send a request. Alternatively, you can [connect the Postman web app to Salesforce using the Trailhead quick start](https://trailhead.salesforce.com/content/learn/projects/quick-start-connect-postman-to-salesforce), which requires a CORS configuration in Salesforce.

1. Open the Postman desktop app.
2. Expand the collection, and select **UI** | **List Views** | **Get List Views for an Object**.
3. Update the {{\_endpoint}} and {{version}} values if needed.
4. Go to the Authorization tab to choose your Auth Type and update required information.
5. Click **Send**.

The query returns a 200 OK status. If you receive an error, check your configuration and try again.

The [List Info Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_summary_collection.htm "List info summary collection.") response body includes an array of list info summaries.

{
    "count": 6,
    "currentPageToken": "0",
    "currentPageUrl": "/services/data/v62.0/ui-api/list-info/Account?pageSize=20&pageToken=0",
    "lists": \[
        {
            "apiName": "AllAccounts",
            "id": "00B58000002ssinEAA",
            "label": "All Accounts",
            "url": "/services/data/v62.0/ui-api/list-info/Account/AllAccounts"
        },
        {
            "apiName": "MyAccounts",
            "id": "00B58000002ssivEAA",
            "label": "My Accounts",
            "url": "/services/data/v62.0/ui-api/list-info/Account/MyAccounts"
        },
        {
            "apiName": "NewLastWeek",
            "id": "00B58000002ssiHEAQ",
            "label": "New Last Week",
            "url": "/services/data/v62.0/ui-api/list-info/Account/NewLastWeek"
        },
        {
            "apiName": "NewThisWeek",
            "id": "00B58000002ssi6EAA",
            "label": "New This Week",
            "url": "/services/data/v62.0/ui-api/list-info/Account/NewThisWeek"
        },
        {
            "apiName": "PlatinumandGoldSLACustomers",
            "id": "00B58000002ssiXEAQ",
            "label": "Platinum and Gold SLA Customers",
            "url": "/services/data/v62.0/ui-api/list-info/Account/PlatinumandGoldSLACustomers"
        },
        {
            "apiName": "RecentlyViewedAccounts",
            "id": "00B58000002ssimEAA",
            "label": "Recently Viewed Accounts",
            "url": "/services/data/v62.0/ui-api/list-info/Account/RecentlyViewedAccounts"
        }
    \],
    "nextPageToken": null,
    "nextPageUrl": null,
    "objectApiName": "Account",
    "pageSize": 20,
    "previousPageToken": null,
    "previousPageUrl": null,
    "queryString": null,
    "recentListsOnly": false
}

You just sent a UI API request using Postman! You can do more with UI API using Postman, such as sending a cURL command to [upload a file](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm "Upload documents and images or update the file with a new version.") to your Salesforce org.

To send a cURL command, import the request using raw text.

1. In Postman, click the **Import** tab on the top left side.
2. Select the **Raw text** tab.
3. Paste your cURL command and click **Continue**.
4. Verify your request name and format, then click **Import**.
5. Send your request.

Consider the following guidelines.

- If you’re sending any JSON data as part of your cURL command, the import adds the JSON string as a key on the **Body** | **form-data** tab by default. Move the JSON string from the **Body** | **form-data** tab to the **Body** | **raw** tab, and delete it from the **Body** | **form-data** tab.
- If you’re sending a file using the \-F option, upload your file under the **Body** | **form-data** tab. For example, you can [upload files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm "Upload documents and images or update the file with a new version.") by adding the fileData key and selecting a local file.

![Send a cURL command using Postman](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/api_ui/images/postman_curl_import.png)

<!-- document id=49851cc5ecbb7d044633e3d492556e5d50d603466f43f4bf0fd17123b007bdd8 url=/legacydeveloper/current/en-us/uiapi/ui_api_get_started_release_notes.md -->

# User Interface API Release Notes

The API release notes include updates to the request bodies, response bodies, and resources.

View the latest updates in the [User Interface API Release Notes](https://help.salesforce.com/s/articleView?id=release-notes.rn_api_ui.htm&language=en_US).

<!-- document id=7bf94455dad7d7c9e40643a081527c80471674f3800b8d51dd6cff703283db6a url=/legacydeveloper/current/en-us/uiapi/ui_api_requests_overview.md -->

# User Interface API Request Bodies

The successful execution of a request to a resource can return a response body in JSON format.

A request to a resource always returns an [HTTP response code](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_errors.htm#ui_api_errors "The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred."), whether the request was successful or not.

- **[Action Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_action_input.htm)**  
    Get the actions on related lists on a record detail page.
- **[Action Related List Single Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_action_related_list_single_batch_input.htm)**  
    Get the actions on a batch of related lists for a record.
- **[Action Related Lists Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_action_related_list_batch_input.htm)**  
    Get the actions on a batch of related lists for a record.
- **[Batch Record Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_input.htm)**  
    A description of multiple operations for a request to create, update, or delete a batch of records.
- **[Content Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_content_input.htm)**  
    Upload a file or a new file version.
- **[Batch Operation Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_batch_operation_input.htm)**  
    Represents the operation type and record data to create, update, and delete in a batch.
- **[Favorite Batch Collection Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_batch_collection_input.htm)**  
    A collection of all the favorites in a batch. Pass this request body to update a batch of favorites.
- **[Favorite Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_batch_input.htm)**  
    Represents a single favorite when updating favorites in batch.
- **[Favorite Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_input.htm)**  
    A favorite to create or update.
- **[List Filter By Info Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_filter_by_info_input.htm)**  
    List filter by info to update or create.
- **[List Info Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_info_input.htm)**  
    Info to update a list.
- **[List Info Post Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_info_post_input.htm)**  
    Info to create a list.
- **[List Order By Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_order_by_input.htm)**  
    Information describing how to order a related list. This request body supports sorting related lists only by one field. Use this request body to update a related list.
- **[List Preferences Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_preferences_input.htm)**  
    List preferences to update.
- **[List Records Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_records_input.htm)**  
    Record data to query for a list view.
- **[List Scope Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_scope_input.htm)**  
    List scope to update or create.
- **[List User Preference Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_list_user_preference_input.htm)**  
    A related list user preferences to update.
- **[Lookup Post Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_lookup_post_input.htm)**  
    Get lookup field suggestions.
- **[Navigation Item Collection Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_navigation_item_collection_input.htm)**  
    A collection of all the navigation items (tabs) for an app. Pass this request body to get or update a user’s personalized navigation items.
- **[Navigation Item Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_navigation_item_input.htm)**  
    Represents the list of navigation items in the order that you want them to appear in the app.
- **[Page Reference Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_page_reference_input.htm)**  
    To add a navigation item, include a pageReference. A pageReference is a JSON object that describes the navigation item’s page type, its attributes, and the state of the page.
- **[Perform Action Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_perform_action_input.htm)**  
    Perform a quick action that creates or updates a record.
- **[Record Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_record_input.htm)**  
    A description of a record to use in a request to create or update a record or in a request to check for duplicate records.
- **[Related List Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_input.htm)**  
    A related list to update.
- **[Related List Records Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_record_input.htm)**  
    Get record data for up to 1,999 records in a related list.
- **[Related List Records Batch Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_record_batch_input.htm)**  
    Get record data for a batch of related lists.
- **[Related List User Preferences Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_related_list_user_preferences_input.htm)**  
    User preferences to update for a related list.

<!-- document id=49d2f831f2621265a2bd8630411afb048bca19d64465dbf4d1f09422f65c7340 url=/legacydeveloper/current/en-us/uiapi/ui_api_resources_overview.md -->

# User Interface API Resources

This chapter contains User Interface API resources (also called endpoints).

- **[Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record.htm)**  
    Use these resources to get metadata and data about objects and records. These resources make it easy to build Salesforce UI.
- **[Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_actions.htm)**  
    Use these resources to get data and metadata about actions displayed in the Salesforce UI. Examples include standard and custom buttons, quick actions, and productivity actions.
- **[Favorites](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites.htm)**  
    Use these resources to create and update a single favorite or a collection of favorites, and to get favorites usage information. These resources make it easy to build UI for favorites.
- **[Lists](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views.htm)**  
    Use these resources to get data and metadata about list views and related lists displayed in the Salesforce UI.
- **[Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_apps_overview.htm)**  
    Use these resources to get data and metadata for apps displayed in the Salesforce UI.
- **[Get Active Theme](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_themes_active.htm)**  
    Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection.
- **[Session CSRF Token](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_session_csrf.htm)**  
    Get the Cross-Site Request Forgery (CSRF) token for your session to protect requests from malicious third-party sites forgeries.

<!-- document id=fb448321fc96b1bd3ad4dd80df9f585793b720b19cba8500b23658bef06eaffd url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_overview.md -->

# User Interface API Response Bodies

A request to a resource returns a response body. Some response bodies also contain nested response bodies.

A request to a resource always returns an [HTTP response code](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_errors.htm#ui_api_errors "The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred."), whether the request was successful or not.

- **[User Interface API Top-Level Response Bodies](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_top_level.htm)**  
    These response bodies are returned from requests to User Interface API resources. They may contain nested response bodies
- **[User Interface API Nested Response Bodies](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nested.htm)**  
    These response bodies are nested in top-level response bodies.

<!-- document id=f4613e3b1e7022a334070d983592ef7d2a291cc558f994c1b3f88be87bdc4cce url=/legacydeveloper/current/en-us/uiapi/ui_api_get_started_sample_apps.md -->

# User Interface API Sample Apps

We’ve built two sample apps that use User Interface API to create, read, update, and delete records. The apps are open-source and available on GitHub.

Record Viewer is a Node.js app available at [https://github.com/forcedotcom/RecordViewer](https://github.com/forcedotcom/RecordViewer "HTML (New Window)").

Record Viewer Native is a React Native app available at [https://github.com/forcedotcom/RecordViewerNative](https://github.com/forcedotcom/RecordViewerNative "HTML (New Window)").

<!-- document id=d421b94e903213f5ed780d61462b57b1f446ccf7728fb2be582392956b9a59c4 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_top_level.md -->

# User Interface API Top-Level Response Bodies

These response bodies are returned from requests to User Interface API resources. They may contain nested response bodies

A request to a resource always returns an [HTTP response code](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_errors.htm#ui_api_errors "The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred."), whether the request was successful or not.

- **[Action](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_action.htm)**  
    The actions for a single record or a collection of records.
- **[App](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_app.htm)**  
    The metadata for a single app.
- **[Apps](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_apps.htm)**  
    A list of apps that the current user has access to.
- **[Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results.htm)**  
    The results from a request to a batch resource. Results include information for each subrequest in the batch.
- **[Content Document Composite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_contentdocumentcomposite.htm)**  
    The file and its relationship to a record.
- **[CSRF Token](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_csrf_token.htm)**  
    Cross-Site Request Forgery (CSRF) token.
- **[Duplicates](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicates.htm)**  
    The results of a check for duplicate records.
- **[Duplicates Configuration](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicates_configuration.htm)**  
    Contains information about duplicate management configuration for an object. Learn whether duplicate management is configured, which fields are used to determine whether duplicate records exist, and which duplicate rules are active.
- **[Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite.htm)**  
    A single favorite.
- **[Favorite Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite_collection.htm)**  
    A list of favorites.
- **[List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_metadata.htm)**  
    Metadata that describes a list.
- **[List Info Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_info_summary_collection.htm)**  
    List info summary collection.
- **[List Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_object_info.htm)**  
    List object info.
- **[List Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_preferences.htm)**  
    List preferences.
- **[List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_list_record_collection.htm)**  
    A collection of list view records.
- **[Lookup Values](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_lookup_values.htm)**  
    Records, organized by object type, and metadata in a lookup relationship.
- **[Navigation Items](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nav_items.htm)**  
    An ordered list of navigation items (tabs) for the current user.
- **[Object Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info.htm)**  
    The metadata for an object.
- **[Object Info Directory](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_object_info_directory.htm)**  
    A directory of objects that are supported by User Interface API and available to the context user.
- **[Picklist Values](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_values.htm)**  
    The picklist values for a field, scoped to a record type. If a picklist is dependent, this response includes the values of its immediate controlling field and how they map to the picklist.
- **[Picklist Values Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_values_collection.htm)**  
    A collection of picklist values for all the picklists of a specified record type.
- **[Quick Action Execution](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_perform_action.htm)**  
    The results that are returned when a quick action executes.
- **[Quick Action Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_quick_action_layout.htm)**  
    The record layout used by the quick action.
- **[Record](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record.htm)**  
    The field data, API name, child relationship data, and record type information for a record.
- **[Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_collection.htm)**  
    A paginated collection of Record response bodies.
- **[Record Defaults](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults.htm)**  
    The default information and data needed to create or clone a record. Use these values in a request to POST /ui-api/records.
- **[Record Defaults Template Clone](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults_template_clone.htm)**  
    A record template containing the default information and data needed to clone a record. Use these values in a request to POST /ui-api/records.
- **[Record Defaults Template Create](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_defaults_template_create.htm)**  
    A record template containing the default information and data needed to create a record. Use these values in a request to POST /ui-api/records.
- **[Record Layout](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout.htm)**  
    The layout information for a record.
- **[Record UI](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_ui.htm)**  
    The layout information, field information, and data for a record.
- **[Related List Info](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_metadata.htm)**  
    Metadata that describes a related list.
- **[Related List Info Summary Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_summary_collection.htm)**  
    A collection of related lists for a given object.
- **[Related List Record Collection](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_record_collection.htm)**  
    A collection of related list records.
- **[Related List Record Count](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_record_count.htm)**  
    The number of records in a given related list.
- **[Related List User Preferences](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_related_list_user_preferences.htm)**  
    User preferences for a related list.
- **[Simplified Batch Results](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_batch_results_simplified.htm)**  
    The simplified results from a request to a batch resource. Results include information for each subrequest in the batch.
- **[Theme](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_theme.htm)**  
    A set of images and banners that make up a theme. Banners display across the top of a page and have a higher aspect ratio than images.

#### See Also

- [User Interface API Nested Response Bodies](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_nested.htm "These response bodies are nested in top-level response bodies.")

<!-- document id=d18279a70de92a30ff56c5ee50f2856900beaf54cf6e0b3a64ffe6357d019c40 url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_visualforce_layout_component.md -->

# Visualforce Layout Component

A Visualforce component on a record layout page.

| Property Name | Type | Description | Filter Group and Version | Available Version |
| --- | --- | --- | --- | --- |
| apiName | String | If a field powers this component, this property contains the API name of the field. | Small, 41.0 | 41.0 |
| componentType | String | The value is VisualforcePage. | Small, 41.0 | 41.0 |
| height | String | The height of the component. | Small, 41.0 | 41.0 |
| showLabel | Boolean | Indicates whether to show the section label with this Visualforce component (true) or not (false). | Small, 41.0 | 41.0 |
| showScroll | Boolean | Indicates whether to show the scroll bar on the canvas component (true) or not (false). | Small, 41.0 | 41.0 |
| visualforceUrl | String | The Visualforce URL. | Small, 41.0 | 41.0 |
| width | String | The width of the component. | Small, 41.0 | 41.0 |

#### See Also

- [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.")

<!-- document id=3050f203b6f1e3716b2c04a3a0912380ccf16d1275d1154dfb5463cdadcd6a5c url=/legacydeveloper/current/en-us/uiapi/ui_api_responses_workstep_picklist_values.md -->

# Work Step Status Picklist Value Attributes

Additional picklist value attributes for work step statuses.

To use work step status picklist value attributes, you must have [Field Service](https://developer.salesforce.com/docs/atlas.en-us.264.0.field_service_dev.meta/field_service_dev/fsl_dev_set_up.htm) enabled in your org.

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d186190e58">Property Name</th>

              <th class="featureTableHeader vertical-align-top " id="d186190e61">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d186190e64">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d186190e67">Filter Group and Version</th>

              <th class="featureTableHeader vertical-align-top " id="d186190e70">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d186190e58" data-title="Property Name"><samp class="codeph nolang">picklistAtrributes​ValueType</samp></td>

              <td class="entry" headers="d186190e61" data-title="Type">String</td>

              <td class="entry" headers="d186190e64" data-title="Description">The value is <samp class="codeph nolang">WorkStepStatus</samp>. Indicates
                that these value attributes are associated with the status of a work step.<p class="p">For
                  more information, see the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_workstepstatus.htm" target="_blank">WorkStepStatus object
                    documentation</a>.</p>
                <p class="p">The property <samp class="codeph nolang">picklistAtrributes​ValueType</samp> contains a typographical
                  error.</p>
              </td>

              <td class="entry" headers="d186190e67" data-title="Filter Group and Version">Small, 58.0</td>

              <td class="entry" headers="d186190e70" data-title="Available Version">58.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d186190e58" data-title="Property Name"><samp class="codeph nolang">statusCode</samp></td>

              <td class="entry" headers="d186190e61" data-title="Type">String</td>

              <td class="entry" headers="d186190e64" data-title="Description">Indicates the status category that this status belongs to.</td>

              <td class="entry" headers="d186190e67" data-title="Filter Group and Version">Small, 58.0</td>

              <td class="entry" headers="d186190e70" data-title="Available Version">58.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d186190e58" data-title="Property Name"><samp class="codeph nolang">sortOrder</samp></td>

              <td class="entry" headers="d186190e61" data-title="Type">Integer</td>

              <td class="entry" headers="d186190e64" data-title="Description">Indicates the order in which the work step statuses are displayed in the status
                category’s picklist.</td>

              <td class="entry" headers="d186190e67" data-title="Filter Group and Version">Small, 58.0</td>

              <td class="entry" headers="d186190e70" data-title="Available Version">58.0</td>

            </tr>

          </tbody>

        </table>

#### See Also

- [Picklist Value](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_picklist_value.htm "A single picklist value.")

<!-- document id=51bc3f2816fed0d2e90cc09aa1f3b9a74d6f1f9a9c9b957af78b9c71c238749a url=/legacydeveloper/current/en-us/uiapi/ui_api_features_actions.md -->

# Work with Actions

Use the Actions resources to get data and metadata about actions displayed in the Salesforce UI. Examples include standard and custom buttons, quick actions, and productivity actions.

You can use the actions endpoints to fetch lists of actions, but not to execute actions. It’s handy to get a list of actions if you want to use quick actions, if you have Visualforce overrides, or if you want to determine CRUD based on visible actions. For example, if a New action exists, then a user can create a record.

Get Actions for a Record Detail Page

As an example, let’s say we have an Account record detail page with a record ID of 001R0000003IDlwIAG. The page has some standard buttons and quick actions. To get information about all the actions on this page, make this request:

GET /services/data/v68.0/ui-api/actions/record/001R0000003IDlwIAG

The request returns a list of actions on the page and the URLs of the request and subrequests.

Filter the Action Results

To filter the results returned by the Actions resources, use the following request parameters:

- actionTypes—The action type.
- formFactor—The layout display size.
- sections—The section of the user interface that the action resides in.

For example, to filter a record actions request so that it includes only standard button actions, set the actionTypes parameter to StandardButton.

GET /services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG?actionTypes=StandardButton

#### See Also

- [Actions](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_actions.htm "Use these resources to get data and metadata about actions displayed in the Salesforce UI. Examples include standard and custom buttons, quick actions, and productivity actions.")

<!-- document id=fee76f3a83049fe8d105f163f70a4e3fe80ce2654319728eb2193f59d0a03737 url=/legacydeveloper/current/en-us/uiapi/ui_api_features_list_views.md -->

# Work with List Views

Use the List View resources to get record data and metadata about list views displayed in the Salesforce UI.

Get Record Data for a List View Using GET

You can get record data for a list view using a GET request and URL parameters to modify the results.

As an example, let’s say we have a list view named All Accounts with a list view ID of 00BR0000000Wc0rMAC. To get information about all the records on this list view, make this request.

GET /services/data/v68.0/ui-api/list-records/00BR0000000Wc0rMAC

You can also use the object API name and list view API name of the list view to make the same request.

GET /services/data/v68.0/ui-api/list-records/Account/AllAccounts

To get record data for the most recently used (MRU) list view for accounts, use the special \_\_Recent list view API name.

GET /services/data/v68.0/ui-api/list-records/Account/\_\_Recent

Modify the GET List View Results with URL Parameters.

Modify the list view results using these URL parameters.

- fields—Additional fields queried for the records returned, for display purposes. If a field is specified and the user doesn’t have access to it, an error occurs.
- optionalFields—Additional fields queried for the records returned, for display purposes. If a field is specified and the user doesn’t have access to it, no error occurs.
- pageSize—The number of list records viewed at one time.
- pageToken—A token that represents the page offset.
- searchTerm—A search term to filter the results.
- sortBy—The API names of the fields the list view is sorted by.
- where—A where string, using GraphQL syntax, to filter the results.

For example, to sort records by the date they were created, set the sortBy parameter to CreatedDate.

GET /services/data/v68.0/ui-api/list-records/00BR0000000Wc0rMAC?sortBy=CreatedDate

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

#### Note

Depending on the list view object, some extra fields that were not requested in the fields or optionalFields parameters can be returned. For example, if person accounts are enabled for the org, a request to get list view records can return the isPersonAccount field, among others.

Get Record Data for a List View Using POST

You can also get record data for a list view using a POST request and a request body to modify the results.

This example uses a request body to query a list view named All Accounts.

POST /services/data/v68.0/ui-api/list-records/Account/AllAccounts

{
  "fields": \["Name", "Type", "AnnualRevenue", "CreatedDate"\],
  "pageSize" : 10,
  "sortBy": \["CreatedDate"\],
  "searchTerm" : "United",
  "where": "{AnnualRevenue: { gt: 1000000}}"
}

This example uses the special \_\_Recent list view API name to get the record data for the most recently used (MRU) list view for accounts.

POST /services/data/v68.0/ui-api/list-records/Account/\_\_Recent

Get Metadata for a List View

You can get metadata for a list view using a GET request.

As an example, let’s say we have a list view named All Accounts with a list view ID of 00BR0000000Wc0rMAC. To get information about the metadata for this list view, make this request:

GET /services/data/v68.0/ui-api/list-info/00BR0000000Wc0rMAC

You can also use the object API name and list view API name of the list view to make the same request:

GET /services/data/v68.0/ui-api/list-info/Account/AllAccounts

To get the most recently used (MRU) list view metadata for accounts, use the special \_\_Recent list view API name.

GET /services/data/v68.0/ui-api/list-info/Account/\_\_Recent

To get the search layout list view metadata for accounts, use the special \_\_SearchResult list view API name.

GET /services/data/v68.0/ui-api/list-info/Account/\_\_SearchResult

#### See Also

- [Lists](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list_views.htm "Use these resources to get data and metadata about list views and related lists displayed in the Salesforce UI.")

<!-- document id=7ce8e86376e162f0fc2ddf165aff09d8edf1bf47a05b63fbceff672b86255534 url=/legacydeveloper/current/en-us/uiapi/ui_api_features_records.md -->

# Work with Records

Use User Interface API to build UI that lets users create, read, update, and delete Salesforce records. Let’s look at two of the trickier aspects of the API: how to work with child relationships, and how to upload binary files to records.

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

#### Note

User Interface API resources operate on all custom objects and [supported standard objects](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started_supported_objects.htm#ui_api_get_started_supported_objects "User Interface API supports all custom objects and external objects and many standard objects.").

- **[Get Child Records](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_child_relationships.htm)**  
    User Interface API has several resources that include child records in their responses. If a record has many child relationships, a response can be huge and have a negative effect on performance. To get only the records you need, request records for specific child relationships and set the page size of the results.
- **[Build UI for Picklists](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_dependent_picklist.htm)**  
    User Interface API exposes properties and resources that make it easy for a client to build picklists and dependent picklists.
- **[Upload Binary Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_binary_upload.htm)**  
    If a record has a Base64 field, you can upload binary data to the field when you create or update a record.
- **[Prevent Record Duplication with Idempotent Record Writes](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_idempotent.htm)**  
    Use idempotent record writes to avoid duplication of records and server operations, which can occur when an app or client encounters a network connection issue.
- **[Upload Files](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_features_records_content_document.htm)**  
    Upload documents and images or update the file with a new version.