---
schema_version: "1"
id: 6675a546b4b1368665c32f3dbe786e3e7dc5ab4dd74015052c2aae293f7d4238
title: Get Lookup Field Suggestions for a Specified Object
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_resources_lookup_object_get.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_lookup_object_get.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: f7905e8fc5e26ba6c23b907d89a6cd0345c711e0a4496646a42ec70e072bd8d5
description: 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 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.")