Salesforce · Schema

SearchResult

The result of a SOSL search, containing matching records grouped by SObject type.

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
searchRecords array Array of records matching the SOSL search query. Each record includes the object type in its attributes.
View JSON Schema on GitHub

JSON Schema

salesforce-rest-search-result-schema.json Raw ↑
{
  "type": "object",
  "description": "The result of a SOSL search, containing matching records grouped by SObject type.\n",
  "properties": {
    "searchRecords": {
      "type": "array",
      "description": "Array of records matching the SOSL search query. Each record includes the object type in its attributes.\n",
      "example": [],
      "items": {
        "type": "object",
        "description": "A Salesforce SObject record. Contains an attributes object describing the record type and URL, plus any number of field name/value pairs depending on the object type.\n",
        "properties": {
          "attributes": {
            "type": "object",
            "description": "Metadata attributes for this SObject record, including its type and REST API URL.\n",
            "example": "example_value",
            "properties": {
              "type": {
                "type": "string",
                "description": "The API name of the SObject type (e.g., Account, Contact)."
              },
              "url": {
                "type": "string",
                "description": "The REST API URL for this specific record.",
                "format": "uri"
              }
            },
            "required": [
              "type"
            ]
          },
          "Id": {
            "type": "string",
            "description": "The 18-character globally unique Salesforce record ID.",
            "example": "abc123"
          }
        },
        "required": [
          "attributes"
        ]
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SearchResult"
}