Salesforce Metadata icon

Salesforce Metadata

Interact with Salesforce metadata APIs

Actions5

Metadata → Describe Global

AI-generated

Overview

This node interacts with Salesforce metadata APIs to retrieve and describe metadata information about Salesforce objects and components. It supports operations like listing all available Salesforce objects (describeGlobal), describing a single Salesforce object, listing metadata components, executing Tooling API queries, and fetching org limits and API versions. This node is useful for Salesforce administrators and developers who need to explore or manage Salesforce metadata programmatically within an n8n workflow.

Use Case Examples

  1. Listing all Salesforce objects available in an org, filtering by standard or custom objects, and optionally filtering by searchable or creatable objects.
  2. Describing the details of a specific Salesforce object, including its fields and properties.
  3. Listing metadata components of specified types from the Salesforce Metadata API.
  4. Executing a SOQL query using the Tooling API to retrieve metadata-related records or configurations.

Properties

Name Meaning
Authentication Method of authentication to connect to Salesforce, either OAuth2 or JWT Bearer.
API Version Salesforce API version to use for the requests, e.g., v59.0, or 'auto' to detect the latest version automatically.
Include Standard Objects Whether to include standard Salesforce objects in the describeGlobal operation.
Include Custom Objects Whether to include custom Salesforce objects in the describeGlobal operation.
Searchable Only Filter to return only objects that can be searched in the describeGlobal operation.
Creatable Only Filter to return only objects that can be created via the API in the describeGlobal operation.
Raw Response Return the raw Salesforce API response instead of a cleaned and simplified output.

Output

JSON

  • name - API name of the Salesforce object or metadata component.
  • label - Label or display name of the object or component.
  • custom - Boolean indicating if the object is custom.
  • searchable - Boolean indicating if the object is searchable.
  • createable - Boolean indicating if the object can be created via the API.
  • queryable - Boolean indicating if the object can be queried.
  • updateable - Boolean indicating if the object can be updated.
  • keyPrefix - Key prefix of the object, if applicable.
  • urls - URLs related to the object for API access.
  • fields - Array of field definitions for a described Salesforce object, including field name, label, type, and permissions.
  • recordTypeInfos - Information about record types for the described Salesforce object.
  • limits - Current Salesforce org limits when fetching limits operation.
  • apiVersions - Available Salesforce API versions when fetching API versions operation.

Dependencies

  • Salesforce API (OAuth2 or JWT authentication)

Troubleshooting

  • Ensure correct Salesforce credentials are configured for OAuth2 or JWT authentication.
  • Verify the API version format is correct (e.g., v59.0) or use 'auto' to detect the latest version.
  • If the node returns an error about missing SObject API name, ensure the 'SObject API Name' property is set when using the describeSObject operation.
  • If the node fails with API errors, check Salesforce org permissions and API access rights.
  • Use the 'Raw Response' option to debug and see the full Salesforce API response for troubleshooting.

Links

Discussion