Skip to main content

getSalesforceObjectDescription

Describe a Salesforce object's field metadata (labels, types, picklist values) from the workspace's connected org. Returns null when Salesforce is not connected, and a zero-field payload whose label carries an error message when the describe call fails.

getSalesforceObjectDescription(
input: getSalesforceObjectDescriptionInput!
): getSalesforceObjectDescriptionPayload

Arguments

getSalesforceObjectDescription.input ● getSalesforceObjectDescriptionInput! non-null input

The Salesforce object to describe.

Type

getSalesforceObjectDescriptionPayload object

The described Salesforce object and its field metadata.