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

Newer Version Available

This content describes an older version of this product. View Latest

Quick Start: Metadata API

Get started with Metadata API by retrieving a small set of metadata components from your org on the Salesforce CLI.

Resources for Beginner Developers

If you’re a beginner developer and haven’t used Salesforce CLI before, learn how to set up your environment and practice with a sample application. These Trailheads guide you through setup with SFDX and introduce you to Metadata API.

App Development with Salesforce DX

Walk through setting up your environment and developing with Salesforce CLI using the Dreamhouse sample app. After you add a feature to your Dreamhouse app, you deploy metadata to your Dev Hub org with Salesforce CLI.

Package.xml Metadata Management

Learn more about metadata and package.xml files. Build a package.xml file to deploy changes from a scratch org to your Trailhead Playground.

Quick Start for Developing with Metadata API

If you have some experience in Salesforce development but want to get started with Metadata API, use this quick start. The quick start walks you through a retrieval of metadata components, which is the first step of the development process.