Salesforce Metadata icon

Salesforce Metadata

Interact with Salesforce metadata APIs

Overview

This node interacts with Salesforce metadata APIs to fetch various metadata information and organizational data. It supports operations like listing available Salesforce objects, describing specific objects, listing metadata components, executing Tooling API queries, and fetching current org limits and available API versions. This node is useful for Salesforce administrators and developers who need to automate metadata retrieval, inspect Salesforce objects, or monitor org limits programmatically. For example, it can be used to get a list of all custom and standard objects in an org, describe the fields of a specific object, or retrieve the current API limits and versions available in the Salesforce org.

Use Case Examples

  1. Fetch all standard and custom objects in a Salesforce org to understand the data model.
  2. Describe a specific Salesforce object to get details about its fields and properties.
  3. List metadata components like Apex classes or custom objects for deployment or analysis.
  4. Execute a Tooling API query to retrieve metadata or configuration data using SOQL queries.

Properties

Name Meaning
Authentication Method used to authenticate with Salesforce, either OAuth2 or JWT Bearer.
API Version Salesforce API version to use for requests, e.g., v59.0, or 'auto' to detect the latest version automatically.
Raw Response Whether to return the raw Salesforce API response or a cleaned, simplified output.

Output

JSON

  • limits - Current Salesforce org limits such as API usage limits.
  • apiVersions - List of available Salesforce API versions for the org.

Dependencies

  • Salesforce API with OAuth2 or JWT authentication

Troubleshooting

  • Ensure the Salesforce credentials (OAuth2 or JWT) are correctly configured and have sufficient permissions to access metadata APIs.
  • If the API version is set incorrectly or not supported, the node may fail; use 'auto' to automatically detect the latest version.
  • When using the 'Raw Response' option, the output format may differ from the cleaned output, so downstream nodes should handle the raw structure accordingly.
  • Common errors include missing required parameters like SObject API name for describe operations or selecting at least one metadata type for listing metadata.

Discussion