Skip to main content
Completely describes the individual metadata at all levels for the specified object. For example, this can be used to retrieve the fields, URLs, and child relationships for the Account object. For more information about the metadata that is retrieved, see DescribesObjectResult in the SOAP API Developers Guide.
External DocumentationTo learn more, visit the Salesforce documentation.

​
Basic Parameters

ParameterDescription
Object NameThe name of the object.

For example: Account.

​
Advanced Parameters

ParameterDescription
If Modified SinceAn optional parameter specifying a date and time.
The request returns records that have been modified after the specified date and time.
If Unmodified SinceAn optional parameter specifying a date and time.
The request returns records that have been modified after the specified date and time.

​
Example Output

{
	"actionOverrides": [],
	"activateable": false,
	"associateEntityType": null,
	"associateParentEntity": null,
	"childRelationships": [
		{
			"cascadeDelete": true,
			"childSObject": "<string>",
			"deprecatedAndHidden": false,
			"field": "<string>",
			"junctionIdListNames": [],
			"junctionReferenceTo": [],
			"relationshipName": null,
			"restrictedDelete": false
		},
		{
			"cascadeDelete": false,
			"childSObject": "<string>",
			"deprecatedAndHidden": false,
			"field": "<string>",
			"junctionIdListNames": [],
			"junctionReferenceTo": [],
			"relationshipName": null,
			"restrictedDelete": false
		}
	],
	"compactLayoutable": true,
	"createable": true,
	"custom": false,
	"customSetting": false,
	"deepCloneable": false,
	"defaultImplementation": null,
	"deletable": true,
	"deprecatedAndHidden": false,
	"extendedBy": null,
	"extendsInterfaces": null,
	"feedEnabled": true,
	"fields": [
		{
			"aggregatable": true,
			"aiPredictionField": false,
			"autoNumber": false,
			"byteLength": 16,
			"calculated": false,
			"calculatedFormula": null,
			"cascadeDelete": false,
			"caseSensitive": false,
			"compoundFieldName": null,
			"controllerName": null,
			"createable": false,
			"custom": false,
			"defaultValue": null,
			"defaultValueFormula": null,
			"defaultedOnCreate": true,
			"dependentPicklist": false,
			"deprecatedAndHidden": false,
			"digits": 2,
			"displayLocationInDecimal": false,
			"encrypted": false,
			"externalId": false,
			"extraTypeInfo": null,
			"filterable": true,
			"filteredLookupInfo": null,
			"formulaTreatNullNumberAsZero": false,
			"groupable": true,
			"highScaleNumber": false,
			"htmlFormatted": false,
			"idLookup": true,
			"inlineHelpText": null,
			"label": "<string>",
			"length": 7,
			"mask": null,
			"maskType": null,
			"name": "<string>",
			"nameField": false,
			"namePointing": false,
			"nillable": false,
			"permissionable": false,
			"picklistValues": [],
			"polymorphicForeignKey": false,
			"precision": 1,
			"queryByDistance": false,
			"referenceTargetField": null,
			"referenceTo": [],
			"relationshipName": null,
			"relationshipOrder": null,
			"restrictedDelete": false,
			"restrictedPicklist": false,
			"scale": 1,
			"searchPrefilterable": false,
			"soapType": "<string>",
			"sortable": true,
			"type": "<string>",
			"unique": false,
			"updateable": false,
			"writeRequiresMasterRead": false
		},
		{
			"aggregatable": false,
			"aiPredictionField": false,
			"autoNumber": false,
			"byteLength": 0,
			"calculated": false,
			"calculatedFormula": null,
			"cascadeDelete": false,
			"caseSensitive": false,
			"compoundFieldName": null,
			"controllerName": null,
			"createable": false,
			"custom": false,
			"defaultValue": false,
			"defaultValueFormula": null,
			"defaultedOnCreate": true,
			"dependentPicklist": false,
			"deprecatedAndHidden": false,
			"digits": 1,
			"displayLocationInDecimal": false,
			"encrypted": false,
			"externalId": false,
			"extraTypeInfo": null,
			"filterable": true,
			"filteredLookupInfo": null,
			"formulaTreatNullNumberAsZero": false,
			"groupable": true,
			"highScaleNumber": false,
			"htmlFormatted": false,
			"idLookup": false,
			"inlineHelpText": null,
			"label": "<string>",
			"length": 2,
			"mask": null,
			"maskType": null,
			"name": "<string>",
			"nameField": false,
			"namePointing": false,
			"nillable": false,
			"permissionable": false,
			"picklistValues": [],
			"polymorphicForeignKey": false,
			"precision": 0,
			"queryByDistance": false,
			"referenceTargetField": null,
			"referenceTo": [],
			"relationshipName": null,
			"relationshipOrder": null,
			"restrictedDelete": false,
			"restrictedPicklist": false,
			"scale": 1,
			"searchPrefilterable": false,
			"soapType": "<string>",
			"sortable": true,
			"type": "<string>",
			"unique": false,
			"updateable": false,
			"writeRequiresMasterRead": false
		}
	],
	"hasSubtypes": false,
	"implementedBy": null,
	"implementsInterfaces": null,
	"isInterface": false,
	"isSubtype": false,
	"keyPrefix": "<string>",
	"label": "<string>",
	"labelPlural": "<string>",
	"layoutable": true,
	"listviewable": null,
	"lookupLayoutable": null,
	"mergeable": true,
	"mruEnabled": true,
	"name": "<string>",
	"namedLayoutInfos": [],
	"networkScopeFieldName": null,
	"queryable": true,
	"recordTypeInfos": [
		{
			"active": true,
			"available": true,
			"defaultRecordTypeMapping": true,
			"developerName": "<string>",
			"master": true,
			"name": "<string>",
			"recordTypeId": "<string>",
			"urls": {
				"layout": "<string>"
			}
		}
	],
	"replicateable": true,
	"retrieveable": true,
	"searchLayoutable": true,
	"searchable": true,
	"sobjectDescribeOption": "<string>",
	"supportedScopes": [
		{
			"label": "<string>",
			"name": "<string>"
		},
		{
			"label": "<string>",
			"name": "<string>"
		}
	],
	"triggerable": true,
	"undeletable": true,
	"updateable": true,
	"urls": {
		"compactLayouts": "<string>",
		"rowTemplate": "2025-04-02T05:15:19.000+0000",
		"approvalLayouts": "<string>",
		"uiDetailTemplate": "2025-04-02T05:15:19.000+0000",
		"uiEditTemplate": "2025-04-02T05:15:19.000+0000",
		"listviews": "<string>",
		"describe": "<string>",
		"uiNewRecord": "<string>",
		"quickActions": "<string>",
		"layouts": "<string>",
		"sobject": "<string>"
	}
}

​
Workflow Library Example

Describe Object with Salesforce and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop