Salesforce · JSON Structure

Salesforce Rest Query Result Structure

The result of a SOQL query, containing the matching records and pagination metadata.

Type: object Properties: 4 Required: 3
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

QueryResult is a JSON Structure definition published by Salesforce, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

totalSize done nextRecordsUrl records

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "The result of a SOQL query, containing the matching records and pagination metadata.\n",
  "name": "QueryResult",
  "properties": {
    "totalSize": {
      "type": "integer",
      "description": "The total number of records matching the query. May be larger than the number of records in the current page if the result is paginated.\n"
    },
    "done": {
      "type": "boolean",
      "description": "Whether all query results have been returned. If false, use nextRecordsUrl to retrieve the next page.\n"
    },
    "nextRecordsUrl": {
      "type": "uri",
      "description": "URL to retrieve the next page of results. Only present when done is false.\n"
    },
    "records": {
      "type": "array",
      "description": "Array of SObject records matching the query. May be a partial result if the total exceeds the page size.\n",
      "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",
            "properties": {
              "type": {
                "type": "string",
                "description": "The API name of the SObject type (e.g., Account, Contact)."
              },
              "url": {
                "type": "uri",
                "description": "The REST API URL for this specific record."
              }
            },
            "required": [
              "type"
            ]
          },
          "Id": {
            "type": "string",
            "description": "The 18-character globally unique Salesforce record ID."
          }
        },
        "required": [
          "attributes"
        ]
      }
    }
  },
  "required": [
    "totalSize",
    "done",
    "records"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}