Salesforce Search API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Search 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: Search
paths:
  /data/v64.0/chatter/feed-elements:
    parameters: []
    post:
      tags:
      - Search
      summary: Salesforce Feed Elements, Post and Search
      description: 'Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a describeSObjects() call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field.


        https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element.htm'
      operationId: FeedElements,PostandSearch
      parameters:
      - name: feedElementType
        in: query
        description: 'Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values:

          Bundle—A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values.

          FeedItem—A feed item has a single parent and is scoped to one community or across all communities. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values.

          Recommendation—A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user.'
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - FeedItem
        example: example_value
      - name: subjectId
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - <USER_GROUP_RECORD_ID>
        example: '500123'
      - name: text
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - New Feed Item
        example: example_value
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 11:06: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:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulFeedElementsPostandSearch'
                - examples:
                  - actor:
                      additionalLabel: null
                      communityNickname: User1696423780773910041
                      companyName: Salesforce
                      displayName: Name
                      firstName: Firstname
                      id: 005...
                      isActive: true
                      isInThisCommunity: true
                      lastName: Name
                      motif:
                        color: 1B96FF
                        largeIconUrl: /img/icon/profile64.png
                        mediumIconUrl: /img/icon/profile32.png
                        smallIconUrl: /img/icon/profile16.png
                        svgIconUrl: null
                      mySubscription: null
                      name: Name
                      outOfOffice:
                        message: ''
                      photo:
                        fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
                        largePhotoUrl: https://<my_domain>/profilephoto/729.../F
                        mediumPhotoUrl: https://<my_domain>/profilephoto/729.../M
                        photoVersionId: 729...
                        smallPhotoUrl: https://<my_domain>/profilephoto/729.../T
                        standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
                        url: /services/data/v58.0/connect/user-profiles/005.../photo
                      reputation: null
                      title: null
                      type: User
                      url: /services/data/v58.0/chatter/users/005...
                      userType: Internal
                    body:
                      isRichText: false
                      messageSegments:
                      - text: New Feed Item
                        type: Text
                      text: New Feed Item
                    capabilities:
                      associatedActions:
                        platformActionGroups: []
                      bookmarks:
                        isBookmarkedByCurrentUser: false
                      chatterLikes:
                        isLikedByCurrentUser: false
                        likesMessage: null
                        myLike: null
                        page:
                          currentPageToken: 0
                          currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items
                          items: []
                          nextPageToken: null
                          nextPageUrl: null
                          previousPageToken: null
                          previousPageUrl: null
                          total: 0
                      close:
                        canContextUserUpdateIsClosed: true
                        isClosed: false
                      comments:
                        page:
                          currentPageToken: null
                          currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items
                          items: []
                          nextPageToken: null
                          nextPageUrl: null
                          previousPageToken: null
                          previousPageUrl: null
                          total: 0
                      edit:
                        isEditRestricted: false
                        isEditableByMeUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me
                        lastEditedBy: null
                        lastEditedDate: null
                        latestRevision: 1
                        relativeLastEditedDate: null
                      interactions:
                        count: 0
                      mute:
                        isMutedByMe: false
                      readBy:
                        isReadByMe: true
                        lastReadDateByMe: '2023-11-22T11:06:07.000Z'
                        page:
                          currentPageToken: null
                          currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3
                          items: []
                          nextPageToken: null
                          nextPageUrl: null
                          previousPageToken: null
                          previousPageUrl: null
                          total: 0
                      status:
                        feedEntityStatus: Published
                        isApprovableByMe: true
                      topics:
                        canAssignTopics: true
                        items: []
                      upDownVote:
                        downVoteCount: 0
                        myVote: None
                        upVoteCount: 0
                    clientInfo:
                      applicationName: Postman Playground
                      applicationUrl: null
                    createdDate: '2023-11-22T11:06:07.000Z'
                    event: false
                    feedElementType: FeedItem
                    hasVerifiedComment: false
                    header:
                      isRichText: null
                      messageSegments:
                      - motif:
                          color: 1B96FF
                          largeIconUrl: /img/icon/profile64.png
                          mediumIconUrl: /img/icon/profile32.png
                          smallIconUrl: /img/icon/profile16.png
                          svgIconUrl: null
                        reference:
                          id: 005...
                          url: /services/data/v58.0/chatter/users/005...
                        text: Name
                        type: EntityLink
                      text: Name
                    id: 0D5...
                    isDeleteRestricted: false
                    isSharable: false
                    modifiedDate: '2023-11-22T11:06:07.000Z'
                    originalFeedItem: null
                    originalFeedItemActor: null
                    parent:
                      entityLabel:
                        label: Account
                        labelPlural: Accounts
                      id: 001...
                      motif:
                        color: 5867E8
                        largeIconUrl: /img/icon/accounts64.png
                        mediumIconUrl: /img/icon/accounts32.png
                        smallIconUrl: /img/icon/accounts16.png
                        svgIconUrl: null
                      mySubscription: null
                      name: Burlington Textiles Corp of America
                      type: Account
                      url: /services/data/v58.0/chatter/records/001...
                    photoUrl: https://<my_domain>/profilephoto/729.../T
                    relativeCreatedDate: Just now
                    type: TextPost
                    url: /services/data/v58.0/chatter/feed-elements/0D5...
                    visibility: InternalUsers
                contentMediaType: application/json;charset=UTF-8
              example:
                actor:
                  additionalLabel: null
                  communityNickname: User1696423780773910041
                  companyName: Salesforce
                  displayName: Name
                  firstName: Firstname
                  id: 005...
                  isActive: true
                  isInThisCommunity: true
                  lastName: Name
                  motif:
                    color: 1B96FF
                    largeIconUrl: /img/icon/profile64.png
                    mediumIconUrl: /img/icon/profile32.png
                    smallIconUrl: /img/icon/profile16.png
                    svgIconUrl: null
                  mySubscription: null
                  name: Name
                  outOfOffice:
                    message: ''
                  photo:
                    fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
                    largePhotoUrl: https://<my_domain>/profilephoto/729.../F
                    mediumPhotoUrl: https://<my_domain>/profilephoto/729.../M
                    photoVersionId: 729...
                    smallPhotoUrl: https://<my_domain>/profilephoto/729.../T
                    standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
                    url: /services/data/v58.0/connect/user-profiles/005.../photo
                  reputation: null
                  title: null
                  type: User
                  url: /services/data/v58.0/chatter/users/005...
                  userType: Internal
                body:
                  isRichText: false
                  messageSegments:
                  - text: New Feed Item
                    type: Text
                  text: New Feed Item
                capabilities:
                  associatedActions:
                    platformActionGroups: []
                  bookmarks:
                    isBookmarkedByCurrentUser: false
                  chatterLikes:
                    isLikedByCurrentUser: false
                    likesMessage: null
                    myLike: null
                    page:
                      currentPageToken: 0
                      currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items
                      items: []
                      nextPageToken: null
                      nextPageUrl: null
                      previousPageToken: null
                      previousPageUrl: null
                      total: 0
                  close:
                    canContextUserUpdateIsClosed: true
                    isClosed: false
                  comments:
                    page:
                      currentPageToken: null
                      currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items
                      items: []
                      nextPageToken: null
                      nextPageUrl: null
                      previousPageToken: null
                      previousPageUrl: null
                      total: 0
                  edit:
                    isEditRestricted: false
                    isEditableByMeUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me
                    lastEditedBy: null
                    lastEditedDate: null
                    latestRevision: 1
                    relativeLastEditedDate: null
                  interactions:
                    count: 0
                  mute:
                    isMutedByMe: false
                  readBy:
                    isReadByMe: true
                    lastReadDateByMe: '2023-11-22T11:06:07.000Z'
                    page:
                      currentPageToken: null
                      currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3
                      items: []
                      nextPageToken: null
                      nextPageUrl: null
                      previousPageToken: null
                      previousPageUrl: null
                      total: 0
                  status:
                    feedEntityStatus: Published
                    isApprovableByMe: true
                  topics:
                    canAssignTopics: true
                    items: []
                  upDownVote:
                    downVoteCount: 0
                    myVote: None
                    upVoteCount: 0
                clientInfo:
                  applicationName: Postman Playground
                  applicationUrl: null
                createdDate: '2023-11-22T11:06:07.000Z'
                event: false
                feedElementType: FeedItem
                hasVerifiedComment: false
                header:
                  isRichText: null
                  messageSegments:
                  - motif:
                      color: 1B96FF
                      largeIconUrl: /img/icon/profile64.png
                      mediumIconUrl: /img/icon/profile32.png
                      smallIconUrl: /img/icon/profile16.png
                      svgIconUrl: null
                    reference:
                      id: 005...
                      url: /services/data/v58.0/chatter/users/005...
                    text: Name
                    type: EntityLink
                  text: Name
                id: 0D5...
                isDeleteRestricted: false
                isSharable: false
                modifiedDate: '2023-11-22T11:06:07.000Z'
                originalFeedItem: null
                originalFeedItemActor: null
                parent:
                  entityLabel:
                    label: Account
                    labelPlural: Accounts
                  id: 001...
                  motif:
                    color: 5867E8
                    largeIconUrl: /img/icon/accounts64.png
                    mediumIconUrl: /img/icon/accounts32.png
                    smallIconUrl: /img/icon/accounts16.png
                    svgIconUrl: null
                  mySubscription: null
                  name: Burlington Textiles Corp of America
                  type: Account
                  url: /services/data/v58.0/chatter/records/001...
                photoUrl: https://<my_domain>/profilephoto/729.../T
                relativeCreatedDate: Just now
                type: TextPost
                url: /services/data/v58.0/chatter/feed-elements/0D5...
                visibility: InternalUsers
      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/search:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Search
      description: 'Executes the specified SOSL search. The search string must be URL-encoded.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm'
      operationId: Search
      parameters:
      - name: q
        in: query
        description: A SOSL statement that is properly URL-encoded.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/search/scopeOrder:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Search Scope and Order
      description: 'Returns an ordered list of objects in the default global search scope of a logged-in user. Global search keeps track of which objects the user interacts with and how often and arranges the search results accordingly. Objects used most frequently appear at the top of the list.

        The returned list reflects the object order in the user’s default search scope, including any pinned objects on the user’s search results page. This call is useful if you want to implement a custom search results page using the optimized global search scope. The search string must be URL-encoded.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_scope_order.htm'
      operationId: SearchScopeandOrder
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/search/layout:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Search Result Layouts
      description: 'Returns search result layout information for the objects in the query string. For each object, this call returns the list of fields displayed on the search results page as columns, the number of rows displayed on the first page, and the label used on the search results page.

        This call supports bulk fetch for up to 100 objects in a query.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_layouts.htm'
      operationId: SearchResultLayouts
      parameters:
      - name: q
        in: query
        description: Comma delimited object list
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/search/suggestions:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Search for Records Suggested by Autocomplete and Instant Results
      description: 'Returns a list of suggested records whose names match the user’s search string. The suggestions resource provides autocomplete results and instant results for users to navigate directly to likely relevant records, before performing a full search.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_records.htm'
      operationId: SearchforRecordsSuggestedbyAutocompleteandInstantResults
      parameters:
      - name: q
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: sobject
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/search/suggestSearchQueries:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Search Suggested Queries
      description: 'Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_queries.htm'
      operationId: SearchSuggestedQueries
      parameters:
      - name: q
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: language
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/parameterizedSearch:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Parameterized Search
      description: Executes a simple RESTful search using parameters instead of a SOSL clause. Indicate parameters in a URL in the GET method. Or, use POST for more complex JSON searches.
      operationId: ParameterizedSearch
      parameters:
      - name: q
        in: query
        description: A search string that is properly URL-encoded
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      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/tooling/search:
    parameters: []
    get:
      tags:
      - Search
      summary: Salesforce Tooling Search
      description: Runs one or more methods within one or more Apex classes, using the asynchronous test execution mechanism. In the request body, you can specify test class names and IDs, suite names and IDs, the maximum number of failed tests to allow, and the test level, as comma-separated lists or as an array. You can also indicate whether to opt out of collecting code coverage information during the test run (available in API version 43.0 and later).
      operationId: ToolingSearch
      parameters:
      - name: q
        in: query
        description: SOSL search statement
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 11 Dec 2023 10:34:10 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
            Sforce-Limit-Info:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: api-usage=294/15000
            queryId:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: -mxbcxdoqukvy
            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/ToolingSearch'
                - examples:
                  - searchRecords:
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA
                      Name: LightningSelfRegisterController
                    - attributes:
                        type: ApexClass
                        url: /services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA
                      Name: LightningSelfRegisterControllerTest
       

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