Salesforce

Salesforce Lookups API

Lookup field search endpoints

Documentation GitHub OpenAPI

Operations 1

GET /lookups/{objectApiName}/{fieldApiName} Salesforce Search Lookup Field Records #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/salesforce-lookups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Salesforce UI Lookups API
  description: The Salesforce UI API provides a comprehensive REST interface for building user interfaces that work with Salesforce metadata and data. It returns layout information, picklist values, list views, record data, and object metadata that Lightning components rely on. Unlike the general REST API, the UI API returns UI-ready data including display labels, field types, formatting hints, and page layout assignments.
  version: '59.0'
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
  termsOfService: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instanceName}.salesforce.com/services/data/v{version}/ui-api
  description: Salesforce org UI API base
  variables:
    instanceName:
      description: Salesforce org instance name or custom domain
      default: myorg
    version:
      description: Salesforce API version
      default: '59.0'
security:
- oauthBearerToken: []
tags:
- name: Lookups
  description: Lookup field search endpoints
paths:
  /lookups/{objectApiName}/{fieldApiName}:
    get:
      operationId: getLookupRecords
      summary: Salesforce Search Lookup Field Records
      description: Returns matching records for a lookup field search. Used to populate the typeahead list in Lightning lookup components.
      tags:
      - Lookups
      parameters:
      - $ref: '#/components/parameters/ObjectApiName'
      - name: fieldApiName
        in: path
        required: true
        description: The API name of the lookup field
        schema:
          type: string
        example: example_value
      - name: searchTerm
        in: query
        required: true
        description: The search text to match against lookup records
        schema:
          type: string
        example: example_value
      - name: dependentFieldBindings
        in: query
        description: JSON-encoded field value pairs for dependent picklist filtering
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          description: Lookup results retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupRecordsCollection'
              examples:
                Getlookuprecords200Example:
                  summary: Default getLookupRecords 200 response
                  x-microcks-default: true
                  value:
                    count: 42
                    lookupResults:
                    - displayValue: example_value
                      id: abc123
                      name: Example Title
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    LookupRecordsCollection:
      type: object
      description: Collection of records matching a lookup search
      properties:
        count:
          type: integer
          example: 42
        lookupResults:
          type: array
          items:
            type: object
            properties:
              displayValue:
                type: string
              id:
                type: string
              name:
                type: string
          example: []
  parameters:
    ObjectApiName:
      name: objectApiName
      in: path
      required: true
      description: The API name of the Salesforce object (e.g., Account, Contact, MyObject__c)
      schema:
        type: string
    PageSize:
      name: pageSize
      in: query
      description: Number of records per page
      schema:
        type: integer
        minimum: 1
        maximum: 2000
        default: 50
  securitySchemes:
    oauthBearerToken:
      type: http
      scheme: bearer
      description: Salesforce OAuth 2.0 Bearer Token
externalDocs:
  description: Salesforce UI API Documentation
  url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/