Salesforce Field API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Field API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Field
paths:
  /data/v64.0/ui-api/actions/lookup/{SOBJECT_API_NAMES}:
    parameters: []
    get:
      tags:
      - Field
      summary: Salesforce Get Lookup Field Actions
      description: Get the actions on Lightning pages (FlexiPages).
      operationId: GetLookupFieldActions
      parameters:
      - name: SOBJECT_API_NAMES
        in: path
        description: A lookup field name, or a comma-delimited list of lookup field names.
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 11:47:33 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"1b573078964111c994670eea1c038003--gzip"'
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetLookupFieldActions'
                - examples:
                  - actions:
                      Account:
                        actions:
                        - actionListContext: Lookup
                          actionTarget: null
                          actionTargetType: Invoke
                          apiName: CreateFromLookup
                          externalId: 00D58000000arpq:Account::Lookup:Desktop:StandardButton:CreateFromLookup
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_120.png
                          id: 0JV4H0000327596WAA
                          isMassAction: 'false'
                          label: New
                          lwcComponent: null
                          primaryColor: 1B96FF
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: Account
                          subtype: null
                          targetObject: Account
                          targetUrl: null
                          type: StandardButton
                        links: []
                        url: /services/data/v58.0/ui-api/actions/lookup/Account
                    eTag: 1b573078964111c994670eea1c038003
                    url: /services/data/v58.0/ui-api/actions/lookup/Account
                contentMediaType: application/json;charset=UTF-8
              example:
                actions:
                  Account:
                    actions:
                    - actionListContext: Lookup
                      actionTarget: null
                      actionTargetType: Invoke
                      apiName: CreateFromLookup
                      externalId: 00D58000000arpq:Account::Lookup:Desktop:StandardButton:CreateFromLookup
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_120.png
                      id: 0JV4H0000327596WAA
                      isMassAction: 'false'
                      label: New
                      lwcComponent: null
                      primaryColor: 1B96FF
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: Account
                      subtype: null
                      targetObject: Account
                      targetUrl: null
                      type: StandardButton
                    links: []
                    url: /services/data/v58.0/ui-api/actions/lookup/Account
                eTag: 1b573078964111c994670eea1c038003
                url: /services/data/v58.0/ui-api/actions/lookup/Account
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/ui-api/object-info/{SOBJECT_API_NAME}/picklist-values/{RECORD_TYPE_ID}/{FIELD_API_NAME}:
    parameters: []
    get:
      tags:
      - Field
      summary: Salesforce Get Values for a Picklist Field
      description: Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme.
      operationId: GetValuesforaPicklistField
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: Object API Name
        required: true
        schema:
          type: string
          examples:
          - Account
        example: example_value
      - name: RECORD_TYPE_ID
        in: path
        description: Record type Id. Use `012000000000000AAA` as default when there are no custom record types.
        required: true
        schema:
          type: string
          examples:
          - 012000000000000AAA
        example: '500123'
      - name: FIELD_API_NAME
        in: path
        description: Field API Name (optional)
        required: true
        schema:
          type: string
          examples:
          - Industry
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Tue, 04 May 2021 09:32:34 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=31536002; includeSubDomains
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"bee3e6401e143e18332a17639061c5ff--gzip"'
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetValuesforaPicklistField'
                - examples:
                  - controllerValues: {}
                    defaultValue: null
                    eTag: bee3e6401e143e18332a17639061c5ff
                    url: /services/data/v51.0/ui-api/object-info/Account/picklist-values/012000000000000AAA/Industry
                    values:
                    - attributes: null
                      label: Agriculture
                      validFor: []
                      value: Agriculture
                    - attributes: null
                      label: Apparel
                      validFor: []
                      value: Apparel
                    - attributes: null
                      label: Banking
                      validFor: []
                      value: Banking
                    - attributes: null
                      label: Biotechnology
                      validFor: []
                      value: Biotechnology
                    - attributes: null
                      label: Chemicals
                      validFor: []
                      value: Chemicals
                    - attributes: null
                      label: Communications
                      validFor: []
                      value: Communications
                    - attributes: null
                      label: Construction
                      validFor: []
                      value: Construction
                    - attributes: null
                      label: Consulting
                      validFor: []
                      value: Consulting
                    - attributes: null
                      label: Education
                      validFor: []
                      value: Education
                    - attributes: null
                      label: Electronics
                      validFor: []
                      value: Electronics
                    - attributes: null
                      label: Energy
                      validFor: []
                      value: Energy
                    - attributes: null
                      label: Engineering
                      validFor: []
                      value: Engineering
                    - attributes: null
                      label: Entertainment
                      validFor: []
                      value: Entertainment
                    - attributes: null
                      label: Environmental
                      validFor: []
                      value: Environmental
                    - attributes: null
                      label: Finance
                      validFor: []
                      value: Finance
                    - attributes: null
                      label: Food & Beverage
                      validFor: []
                      value: Food & Beverage
                    - attributes: null
                      label: Government
                      validFor: []
                      value: Government
                    - attributes: null
                      label: Healthcare
                      validFor: []
                      value: Healthcare
                    - attributes: null
                      label: Hospitality
                      validFor: []
                      value: Hospitality
                    - attributes: null
                      label: Insurance
                      validFor: []
                      value: Insurance
                    - attributes: null
                      label: Machinery
                      validFor: []
                      value: Machinery
                    - attributes: null
                      label: Manufacturing
                      validFor: []
                      value: Manufacturing
                    - attributes: null
                      label: Media
                      validFor: []
                      value: Media
                    - attributes: null
                      label: Not For Profit
                      validFor: []
                      value: Not For Profit
                    - attributes: null
                      label: Recreation
                      validFor: []
                      value: Recreation
                    - attributes: null
                      label: Retail
                      validFor: []
                      value: Retail
                    - attributes: null
                      label: Shipping
                      validFor: []
                      value: Shipping
                    - attributes: null
                      label: Technology
                      validFor: []
                      value: Technology
                    - attributes: null
                      label: Telecommunications
                      validFor: []
                      value: Telecommunications
                    - attributes: null
                      label: Transportation
                      validFor: []
                      value: Transportation
                    - attributes: null
                      label: Utilities
                      validFor: []
                      value: Utilities
                    - attributes: null
                      label: Other
                      validFor: []
                      value: Other
                contentMediaType: application/json;charset=UTF-8
              example:
                controllerValues: {}
                defaultValue: null
                eTag: bee3e6401e143e18332a17639061c5ff
                url: /services/data/v51.0/ui-api/object-info/Account/picklist-values/012000000000000AAA/Industry
                values:
                - attributes: null
                  label: Agriculture
                  validFor: []
                  value: Agriculture
                - attributes: null
                  label: Apparel
                  validFor: []
                  value: Apparel
                - attributes: null
                  label: Banking
                  validFor: []
                  value: Banking
                - attributes: null
                  label: Biotechnology
                  validFor: []
                  value: Biotechnology
                - attributes: null
                  label: Chemicals
                  validFor: []
                  value: Chemicals
                - attributes: null
                  label: Communications
                  validFor: []
                  value: Communications
                - attributes: null
                  label: Construction
                  validFor: []
                  value: Construction
                - attributes: null
                  label: Consulting
                  validFor: []
                  value: Consulting
                - attributes: null
                  label: Education
                  validFor: []
                  value: Education
                - attributes: null
                  label: Electronics
                  validFor: []
                  value: Electronics
                - attributes: null
                  label: Energy
                  validFor: []
                  value: Energy
                - attributes: null
                  label: Engineering
                  validFor: []
                  value: Engineering
                - attributes: null
                  label: Entertainment
                  validFor: []
                  value: Entertainment
                - attributes: null
                  label: Environmental
                  validFor: []
                  value: Environmental
                - attributes: null
                  label: Finance
                  validFor: []
                  value: Finance
                - attributes: null
                  label: Food & Beverage
                  validFor: []
                  value: Food & Beverage
                - attributes: null
                  label: Government
                  validFor: []
                  value: Government
                - attributes: null
                  label: Healthcare
                  validFor: []
                  value: Healthcare
                - attributes: null
                  label: Hospitality
                  validFor: []
                  value: Hospitality
                - attributes: null
                  label: Insurance
                  validFor: []
                  value: Insurance
                - attributes: null
                  label: Machinery
                  validFor: []
                  value: Machinery
                - attributes: null
                  label: Manufacturing
                  validFor: []
                  value: Manufacturing
                - attributes: null
                  label: Media
                  validFor: []
                  value: Media
                - attributes: null
                  label: Not For Profit
                  validFor: []
                  value: Not For Profit
                - attributes: null
                  label: Recreation
                  validFor: []
                  value: Recreation
                - attributes: null
                  label: Retail
                  validFor: []
                  value: Retail
                - attributes: null
                  label: Shipping
                  validFor: []
                  value: Shipping
                - attributes: null
                  label: Technology
                  validFor: []
                  value: Technology
                - attributes: null
                  label: Telecommunications
                  validFor: []
                  value: Telecommunications
                - attributes: null
                  label: Transportation
                  validFor: []
                  value: Transportation
                - attributes: null
                  label: Utilities
                  validFor: []
                  value: Utilities
                - attributes: null
                  label: Other
                  validFor: []
                  value: Other
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/ui-api/lookups/{SOBJECT_API_NAME}/{FIELD_API_NAME}:
    parameters: []
    get:
      tags:
      - Field
      summary: Salesforce Get Lookup Field Suggestions
      description: 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.
      operationId: GetLookupFieldSuggestions
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: sObject API name
        required: true
        schema:
          type: string
        example: example_value
      - name: FIELD_API_NAME
        in: path
        description: Field API name
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 27 Sep 2023 16:07:13 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetLookupFieldSuggestions'
                - examples:
                  - lookupResults:
                      Account:
                        count: 2
                        currentPageToken: null
                        currentPageUrl: /services/data/v58.0/ui-api/lookups/Contact/AccountId/Account?searchType=Recent&page=1&pageSize=25
                        nextPageToken: null
                        nextPageUrl: null
                        previousPageToken: null
                        previousPageUrl: null
                        records:
                        - apiName: Account
                          childRelationships: {}
                          eTag: 610a250509b966f2eb376b3205824a8b
                          fields:
                            Id:
                              displayValue: null
                              value: 001B000000UnQ2yIAF
                            Name:
                              displayValue: null
                              value: Dickenson plc
                            Site:
                              displayValue: null
                              value: null
                          id: 001B000000UnQ2yIAF
                          lastModifiedById: 005B0000003TOI6IAO
                          lastModifiedDate: '2017-08-18T14:46:22.000Z'
                          recordTypeId: 012000000000000AAA
                          recordTypeInfo: null
                          systemModstamp: '2017-08-18T14:46:22.000Z'
                          weakEtag: 1503067582000
                        - apiName: Account
                          childRelationships: {}
                          eTag: d0b7cec61a65e01f88b2596dea75cbd8
                          fields:
                            Id:
                              displayValue: null
                              value: 001B000000UnQ2wIAF
                            Name:
                              displayValue: null
                              value: Burlington Textiles Corp of America
                            Site:
                              displayValue: null
                              value: null
                          id: 001B000000UnQ2wIAF
                          lastModifiedById: 005B0000003TOI6IAO
                          lastModifiedDate: '2017-08-18T14:46:22.000Z'
                          recordTypeId: 012000000000000AAA
                          recordTypeInfo: null
                          systemModstamp: '2017-08-18T14:46:22.000Z'
                          weakEtag: 1503067582000
                    metadata:
                      Account:
                        fieldApiName: null
                        objectApiName: null
                        secondaryField: Site
                        targetInfo: {}
                contentMediaType: application/json;charset=UTF-8
              example:
                lookupResults:
                  Account:
                    count: 2
                    currentPageToken: null
                    currentPageUrl: /services/data/v58.0/ui-api/lookups/Contact/AccountId/Account?searchType=Recent&page=1&pageSize=25
                    nextPageToken: null
                    nextPageUrl: null
                    previousPageToken: null
                    previousPageUrl: null
                    records:
                    - apiName: Account
                      childRelationships: {}
                      eTag: 610a250509b966f2eb376b3205824a8b
                      fields:
                        Id:
                          displayValue: null
                          value: 001B000000UnQ2yIAF
                        Name:
                          displayValue: null
                          value: Dickenson plc
                        Site:
                          displayValue: null
                          value: null
                      id: 001B000000UnQ2yIAF
                      lastModifiedById: 005B0000003TOI6IAO
                      lastModifiedDate: '2017-08-18T14:46:22.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2017-08-18T14:46:22.000Z'
                      weakEtag: 1503067582000
                    - apiName: Account
                      childRelationships: {}
                      eTag: d0b7cec61a65e01f88b2596dea75cbd8
                      fields:
                        Id:
                          displayValue: null
                          value: 001B000000UnQ2wIAF
                        Name:
                          displayValue: null
                          value: Burlington Textiles Corp of America
                        Site:
                          displayValue: null
                          value: null
                      id: 001B000000UnQ2wIAF
                      lastModifiedById: 005B0000003TOI6IAO
                      lastModifiedDate: '2017-08-18T14:46:22.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2017-08-18T14:46:22.000Z'
                      weakEtag: 1503067582000
                metadata:
                  Account:
                    fieldApiName: null
                    objectApiName: null
                    secondaryField: Site
                    targetInfo: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/ui-api/lookups/{SOBJECT_API_NAME}/{FIELD_API_NAME}/{TARGET_API_NAME}:
    parameters: []
    get:
      tags:
      - Field
      summary: Salesforce Get Lookup Field Suggestions for a Specified Object
      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.
      operationId: GetLookupFieldSuggestionsforaSpecifiedObject
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: The API name of a source object.
        required: true
        schema:
          type: string
        example: example_value
      - name: FIELD_API_NAME
        in: path
        description: The API name of a lookup field on the source object.
        required: true
        schema:
          type: string
        example: example_value
      - name: TARGET_API_NAME
        in: path
        description: The API name of the target (lookup) object.
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 27 Sep 2023 16:10:07 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
         

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-field-api-openapi.yml