Salesforce · Schema

SObjectDescribe

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

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
name string The API name of the SObject type.
label string The user-facing singular label for this object type.
labelPlural string The user-facing plural label for this object type.
keyPrefix string The three-character key prefix used in record IDs for this type.
queryable boolean Whether records of this type can be queried with SOQL.
searchable boolean Whether records of this type can be searched with SOSL.
createable boolean Whether new records of this type can be created via the API.
updateable boolean Whether existing records of this type can be updated via the API.
deletable boolean Whether records of this type can be deleted via the API.
fields array Detailed metadata for each field on this SObject type.
urls object Map of REST endpoint URLs for this SObject type.
View JSON Schema on GitHub

JSON Schema

salesforce-rest-s-object-describe-schema.json Raw ↑
{
  "type": "object",
  "description": "Metadata describing a Salesforce SObject type, including its fields, relationships, and capabilities.\n",
  "properties": {
    "name": {
      "type": "string",
      "description": "The API name of the SObject type.",
      "example": "Example Title"
    },
    "label": {
      "type": "string",
      "description": "The user-facing singular label for this object type.",
      "example": "Example Title"
    },
    "labelPlural": {
      "type": "string",
      "description": "The user-facing plural label for this object type.",
      "example": "example_value"
    },
    "keyPrefix": {
      "type": "string",
      "description": "The three-character key prefix used in record IDs for this type.",
      "example": "example_value"
    },
    "queryable": {
      "type": "boolean",
      "description": "Whether records of this type can be queried with SOQL.",
      "example": true
    },
    "searchable": {
      "type": "boolean",
      "description": "Whether records of this type can be searched with SOSL.",
      "example": true
    },
    "createable": {
      "type": "boolean",
      "description": "Whether new records of this type can be created via the API.",
      "example": true
    },
    "updateable": {
      "type": "boolean",
      "description": "Whether existing records of this type can be updated via the API.",
      "example": true
    },
    "deletable": {
      "type": "boolean",
      "description": "Whether records of this type can be deleted via the API.",
      "example": true
    },
    "fields": {
      "type": "array",
      "description": "Detailed metadata for each field on this SObject type.",
      "example": [],
      "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.",
      "example": "https://www.example.com"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SObjectDescribe"
}