Salesforce · Schema

SObjectDescribe

Metadata description of a Salesforce sObject type

CRMCloudSalesMarketingAutomationAIFortune 500

Properties

Name Type Description
name string API name of the sObject (e.g., Account)
label string User-facing label
labelPlural string Plural user-facing label
keyPrefix string 3-character prefix of the record ID
fields array Field metadata list
urls object REST endpoint URLs for this sObject
createable boolean
updateable boolean
deleteable boolean
queryable boolean
View JSON Schema on GitHub

JSON Schema

salesforcecom-sobjectdescribe-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SObjectDescribe",
  "title": "SObjectDescribe",
  "type": "object",
  "description": "Metadata description of a Salesforce sObject type",
  "properties": {
    "name": {
      "type": "string",
      "description": "API name of the sObject (e.g., Account)"
    },
    "label": {
      "type": "string",
      "description": "User-facing label"
    },
    "labelPlural": {
      "type": "string",
      "description": "Plural user-facing label"
    },
    "keyPrefix": {
      "type": "string",
      "description": "3-character prefix of the record ID"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Field metadata list"
    },
    "urls": {
      "type": "object",
      "description": "REST endpoint URLs for this sObject"
    },
    "createable": {
      "type": "boolean"
    },
    "updateable": {
      "type": "boolean"
    },
    "deleteable": {
      "type": "boolean"
    },
    "queryable": {
      "type": "boolean"
    }
  }
}