The Salesforce metadata API

The Salesforce metadata API is used to retrieve, deploy, create, update or delete customization information, such as custom object definitions and page layouts, for Salesforce organizations.

Gearset supports anything in the metadata API

Gearset operates on top of the metadata API, so anything that is supported by the API can be retrieved and deployed with Gearset.

Supported metadata

The API supports the vast majority of Salesforce metadata, including:

  • Apex classes
  • Communities
  • Custom objects
  • Dashboards
  • Documents
  • Email templates
  • Flows
  • Layouts
  • Permission sets
  • Picklists
  • Profiles
  • Reports
  • Settings
  • Translations
  • Value sets
  • Workflows

There is a full list of the supported metadata here.

Unsupported metadata

While the majority of Salesforce metadata can be deployed using the API, there are a small number of metadata types which are not supported. Any changes to these metadata types must be recreated by hand in each org - they cannot be automatically deployed. 

While this may seem like a significant limitation, the good news is that the metadata types which are not supported by the API are rarely used and this is not a concern for the vast majority of users.

The full list is of unsupported metadata types is available here.

Did this answer your question?