Metadata API Developer Guide

Introduction to Metadata API
Understanding Metadata API
Quick Start: Metadata API
Prerequisites
Step 1: (Optional) Add Metadata Components to an Org Using the UI
Step 2: Build a Package.xml Manifest
Step 3: Retrieve Components with Metadata API
Build Client Applications for Metadata API
Using Metadata API
Metadata API Context MCP Tool (Beta)
Reference
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Prerequisites

Complete these prerequisites before you start developing with Metadata API.
  • To access Metadata API through the command line, install Salesforce CLI.
  • To create a development environment, sign up for Salesforce Developer Edition. A Developer Edition org is a free development environment for building and testing solutions independent of production data.
  • Install Salesforce Extensions for Visual Studio Code. These tools provide features for working with development orgs (scratch orgs, sandboxes, and DE orgs), Apex, Aura components, and Visualforce.
  • Confirm that you have API Enabled permission and Modify Metadata Through Metadata API Functions permission or Modify All Data permission. If you don’t have these permissions set, modify your metadata permissions.
  • Enable Dev Hub in your org. Dev Hub allows you to create and manage scratch orgs so that you can develop without affecting your production data or metadata.
  • To allow access to protected resources such as production data and metadata, authorize your org .