Salesforce · Schema
GetObjectMetadata
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales
Properties
| Name | Type | Description |
|---|---|---|
| apiName | string | |
| associateEntityType | ['string', 'null'] | |
| associateParentEntity | ['string', 'null'] | |
| childRelationships | array | |
| createable | boolean | |
| custom | boolean | |
| defaultRecordTypeId | string | |
| deletable | boolean | |
| dependentFields | object | |
| eTag | string | |
| feedEnabled | boolean | |
| fields | object | |
| keyPrefix | string | |
| label | string | |
| labelPlural | string | |
| layoutable | boolean | |
| mruEnabled | boolean | |
| nameFields | array | |
| queryable | boolean | |
| recordTypeInfos | object | |
| searchable | boolean | |
| themeInfo | object | |
| updateable | boolean |
JSON Schema
{
"type": "object",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"associateEntityType": {
"type": "['string', 'null']",
"example": "example_value"
},
"associateParentEntity": {
"type": "['string', 'null']",
"example": "example_value"
},
"childRelationships": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "object",
"properties": {
"childObjectApiName": {
"type": "string",
"example": "example_value"
},
"fieldName": {
"type": "string",
"example": "example_value"
},
"junctionIdListNames": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"junctionReferenceTo": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "string",
"example": "example_value"
}
},
"required": [
"childObjectApiName",
"fieldName",
"junctionIdListNames",
"junctionReferenceTo",
"relationshipName"
]
}
},
"createable": {
"type": "boolean",
"example": true
},
"custom": {
"type": "boolean",
"example": true
},
"defaultRecordTypeId": {
"type": "string",
"example": "500123"
},
"deletable": {
"type": "boolean",
"example": true
},
"dependentFields": {
"type": "object",
"example": "example_value"
},
"eTag": {
"type": "string",
"example": "example_value"
},
"feedEnabled": {
"type": "boolean",
"example": true
},
"fields": {
"type": "object",
"properties": {
"AccountNumber": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"calculated": {
"type": "boolean",
"example": true
},
"compound": {
"type": "boolean",
"example": true
},
"compoundComponentName": {
"type": "['string', 'null']",
"example": "example_value"
},
"compoundFieldName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllerName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllingFields": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"createable": {
"type": "boolean",
"example": true
},
"custom": {
"type": "boolean",
"example": true
},
"dataType": {
"type": "string",
"example": "example_value"
},
"extraTypeInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"filterable": {
"type": "boolean",
"example": true
},
"filteredLookupInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"highScaleNumber": {
"type": "boolean",
"example": true
},
"htmlFormatted": {
"type": "boolean",
"example": true
},
"inlineHelpText": {
"type": "['string', 'null']",
"example": "example_value"
},
"label": {
"type": "string",
"example": "Example Title"
},
"length": {
"type": "integer",
"example": 10
},
"nameField": {
"type": "boolean",
"example": true
},
"polymorphicForeignKey": {
"type": "boolean",
"example": true
},
"precision": {
"type": "integer",
"example": 10
},
"reference": {
"type": "boolean",
"example": true
},
"referenceTargetField": {
"type": "['string', 'null']",
"example": "example_value"
},
"referenceToInfos": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "['string', 'null']",
"example": "example_value"
},
"required": {
"type": "boolean",
"example": true
},
"scale": {
"type": "integer",
"example": 10
},
"searchPrefilterable": {
"type": "boolean",
"example": true
},
"sortable": {
"type": "boolean",
"example": true
},
"unique": {
"type": "boolean",
"example": true
},
"updateable": {
"type": "boolean",
"example": true
}
},
"required": [
"apiName",
"calculated",
"compound",
"compoundComponentName",
"compoundFieldName",
"controllerName",
"controllingFields",
"createable",
"custom",
"dataType",
"extraTypeInfo",
"filterable",
"filteredLookupInfo",
"highScaleNumber",
"htmlFormatted",
"inlineHelpText",
"label",
"length",
"nameField",
"polymorphicForeignKey",
"precision",
"reference",
"referenceTargetField",
"referenceToInfos",
"relationshipName",
"required",
"scale",
"searchPrefilterable",
"sortable",
"unique",
"updateable"
]
},
"AccountSource": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"calculated": {
"type": "boolean",
"example": true
},
"compound": {
"type": "boolean",
"example": true
},
"compoundComponentName": {
"type": "['string', 'null']",
"example": "example_value"
},
"compoundFieldName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllerName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllingFields": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"createable": {
"type": "boolean",
"example": true
},
"custom": {
"type": "boolean",
"example": true
},
"dataType": {
"type": "string",
"example": "example_value"
},
"extraTypeInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"filterable": {
"type": "boolean",
"example": true
},
"filteredLookupInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"highScaleNumber": {
"type": "boolean",
"example": true
},
"htmlFormatted": {
"type": "boolean",
"example": true
},
"inlineHelpText": {
"type": "['string', 'null']",
"example": "example_value"
},
"label": {
"type": "string",
"example": "Example Title"
},
"length": {
"type": "integer",
"example": 10
},
"nameField": {
"type": "boolean",
"example": true
},
"polymorphicForeignKey": {
"type": "boolean",
"example": true
},
"precision": {
"type": "integer",
"example": 10
},
"reference": {
"type": "boolean",
"example": true
},
"referenceTargetField": {
"type": "['string', 'null']",
"example": "example_value"
},
"referenceToInfos": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "['string', 'null']",
"example": "example_value"
},
"required": {
"type": "boolean",
"example": true
},
"scale": {
"type": "integer",
"example": 10
},
"searchPrefilterable": {
"type": "boolean",
"example": true
},
"sortable": {
"type": "boolean",
"example": true
},
"unique": {
"type": "boolean",
"example": true
},
"updateable": {
"type": "boolean",
"example": true
}
},
"required": [
"apiName",
"calculated",
"compound",
"compoundComponentName",
"compoundFieldName",
"controllerName",
"controllingFields",
"createable",
"custom",
"dataType",
"extraTypeInfo",
"filterable",
"filteredLookupInfo",
"highScaleNumber",
"htmlFormatted",
"inlineHelpText",
"label",
"length",
"nameField",
"polymorphicForeignKey",
"precision",
"reference",
"referenceTargetField",
"referenceToInfos",
"relationshipName",
"required",
"scale",
"searchPrefilterable",
"sortable",
"unique",
"updateable"
]
},
"Active__c": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"calculated": {
"type": "boolean",
"example": true
},
"compound": {
"type": "boolean",
"example": true
},
"compoundComponentName": {
"type": "['string', 'null']",
"example": "example_value"
},
"compoundFieldName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllerName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllingFields": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"createable": {
"type": "boolean",
"example": true
},
"custom": {
"type": "boolean",
"example": true
},
"dataType": {
"type": "string",
"example": "example_value"
},
"extraTypeInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"filterable": {
"type": "boolean",
"example": true
},
"filteredLookupInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"highScaleNumber": {
"type": "boolean",
"example": true
},
"htmlFormatted": {
"type": "boolean",
"example": true
},
"inlineHelpText": {
"type": "['string', 'null']",
"example": "example_value"
},
"label": {
"type": "string",
"example": "Example Title"
},
"length": {
"type": "integer",
"example": 10
},
"nameField": {
"type": "boolean",
"example": true
},
"polymorphicForeignKey": {
"type": "boolean",
"example": true
},
"precision": {
"type": "integer",
"example": 10
},
"reference": {
"type": "boolean",
"example": true
},
"referenceTargetField": {
"type": "['string', 'null']",
"example": "example_value"
},
"referenceToInfos": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "['string', 'null']",
"example": "example_value"
},
"required": {
"type": "boolean",
"example": true
},
"scale": {
"type": "integer",
"example": 10
},
"searchPrefilterable": {
"type": "boolean",
"example": true
},
"sortable": {
"type": "boolean",
"example": true
},
"unique": {
"type": "boolean",
"example": true
},
"updateable": {
"type": "boolean",
"example": true
}
},
"required": [
"apiName",
"calculated",
"compound",
"compoundComponentName",
"compoundFieldName",
"controllerName",
"controllingFields",
"createable",
"custom",
"dataType",
"extraTypeInfo",
"filterable",
"filteredLookupInfo",
"highScaleNumber",
"htmlFormatted",
"inlineHelpText",
"label",
"length",
"nameField",
"polymorphicForeignKey",
"precision",
"reference",
"referenceTargetField",
"referenceToInfos",
"relationshipName",
"required",
"scale",
"searchPrefilterable",
"sortable",
"unique",
"updateable"
]
},
"AnnualRevenue": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"calculated": {
"type": "boolean",
"example": true
},
"compound": {
"type": "boolean",
"example": true
},
"compoundComponentName": {
"type": "['string', 'null']",
"example": "example_value"
},
"compoundFieldName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllerName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllingFields": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"createable": {
"type": "boolean",
"example": true
},
"custom": {
"type": "boolean",
"example": true
},
"dataType": {
"type": "string",
"example": "example_value"
},
"extraTypeInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"filterable": {
"type": "boolean",
"example": true
},
"filteredLookupInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"highScaleNumber": {
"type": "boolean",
"example": true
},
"htmlFormatted": {
"type": "boolean",
"example": true
},
"inlineHelpText": {
"type": "['string', 'null']",
"example": "example_value"
},
"label": {
"type": "string",
"example": "Example Title"
},
"length": {
"type": "integer",
"example": 10
},
"nameField": {
"type": "boolean",
"example": true
},
"polymorphicForeignKey": {
"type": "boolean",
"example": true
},
"precision": {
"type": "integer",
"example": 10
},
"reference": {
"type": "boolean",
"example": true
},
"referenceTargetField": {
"type": "['string', 'null']",
"example": "example_value"
},
"referenceToInfos": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "['string', 'null']",
"example": "example_value"
},
"required": {
"type": "boolean",
"example": true
},
"scale": {
"type": "integer",
"example": 10
},
"searchPrefilterable": {
"type": "boolean",
"example": true
},
"sortable": {
"type": "boolean",
"example": true
},
"unique": {
"type": "boolean",
"example": true
},
"updateable": {
"type": "boolean",
"example": true
}
},
"required": [
"apiName",
"calculated",
"compound",
"compoundComponentName",
"compoundFieldName",
"controllerName",
"controllingFields",
"createable",
"custom",
"dataType",
"extraTypeInfo",
"filterable",
"filteredLookupInfo",
"highScaleNumber",
"htmlFormatted",
"inlineHelpText",
"label",
"length",
"nameField",
"polymorphicForeignKey",
"precision",
"reference",
"referenceTargetField",
"referenceToInfos",
"relationshipName",
"required",
"scale",
"searchPrefilterable",
"sortable",
"unique",
"updateable"
]
},
"BillingAddress": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"calculated": {
"type": "boolean",
"example": true
},
"compound": {
"type": "boolean",
"example": true
},
"compoundComponentName": {
"type": "['string', 'null']",
"example": "example_value"
},
"compoundFieldName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllerName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllingFields": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"createable": {
"type": "boolean",
"example": true
},
"custom": {
"type": "boolean",
"example": true
},
"dataType": {
"type": "string",
"example": "example_value"
},
"extraTypeInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"filterable": {
"type": "boolean",
"example": true
},
"filteredLookupInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"highScaleNumber": {
"type": "boolean",
"example": true
},
"htmlFormatted": {
"type": "boolean",
"example": true
},
"inlineHelpText": {
"type": "['string', 'null']",
"example": "example_value"
},
"label": {
"type": "string",
"example": "Example Title"
},
"length": {
"type": "integer",
"example": 10
},
"nameField": {
"type": "boolean",
"example": true
},
"polymorphicForeignKey": {
"type": "boolean",
"example": true
},
"precision": {
"type": "integer",
"example": 10
},
"reference": {
"type": "boolean",
"example": true
},
"referenceTargetField": {
"type": "['string', 'null']",
"example": "example_value"
},
"referenceToInfos": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "['string', 'null']",
"example": "example_value"
},
"required": {
"type": "boolean",
"example": true
},
"scale": {
"type": "integer",
"example": 10
},
"searchPrefilterable": {
"type": "boolean",
"example": true
},
"sortable": {
"type": "boolean",
"example": true
},
"unique": {
"type": "boolean",
"example": true
},
"updateable": {
"type": "boolean",
"example": true
}
},
"required": [
"apiName",
"calculated",
"compound",
"compoundComponentName",
"compoundFieldName",
"controllerName",
"controllingFields",
"createable",
"custom",
"dataType",
"extraTypeInfo",
"filterable",
"filteredLookupInfo",
"highScaleNumber",
"htmlFormatted",
"inlineHelpText",
"label",
"length",
"nameField",
"polymorphicForeignKey",
"precision",
"reference",
"referenceTargetField",
"referenceToInfos",
"relationshipName",
"required",
"scale",
"searchPrefilterable",
"sortable",
"unique",
"updateable"
]
},
"BillingCity": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"calculated": {
"type": "boolean",
"example": true
},
"compound": {
"type": "boolean",
"example": true
},
"compoundComponentName": {
"type": "string",
"example": "example_value"
},
"compoundFieldName": {
"type": "string",
"example": "example_value"
},
"controllerName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllingFields": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"createable": {
"type": "boolean",
"example": true
},
"custom": {
"type": "boolean",
"example": true
},
"dataType": {
"type": "string",
"example": "example_value"
},
"extraTypeInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"filterable": {
"type": "boolean",
"example": true
},
"filteredLookupInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"highScaleNumber": {
"type": "boolean",
"example": true
},
"htmlFormatted": {
"type": "boolean",
"example": true
},
"inlineHelpText": {
"type": "['string', 'null']",
"example": "example_value"
},
"label": {
"type": "string",
"example": "Example Title"
},
"length": {
"type": "integer",
"example": 10
},
"nameField": {
"type": "boolean",
"example": true
},
"polymorphicForeignKey": {
"type": "boolean",
"example": true
},
"precision": {
"type": "integer",
"example": 10
},
"reference": {
"type": "boolean",
"example": true
},
"referenceTargetField": {
"type": "['string', 'null']",
"example": "example_value"
},
"referenceToInfos": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"relationshipName": {
"type": "['string', 'null']",
"example": "example_value"
},
"required": {
"type": "boolean",
"example": true
},
"scale": {
"type": "integer",
"example": 10
},
"searchPrefilterable": {
"type": "boolean",
"example": true
},
"sortable": {
"type": "boolean",
"example": true
},
"unique": {
"type": "boolean",
"example": true
},
"updateable": {
"type": "boolean",
"example": true
}
},
"required": [
"apiName",
"calculated",
"compound",
"compoundComponentName",
"compoundFieldName",
"controllerName",
"controllingFields",
"createable",
"custom",
"dataType",
"extraTypeInfo",
"filterable",
"filteredLookupInfo",
"highScaleNumber",
"htmlFormatted",
"inlineHelpText",
"label",
"length",
"nameField",
"polymorphicForeignKey",
"precision",
"reference",
"referenceTargetField",
"referenceToInfos",
"relationshipName",
"required",
"scale",
"searchPrefilterable",
"sortable",
"unique",
"updateable"
]
},
"BillingCountry": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"example": "example_value"
},
"calculated": {
"type": "boolean",
"example": true
},
"compound": {
"type": "boolean",
"example": true
},
"compoundComponentName": {
"type": "string",
"example": "example_value"
},
"compoundFieldName": {
"type": "string",
"example": "example_value"
},
"controllerName": {
"type": "['string', 'null']",
"example": "example_value"
},
"controllingFields": {
"type": "array",
"description": "",
"example": [],
"items": {
"type": "string"
}
},
"createable": {
"type": "boolean",
"example": true
},
"custom": {
"type": "boolean",
"example": true
},
"dataType": {
"type": "string",
"example": "example_value"
},
"extraTypeInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"filterable": {
"type": "boolean",
"example": true
},
"filteredLookupInfo": {
"type": "['string', 'null']",
"example": "example_value"
},
"highScaleNumber": {
"type": "boolean",
"example": true
},
"htmlFormatted": {
"type": "boolean",
"example": true
},
"inlineHelpText": {
"type": "['string', 'null']",
"example": "example_value"
},
"label": {
"type": "string",
"example": "Example Title"
},
"length": {
"type": "inte
# --- truncated at 32 KB (334 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-get-object-metadata-schema.json