Salesforce · JSON Structure

Salesforce Rest S Object Describe Structure

Metadata describing a Salesforce SObject type, including its fields, relationships, and capabilities.

Type: object Properties: 11
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

SObjectDescribe is a JSON Structure definition published by Salesforce, describing 11 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

name label labelPlural keyPrefix queryable searchable createable updateable deletable fields urls

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

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "Metadata describing a Salesforce SObject type, including its fields, relationships, and capabilities.\n",
  "name": "SObjectDescribe",
  "properties": {
    "name": {
      "type": "string",
      "description": "The API name of the SObject type."
    },
    "label": {
      "type": "string",
      "description": "The user-facing singular label for this object type."
    },
    "labelPlural": {
      "type": "string",
      "description": "The user-facing plural label for this object type."
    },
    "keyPrefix": {
      "type": "string",
      "description": "The three-character key prefix used in record IDs for this type."
    },
    "queryable": {
      "type": "boolean",
      "description": "Whether records of this type can be queried with SOQL."
    },
    "searchable": {
      "type": "boolean",
      "description": "Whether records of this type can be searched with SOSL."
    },
    "createable": {
      "type": "boolean",
      "description": "Whether new records of this type can be created via the API."
    },
    "updateable": {
      "type": "boolean",
      "description": "Whether existing records of this type can be updated via the API."
    },
    "deletable": {
      "type": "boolean",
      "description": "Whether records of this type can be deleted via the API."
    },
    "fields": {
      "type": "array",
      "description": "Detailed metadata for each field on this SObject type.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The API name of the field."
          },
          "label": {
            "type": "string",
            "description": "The user-facing label for this field."
          },
          "type": {
            "type": "string",
            "description": "The data type of the field (e.g., string, boolean, date, reference, picklist).\n"
          },
          "nillable": {
            "type": "boolean",
            "description": "Whether this field can be set to null."
          },
          "updateable": {
            "type": "boolean",
            "description": "Whether this field can be updated via the API."
          },
          "createable": {
            "type": "boolean",
            "description": "Whether this field can be set when creating a record."
          },
          "length": {
            "type": "integer",
            "description": "Maximum character length for string fields. Zero for non-string fields.\n"
          }
        }
      }
    },
    "urls": {
      "type": "object",
      "description": "Map of REST endpoint URLs for this SObject type."
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}