Introducing Tooling API: Use Tooling API to build custom development tools or apps for Lightning Platform applications. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. Smaller retrieves improve performance, which makes Tooling API a better fit for developing interactive applications.Tooling API provides SOAP and REST interfaces.
Considerations for CRUD Operations in Active Orgs: CRUD operations on most Tooling API objects are allowed in active orgs in API version 41.0 and later, just as they are in other kinds of orgs. However, for performance reasons you can’t perform CRUD operations in an active org for some Tooling API objects.
REST Resources: REST resources give you access to Tooling API objects. When querying Tooling API objects using REST resources, keep in mind that the user permissions needed for access vary from endpoint to endpoint and from object to object. Check the description of the endpoint and object you want to use to determine user permission requirements for access.
Retrieve Apex Type Information with the Symbols Resource (Beta): Use the Apex Symbol API to retrieve detailed metadata for built-in, custom, packaged, and dynamic Apex types, including classes, interfaces, enums, methods, and triggers. Available in API version 68.0 and later. This resource requires the Author Apex org permission and the View Setup user permission.
Retrieve Compilation Results for Invalid Apex with the apexCompileResults
Resource: Retrieve compilation results for Apex classes and triggers with validation errors. Routinely monitoring results allows you to detect and respond to compilation issues.Available in API version 68.0 and later. This resource requires the Author Apex org permission.
REST Resources for Unit Testing: Retrieve and execute Apex and flow tests in one place. Get a complete view of your tests by using the Test Discovery API. Execute tests asynchronously or synchronously by using the Test Runner API. These APIs are both Tooling API REST resources.
Retrieve Unit Tests: The Test Discovery API returns details about Apex and automated flow tests. This resource is available in Tooling API version 65.0 and later.
Run Unit Tests Asynchronously: Use the Test Runner API to execute Apex and flow tests asynchronously. Available for Apex tests in API version 30.0 and later. Available for automated flow tests in API version 65.0 and later.
Run Unit Tests Synchronously: Use the Test Runner API to execute one or more Apex or flow tests synchronously. All test methods in a synchronous test run must be in the same class. Available for Apex tests in API version 30.0 and later. Available for automated flow tests in API version 65.0 and later. In API version 40.0 and later, running Apex tests synchronously using the POST method for /runTestsSynchronous/ requires the View Setup user permission.
When to Use Tooling API: Use Tooling API when you need fine-grained access to an org’s metadata. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. Smaller retrieves improve performance, which makes Tooling API a better fit for developing interactive applications.
Tooling API
Objects and Namespaces: Tooling API objects provide programmatic access to data and metadata. The Tooling API WSDL includes four namespaces.
Programming Objects: Use programming objects to interact with programmatic artifacts: Apex, Visualforce, and Lightning.
Setup Objects: Use setup objects to interact with metadata for declarative development. For example, you can create your own version of Setup, or restrict the amount of data required to push to an app to a mobile phone.
SOQL Operation Limitations: Some Tooling API objects have SOQL limitations. These limitations apply to any Metadata Catalog query, which applies to all Custom Metadata Types and Metadata Catalog entities, not only the ones explicitly listed.
SOSL Operation Limitations: Two Tooling API objects, EntityDefinition and FieldDefinition, have some SOSL limitations. ExternalString and MetadataComponentDependency (Beta) don’t support SOSL searches.
Tooling Objects: Use these objects to build tools around test results, debugging, code coverage, and more.
API End-of-Life Policy: See which Tooling REST and SOAP API versions are supported, unsupported, or unavailable.
ApiFault Element: An ApiFault element contains information about a fault that occurs when processing a service request.
AccountPlanObjMeasCalcCond: Represents a field and value combination for filtering records to include in the calculation of a sales account plan objective measure’s current value. This object is available in API version 63.0 and later.
AccountPlanObjMeasCalcDef: Represents the metadata associated with an account plan objective measure calculation definition. An account plan objective measure calculation definition contains a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure. This object is available in API version 63.0 and later.
ActivationPlatform: Represents metadata about ActivationPlatform, such as platform name, delivery schedule, output format, and destination folder. This object is available in API version 54.0 and later.
AdvAccountForecastSet: Represents an advanced account forecast set. This object is available in API version 56.0 and later.
AdvAcctForecastMeasureDef: Represents information about the measures to be displayed in the advanced account forecasts grid for the forecast set. This object is available in API version 57.0 and later.
AdvAcctFrcstDisplayGroup: Represents information about the groups for the advanced account forecast set measures or dimensions. This object is available in API version 57.0 and later.
AIApplication: Represents an instance of a machine learning (ML) application.Available in API version 50.0 and later.
AIApplicationConfig: Represents additional prediction information related to a machine learning (ML) application.Available in API version 50.0 and later.
AnimationRule: Represents criteria for determining when an animation is displayed to Path users. Available in API version 46.0 and later.
ApexClass: Represents the saved copy of an Apex class. ApexClass uses the cached version of the class unless one is unavailable. Available from API version 28.0 or later.
ApexClassMember: Represents the working copy of an Apex class for editing, saving, or compiling in a MetadataContainer.
ApexCodeCoverage: Represents code coverage test results for an Apex class or trigger. Available in Tooling API version 29.0 and later.
ApexCodeCoverageAggregate: Represents aggregate code coverage test results for an Apex class or trigger. Available in Tooling API version 29.0 and later.
ApexComponent: Represents the saved copy of a Visualforce component. ApexComponent uses the cached version of the class unless one is unavailable. Available from API version 28.0 or later.
ApexComponentMember: Represents the working copy of a Visualforce component for editing, saving, or compiling in a MetadataContainer.
ApexEmailNotification: Stores a Salesforce user ID or external email address to be notified when unhandled Apex exceptions occur. This object is available in API version 35.0 and later.
ApexExecutionOverlayAction: Specifies an Apex code snippet or SOQL query to execute at a specific line of code in an Apex class or trigger. Optionally, generates a heap dump.
ApexExecutionOverlayResult: Represents the result from the Apex code snippet or SOQL query defined in the associated ApexExecutionOverlayAction, and the resulting heap dump if one was returned. Available from API version 28.0 or later.
ApexOrgWideCoverage: Represents code coverage test results for an entire organization. Available in Tooling API version 29.0 and later.
ApexPage: Represents the saved copy of a Visualforce page. ApexPage uses the cached version of the page unless one is unavailable. Available from API version 28.0 or later.
ApexPageInfo: Represents metadata about a Visualforce page. This object is available in API version 37.0 and later.
ApexPageMember: Represents the working copy of a Visualforce page for editing, saving, or compiling in a MetadataContainer.
ApexResult: A complex type that represents the result of Apex code executed as part of an ApexExecutionOverlayAction , returned in an ApexExecutionOverlayResult. Available from API version 28.0 or later.
ApexTestQueueItem: Represents a single Apex class in the Apex job queue. Available in API version 30.0 and later.
ApexTestResult: Represents the result of an Apex test method execution. Available from API version 30.0 or later.
ApexTestResultLimits: Captures the Apex test limits used for a particular test method execution. An instance of this object is associated with each ApexTestResult object. Available from API version 37.0 or later.
ApexTestRunResult: Contains summary information about all the test methods that were run in a particular Apex job. Available from API version 37.0 or later.
ApexTestSuite: Represents a suite of Apex classes to include in a test run. A TestSuiteMembership object associates each class with the suite. Available in the ens namespace in Tooling API version 36.0 and later. Also, available in the mns namespace in Tooling API version 38.0 and later.
ApexTrigger: Represents the saved copy of an Apex trigger. ApexTrigger uses the cached version of the class unless one is unavailable. Available from API version 28.0 or later.
ApexTriggerMember: Represents the working copy of an Apex trigger for editing, saving, or compiling in a MetadataContainer.
AuraDefinition: Represents an Aura component definition, such as component markup, a client-side controller, or an event. Available in API version 32.0 and later.
AuraDefinitionBundle: Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources. Available in API version 32.0 and later.
AuthorizedEmailDomain: Represents an authorized domain for email verification. This object is available in API version 64.0 and later.
AutoResponseRule: Specifies whether the autoresponse rule is active (true).
BrandingSet: Represents a set of branding properties for an Experience Builder site, as defined in the Theme panel in Experience Builder. This object is available in API version 40.0 and later.
BrandingSetProperty: Represents a branding set property in the Theme panel in Experience Builder. This object is available in API version 40.0 and later.
BriefcaseDefinition: Represents a briefcase definition. A briefcase makes selected records available for users and groups to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android. This object is available in API version 50.0 and later.
BusinessProcessDefinition: Represents information about stages in a customer lifecycle map. This object is available in API version 51.0 and later.
BusinessProcessFeedback: Represents information about the survey and the question associated with each stage in a customer lifecycle map. This object is available in API version 51.0 and later.
BusinessProcessGroup: Represents information about the customer lifecycle maps. Customer lifecycle maps are used to track the scores provided by customers across their lifecycle using Salesforce Surveys. For example, the lifecycle stages for an Insurance business process group can include acquisition, onboarding, claims, routine services, and renewal. This object is available in API version 51.0 and later.
BusProcessFeedbackConfig: Represents information about the configuration for feedback collection. The feedback collection method triggers against pre-determined conditions on object to gather feedback. This object is available in API version 51.0 and later.
Certificate: Represents a certificate used for digital signatures that verify requests are coming from your org. Certificates are used for either authenticated single sign-on with an external website or when using your org as an identity provider. This object is available in Tooling API version 37.0 and later.
CleanDataService: Represents a data service that adds and updates data in existing records in an org.
CleanRule: Represents a data integration rule that controls how a data service adds and updates data for existing records in an org.
ColorDefinition: Represents color metadata for a tab. Available in API version 43.0 and later.
CommunityWorkspacesNode: Represents a node used in Experience Workspaces. Available in Tooling API version 39.0 and later.
CompactLayout: Represents the values that define a compact page layout.
CompactLayoutInfo: Represents the metadata for a custom or standard compact layout.
CompactLayoutItemInfo: Represents a field selected for a compact layout, and the order of that field in the compact layout.
ContactCenterChannel: Represents a junction object that relates a Bring Your Own Channel for Contact Center as a Service (CCaaS) messaging channel to a CallCenter object for Bring Your Own Channel for CCaaS. This object also represents the routing details for a voicemail configuration. This object is available in API version 56.0 and later.
ContainerAsyncRequest: Allows you to compile and asynchronously deploy a MetadataContainer object to your organization.
ConversationChannelDefinition: Represents a configurable definition of a conversation channel that’s implemented for Interaction Service for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS messaging channels. This object is available in API version 60.0 and later.
ConversationVendorInfo: This setup object connects the partner vendor system to the Service Cloud feature. For example, for Service Cloud Voice, this object contains information about the partner telephony or Contact Center as a Service (CCaaS) partner system. For Bring Your Own Channel for Messaging this object contains information about the partner messaging system, and for Bring Your Own Channel for CCaaS, this object contains information about the CCaaS partner system. This object is available in API version 52.0 and later.
CspTrustedSite: Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later.
CustomApplication: Represents a custom or standard application. An application is a list of tab references, a description, and a logo. It also includes access to the associated CustomApplication type and related fields in Metadata API. Available in Tooling API version 42.0 or later.
CustomField: Represents a custom field on a custom object that stores data unique to your organization. Includes access to the associated CustomField object and related fields in Salesforce Metadata API. Available from API version 28.0 or later.
CustomFieldDisplay: Represents the view type assigned to product attribute custom fields. This object is available in API version 63.0 and later.
CustomFieldMember: Represents the working copy of a field for editing or saving in a MetadataContainer. This object is available in API version 33.0 and later.
CustomHelpMenuSection: Represents a section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources. Available in API version 45.0 and later.
CustomHttpHeader: Represents a custom HTTP header used with OData 2.0 or OData 4.0 external data sources. Custom HTTP headers provide context information from Salesforce such as region, org details, or the role of the person viewing the external object. This object is available in API version 51.0 and later.
CustomMsgChannel: Represents a custom conversation channel and stores event-driven Messaging settings. Custom conversation channels are implemented for Bring Your Own Channel for Messaging and Bring Your Own Channel for CCaaS Messaging channels. This object is available in API version 63.0 and later.
CustomNotifActionDef: Represents the metadata associated with a mobile action group notification definition. This object is available in API version 66.0 and later.
CustomNotificationActionGroup: Stores information about custom notification action groups. This object is available in API version 66.0 and later.
CustomNotificationType: Stores information about custom notification types. This object is available in API version 46.0 and later.
CustomObject: Represents a custom object that stores data unique to your organization. Includes access to the associated CustomObject object and related fields in Salesforce Metadata API. Available from API version 31.0 or later.
DataAssessmentConfigItem: Represents a saved configuration for a specific vendor’s package for data assessment. This object is available in API version 40.0 and later.
DataIntegrationRecordPurchasePermission: Represents Lightning Data purchase credits that a Salesforce admin has granted to users. Available in Tooling API version 42.0 and later.
DataSourceBundleDefinition: Represents the bundle of streams that a user adds to a data kit. This object is available in API version 52.0 and later.
DataStreamTemplate: Represents metadata about the data stream that a user adds to a data kit. This object is available in API version 52.0 and later.
DataType: Represents the datatype of a field. Use this object with EntityDefinition, EntityParticle, or FieldDefinition to simplify queries. Available in Tooling API version 34.0 and later.
DebugLevel: Represents a set of log category levels to assign to a TraceFlag object. Multiple trace flags can use a debug level.
DelegateGroup: Represents a Delegate Group for queries. This object is available in Tooling API version 57.0 and later.
DelegateGroupGrant: Represents a Delegate Group Grant, indicating permissions granted to a delegate group. This object is available in Tooling API version 57.0 and later.
DelegateGroupMember: Represents users assigned to the delegate group This object is available in Tooling API version 57.0 and later.
DeployDetails: A complex type that contains detailed XML for any compile errors reported in the asynchronous request defined by a ContainerAsyncRequest object. Replaces the JSON field CompilerErrors in Tooling API version 31.0 and later.
DeployRequest: Uses file representations of metadata components to create, update, or delete those components in a Salesforce org. This object is available in API version 49.0 and later.
DocProcDefinition: Represents an Intelligent Document Processing (IDP) definition, which holds the identity and type of the definition. The versioned processing payload is stored on the child DocProcDefinitionVer object. This object is available in API version 68.0 and later.
DocProcDefinitionVer: Represents an immutable version of an Intelligent Document Processing (IDP) definition (DocProcDefinition). Multiple versions of the same definition can be active at the same time. A version is identified by its parent definition and VersionNumber. This object is available in API version 68.0 and later.
Document: Represents a file that a user has uploaded. Unlike Attachment records, documents are not attached to a parent object. Available in Tooling API version 38.0 and later.
DomainProvision: Represents provisioned changes to custom domains. This object is available in API version 50.0 and later.
DuplicateJobDefinition: Setup object defining a job that identifies duplicate record items globally. Available in Tooling API version 42.0 and later.
DuplicateJobMatchingRuleDefinition: Setup object specifying a MatchingRule to use with DuplicateJob instances that share a DuplicateJobDefinition. Available in Tooling API version 42.0 and later.
EmailTemplate: Represents a template for an email, mass email, list email, or Sales Engagement email. Supported in first-generation managed packages only.
EmbeddedServiceBranding: Represents branding for each Embedded Service deployment. Available in Tooling API version 39.0 and later.
EmbeddedServiceConfig: Represents a setup node for creating an Embedded Service deployment. Available in API version 38.0 and later.
EmbeddedServiceCustomComponent: Represents a custom component created for an Embedded Service feature. The custom components can be an Aura or Lightning Web Component. This object is available in API version 44.0 and later.
EmbeddedServiceCustomization: Represents a mapping between the EmbeddedServiceCustomization record parent and the EmbeddedServiceConfiguration or EmbeddedServiceMenuSettings, for a set of Embedded Service resources. Each resource is set of customizations applied via an uploaded static resource for your Embedded Chat. This object is available in API version 52.0 and later.
EmbeddedServiceCustomLabel: Represents a customized label that appears in the embedded component for a particular Embedded Service deployment. Labels can be customized for both Embedded Chat and embedded Appointment Management (beta). Available in API version 44.0 and later.
EmbeddedServiceFieldService: Represents a setup node for creating an embedded Appointment Management (beta) deployment. Available in Tooling API version 43.0 and later.
EmbeddedServiceFlow: Represents a Flow Definition used by an Embedded Service deployment. This object is available in API version 45.0 and later.
EmbeddedServiceFlowConfig: Represents whether an Embedded Service Flow feature is enabled or not. This object is available in API version 45.0 and later.
EmbeddedServiceLiveAgent: Represents a setup node for creating an Embedded Chat deployment. Available in Tooling API version 38.0 and later.
EmbeddedServiceMenuItem: Represents the information needed to configure a Channel Menu item. This object is available in API version 47.0 and later.
EmbeddedServiceMenuSettings: Represents a setup node for creating a channel menu deployment. Channel menus list the ways in which customers can contact your business. This object is available in API version 47.0 and later.
EmbeddedServiceQuickAction: Returns a quick action that is associated with an EmbeddedServiceLiveAgent setup. The quick action includes the pre-chat form fields that the embedded chat window displays and shows the order in which the fields are displayed. Available in Tooling API version 39.0 and later.
EmbeddedServiceResource: Represents a mapping from an EmbeddedServiceCustomization record parent to a set of resources. Each resource is a set of customizations applied via an uploaded static resource for your Embedded Chat. This object is available in API version 50.0 and later.
EngagementInsightType: Represents the configuration for engagement insight types for voice and video call insights. This object is available in API version 66.0 and later.
EnrichedField: Represents a field selected for Change Data Capture Enrichment for a channel and channel member. A non-empty enriched field is added to an update or delete change event even when not changed. Available in API version 51.0 and later.
EntityDefinition: Provides row-based access to metadata about standard and custom objects.
EntityLimit: Represents the limits for an object as displayed in the Setup UI.
EntityParticle: Represents each element of a field that can be presented in a user interface. Contrast EntityParticle with FieldDefinition, which represents each element of a field defined in the Metadata API. EntityParticle has parity with describe, which returns API accessible fields only for an entity. Available in Tooling API version 34.0 and later.
EventDelivery: Represents how an event instant maps to a target payload. Removed in API version 46.0. Available in API version 41.0 to 45.0.
EventRelayConfig: Represents the configuration of an event relay, which relays platform events and change data capture events from Salesforce to Amazon EventBridge. This object is available in API version 56.0 and later.
EventSubscription: Represents a subscription to an event type. Removed in API version 46.0. Available in API version 41.0 to 45.0.
ExtConvParticipantIntegDef: Represents the integration configuration for external conversation participants, used for communication between Salesforce and external messaging platforms. This object is available in API version 66.0 and later.
ExternalAuthIdentityProvider: Represents an external authentication (auth) identity provider. An external auth identity provider links to an external credential and obtains OAuth tokens for outbound callouts to external systems.
ExternalCredential: Represents the details of how Salesforce authenticates to the external system. This object is available in API version 56.0 and later.
ExternalDataSource: Represents the metadata associated with an external data source. Create external data sources to manage connection details for integration with data and content that are stored outside your Salesforce org. This object is available in API version 51.0 and later.
ExternalDataSrcDescriptor: Contains the metadata information for the external schema of an external data source. Use the metadata to map attributes from an AWS data source, such as Amazon DynamoDB and Amazon Athena, to Salesforce external object fields. Also, use the metadata to customize the data retrieval queries to an AWS data source. This object is available in API version 55.0 and later for Amazon DynamoDB and in API version 56.0 and later for Amazon Athena.
ExternalServiceRegistration: Represents the external service configuration for an org. Available in API version 39.0 and later.
ExternalString: Represents a custom label for a translatable UI component. Includes access to the associated label in the Metadata API. Available in API version 38.0 and later.
ExternalStringLocalization: Represents the translation of custom labels for a UI component represented by the ExternalString object. This object is available in API version 49.0 and later.
FieldDefinition: Represents a standard or custom field, providing row-based access to field metadata. Contrast FieldDefinition with EntityParticle, which represents each element of a field that can be presented in a user interface. FieldDefinition has parity with metadata type Field.
FieldMapping: Represents a mapping between fields in an object in the org and fields in a data service. A data service uses two separate field maps: one controls how the data service matches records in an object, and the other controls how the data service adds or updates data for an existing record.
FieldMappingField: Represents a field in an object in the org that maps to a field in a data service.
FieldMappingRow: Represents a field in a data service record that maps to a field in an object record in the org.
FieldRestrictionRule: Represents a field visibility rule that controls whether a field is visible to a user, based on the field’s inclusion in the PersonalInfo_EPIM field set. If Enhanced Personal Information Management setting was enabled before Spring ’22, field visibility is based on the field’s compliance categorization. This object is available in API version 52.0 and later.
FieldSet: Represents the metadata for a group of fields. Available from API version 33.0 or later.
FlexiPage: Represents a Lightning page. A Lightning page is a customizable page composed of regions containing Lightning components.
Flow: Use the Flow object to retrieve and update specific flow versions.
FlowElementTestCoverage: Represents a flow element that was executed by a given Apex test method. Available in API version 44.0 and later.
FlowTest: Represents the description of a flow test associated with a flow definition. This object is available in API version 55.0 and later.
FlowTestCoverage: Represents test coverage for a flow or process by a given Apex method. Available in API version 44.0 and later.
FlowTestResult: This object is reserved for internal use.
ForecastingDisplayedFamily: Represents the product families that an admin chooses to allow forecasting on in Lightning Experience. Available in Tooling API version 40.0 and later.
ForecastingFilter: Represents the custom filter for including or excluding data from opportunity forecasts. This object is available in API version 55.0 and later.
ForecastingFilterCondition: Represents the custom filter condition logic for including or excluding data from opportunity forecasts. This object is available in API version 55.0 and later.
ForecastingSourceDefinition: Represents the object, measure, date type, and hierarchy that a forecast uses to project sales. This object is available in API version 52.0 and later.
ForecastingType: Represents a forecast type. This object is available in API version 52.0 and later.
ForecastingTypeSource: Represents the mapping of a forecasting source definition to a forecast type. This object is available in API version 52.0 and later.
FormulaFunction: Represents a function used when building a formula, including examples and uses. This object is available in Tooling API version 39.0 and later.
FormulaFunctionAllowedType: Represents the functions that are supported in the given formula context. Available in API version 48.0 and later.
FormulaOperator: Represents an operator used when building a formula, including examples and uses. This object is available in Tooling API version 39.0 and later.
GenAiFunctionDefinition: Represents an agent action. This object is available in API version 60.0 and later.
GenAiPlannerDefinition: Represents an agent planner service that uses a large language model (LLM) and a reasoning strategy to decompose a given task into smaller subtasks, identify the most suitable actions for each subtask, and invoke them. This object is available in API version 60.0 and later.
GlobalValueSet: Represents a set of values used by a global picklist. Available from API version 39.0 or later.
Group: Represents a set of User records. Groups can contain individual users, other groups, or the users in a particular role or territory. In addition, groups can contain all users below a particular role or territory in the hierarchy. Available in Tooling API version 38.0 and later.
GtwyProvPaymentMethodType: Represents a type that allows integrators and payment providers to choose an active payment to receive an order's payment data rather than allowing the Salesforce Order Management platform to select a default payment method. This object is available in API version 50.0 and later.
HeapDump: A complex type that represents a heap dump in an ApexExecutionOverlayResult object. Available from API version 28.0 or later.
HistoryRetentionJob: Represents the body of retained data from the archive, and the status of the archived data. Available in API version 29.0 or later.
IconDefinition: Represents an icon, such as used for a tab. Available in API version 43.0 and later.
InboundNetworkConnection: Represents the a private connection between a third-party data service and a Salesforce org. The connection is inbound because the callouts are coming into Salesforce.. Available in API version 49.0 and later.
InboundNetworkConnProperty: Represents a name-value pair that describes the properties of the inbound network connection. Available in API version 49.0 and later.
Index: Represents the index defined within a custom big object. Available in Tooling API version 41.0 and later.
IndexField: Represents the fields in the index of a custom big object. Available in Tooling API version 41.0 and later.
InstalledSubscriberPackage: Represents a package (first- or second-generation) that is installed in a subscriber’s org. Available in API version 41.0 and later.
InstalledSubscriberPackageVersion: Deprecated and slated for removal. Represents a package version (first- or second-generation) that is installed in a subscriber’s org. Available in API version 41.0 and later.
InvocableActionExtension: Represents an extension to an invocable action in Salesforce. This object is available in API version 65.0 and later.
IPAddressRange: Represents a range of IP addresses to include in or exclude from the specified feature.
KeywordList: Represents a list of keywords used in Experience Cloud site moderation. Available in Tooling API version 36.0 and later.
LightningComponentBundle: Represents a Lightning web component bundle. A bundle contains a Lightning web component and its related resources. Available in API version 45.0 and later.
LightningComponentResource: Represents a Lightning web component resource, such as HTML markup, JavaScript code, a CSS file, an SVG resource, or an XML configuration file. Available in API version 45.0 and later.
LightningOutApp: Represents a Lightning Out 2.0 application. With a Lightning Out 2.0 app, you can embed Lightning web components (LWC) into external applications. This object is available in API version 65.0 and later.
LookupFilter: Represents a lookup filter, which restricts the valid values and lookup dialog results for lookup, master-detail, and hierarchical relationship fields.
ManagedContentNodeType: Represents standard and custom content node types created for use with your org. Available in API version 47.0 and later.
ManagedContentType: Represents standard and custom content types created for use with your org. Available in API version 47.0 and later.
ManagedEventSubscription (Beta): Represents a managed event subscription in Pub/Sub API. Use a managed event subscription to track the events that a subscriber client consumed and resume a subscription where it left off. This object is available in API version 60.0 and later.
MarketingAppExtAction: Represents an Action Type, which is an action that you can add to Engagement Studio programs in Account Engagement and execute in a third-party app. This object is available in API version 56.0 and later.
MarketingAppExtActivity: Represents an Activity Type, which is a prospect activity that occurs in a third-party app and can be used in Account Engagement automations. . Available in API version 53.0 and later.
MarketingAppExtAssignment: Represents a Marketing App Extension Business Unit assignment, which dictates which Account Engagement business unit the external activity data is available in. Available in API version 53.0 and later.
MarketingAppExtension: Represents an integration with a third-party app or service that generates prospect external activity. Available in API version 53.0 and later.
MarketingHierarchyGroupDef: Represents the top-level category of a marketing hierarchy that can be defined on various dimensions such as brand, industry, and region. This object is available in API version 68.0 and later.
MarketingHierarchyGroupNodeDef: Represents the membership of a node within a marketing hierarchy group, defining which hierarchy levels belong to a given group category. This object is available in API version 68.0 and later.
MarketingHierarchyNodeDef: Represents a node in a marketing hierarchy whose depth in the hierarchy is determined by its sequence number. This object is available in API version 68.0 and later.
MatchingRule: Setup object specifying a MatchingRule to use with DuplicateJob instances that share a DuplicateJobDefinition. Available in Tooling API version 42.0 and later.
MetadataComponentDependency (Beta): Represents dependency relationships between the metadata components in your org. You can query MetadataComponentDependency using Tooling API in API version 43.0 and later or using Bulk API 2.0 in API 49.0 and later.
Bulk API 2.0 Usage: Using Bulk API 2.0, you can query the MetadataComponentDependency Tooling API object and retrieve up to 100,000 records in a single query. Use SOQL queries to list the relationships between the metadata components in your org.
Tooling API Usage: Use SOQL queries to list the relationships between the metadata components in your org. The query results include one row for each relationship. Each relationship is a directional dependency between two metadata components.
MetadataContainer: Manages working copies of ApexClassMember, ApexTriggerMember, ApexPageMember, and ApexComponentMember objects, including collections of objects to be deployed together.
MetadataPackage: Represents a package that has been developed in the org you’re logged in to. Applies to unlocked, unmanaged, first-generation, and second-generation managed packages. Available in Tooling API version 38.0 and later.
MetadataPackageVersion: Represents a package version (managed or unmanaged) that has been uploaded from the org you’re logged in to. Available in Tooling API version 38.0 and later.
MktHierGrpNodeRuleDef: Represents a rule for a node in a marketing hierarchy group. Based on the rule type, the rule defines the allowed parent node or the user, group, or profile that can create marketing programs. This object is available in API version 68.0 and later.
MLDataDefinition: Represents a modeling data definition, which specifies the data used to create a model for a machine learning (ML) application. Examples of such data can include filters, fields to include, and fields to exclude. Available from API version 50.0 or later.
MLField: Represents a field in a modeling data definition. A modeling data definition specifies the data used to create a model for a machine learning (ML) application. Available from API version 50.0 or later.
MLFilter: Represents a data filter based on a data comparison in a machine learning (ML) application. For each comparison, there’s a left-hand element, an operator, and a right-hand element. Available in API version 50.0 and later.
MLPredictionDefinition: Represents the details about a prediction within a prediction definition used in a machine learning (ML) application. Available in API version 50.0 and later.
ModerationRule: Represents a rule used in your Experience Cloud site to moderate member-generated content. Available in Tooling API version 36.0 and later.
OrgDomainLog: Represents a Salesforce org’s previous My Domain. This object is available in API version 51.0 and later.
NamedCredential: Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts. This object is available in API version 51.0 and later.
ObjectHierarchyRelationship: Represents the mapping between an input source object and an output target object. For example, mapping details to transform a sales quote into a sales agreement. This object is available in API version 56.0 and later.
OmniSupervisorConfig: Represents the Omni-Channel supervisor configuration for an assigned group of supervisors. This object is available in API version 57.0 and later.
OperationLog: Represents long-running or asynchronous operations triggered and tracked through Tooling API. This object is available in API version 37.0 and later.
OpportunitySplitType: Represents labels and behavior for each split type Available in Tooling API version 37.0 and later.
OutboundNetworkConnection: Represents a private connection between a Salesforce org and a third-party data service. The connection is outbound because the callouts are going out of Salesforce.Available in API version 49.0 and later.
OutboundNetworkConnProperty: Represents a name-value pair that describes the properties of the outbound network connection. Available in API version 49.0 and later.
OwnerChangeOptionInfo: Represents default and optional actions that can be performed when a record’s owner is changed. Available in Tooling API version 35.0 and later.
Package2: Represents a second-generation managed package or an unlocked package in a Dev Hub org. Values for all fields are visible to the subscriber. Available in API version 41.0 and later.
Package2Member: Represents a component in a second-generation managed package in a subscriber’s org. Created when the subscriber installs the package. Available in API version 41.0 and later.
Package2Version: Represents a second-generation package version in a Dev Hub org. Values for all fields except for Tag and Branch are visible to the subscriber. Available in API version 41.0 and later.
Package2VersionCreateRequest: Represents a request to create a second-generation managed package or an unlocked package version in a Dev Hub org. Available in API version 41.0 and later.
Package2VersionCreateRequestError: Represents an error encountered while creating a second-generation managed package or an unlocked package version. Available in API version 41.0 and later.
PackageInstallRequest: Represents a request to install a package (first- or second-generation) in a target subscriber org. Available in API version 41.0 and later.
PackageUploadRequest: Represents a request to upload a first-generation package version and its components so that subscribers can install it. Available in API version 38.0 and later.
PackageVersionUninstallRequestError: Represents an error encountered while requesting an uninstall of a Package2Version (second-generation package version). Available in API version 41.0 and later.
PardotTenant: Represents an Account Engagement business unit. This object is available in API version 56.0 and later.
PathAssistant: Represents a Path. Available in Tooling API version 36.0 and later.
PathAssistantStepInfo: Represents guidance for a step on a Path. Available in Tooling API version 36.0 and later.
PathAssistantStepItem: Represents layout or guidance details for a step on a Path. Available in Tooling API version 36.0 and later.
PaymentGatewayProvider: Represents the payment gateway provider processing payments. This object is available in API version 48.0 and later.
PermissionDependency: Represents permission dependencies for a specified permission. For example, return all child dependencies for the Modify All Data permission. Available in Tooling API version 46.0 and later.
PermissionSet: Represents a set of permissions that’s used to grant more access to users without changing their profile or reassigning profiles. Available in API version 28.0 and later.
PermissionSetAssignment: Represents a user’s assignment to a permission set or permission set group. This object is available in API version 22.0 and later.
PermissionSetGroup: Represents a group of permission sets and the permissions within them. Use permission set groups to organize permissions based on job functions or tasks. Then, you can package the groups as needed. Available in Tooling API version 45.0 and later.
PermissionSetGroupComponent: A junction object that relates the PermissionSetGroup and PermissionSet objects via their respective IDs; enables permission set group recalculation to determine the aggregated permissions for the group. Available in Tooling API version 45.0 and later.
PermissionSetTabSetting: Represents a tab’s settings for a profile or permission set. Use PermissionSetTabSetting for manipulating tab visibility on profiles and permission sets. Available in Tooling API version 37.0 and later.
PipelineInspMetricConfig: Represents the configuration of a forecast category metric that appears in the Pipeline Inspection view. This object is available in API version 55.0 and later.
PlatformEventChannel: Represents a custom channel that you can subscribe to in order to receive a stream of change data capture events.
PlatformEventChannelMember: Represents an entity selected for Change Data Capture notifications on a standard or custom channel, or a platform event selected on a custom channel.
PlatformEventMigration: Represents configuration settings for performing a one-time migration of standard volume platform events to high volume platform events. This object is available in API version 67.0 and later.
PlatformEventSubscriberConfig: Represents configuration settings for a platform event Apex trigger, including the batch size and the trigger’s running user. This object is available in API version 51.0 and later.
PostTemplate: Represents an approval post template for Approvals in Chatter.
PresenceDeclineReason: Represents the reason an agent can select when declining an Omni-Channel work request. This object is available in API version 65.0 and later.
PresenceUserConfig: Represents a configuration that determines a presence user’s settings. This object is available in API version 65.0 and later.
ProcessFlowMigration: Represents a process's migrated criteria and the resulting migrated flow. This object is available in API version 58.0 and later.
ProductAttributeSet: Used to group variation attributes that apply to one or more products. This object is available in API version 55.0 and later.
Profile: Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the Metadata metadata type and inherits its fullName field.
Publisher: Represents the publisher of objects and fields. For example, Salesforce is the publisher for standard objects, the organization is the publisher for custom objects, and the package is the publisher for installed packages. Available in Tooling API version 34.0 and later.
QueryResult: Represents the results of a query. For example, if you query on the object EntityDefinition, all the layouts for that entity are returned as an array of QueryResult objects in the Layouts field. Available in Tooling API version 34.0 and later.
QueueRoutingConfig: Represents configuration settings that determine how work items are routed to agents. This object is available in API version 65.0 and later.
RecentlyViewed: Represents metadata entities typically found in Setup such as page layout definitions, workflow rule definitions, and email templates that the current user has recently viewed.
RecommendationStrategy: Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, filtering, and logic operations. Available in API 45.0 and later.
RecordActionDeployment: Represents configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components. RecordActionDeployment is available in API version 45.0 and later.
RegisteredExternalService: Represents a registered external service used to provide an extension or integration. This object is available in API version 49.0 and later.
RelatedListColumnDefinition: Represents information about a column in a related list. A related list specifies a set of records for a related object, based on specific criteria. This object is available in API version 55.0 and later.
RelatedListDefinition: Represents information about a related list. A related list specifies a set of records for a related object, based on specific criteria. This object is available in API version 55.0 and later.
RelationshipDomain: Represents the relationship an object has with other objects. RelationshipDomain allows you to write simpler queries. For example, “which objects are the child objects for the object defined in ParentSobject” is easier using RelationshipDomain. Available in Tooling API version 34.0 and later.
RelationshipInfo: Represents the properties of a relationship between objects. Simplify queries with RelationshipInfo, such as answering the question “which objects are parent objects for the object defined in ChildSobject. Available in Tooling API version 34.0 and later.
ReleaseUpdate: Represents an individual release update. Available in API version 50.0 and later.
ReleaseUpdateStep: Represents an individual release update step. Available in API version 49.0 and later.
RemoteProxy: Represents a set of remote site settings that allows you to access an external site from Salesforce. Use RemoteProxy when accessing external sites called by Visualforce pages, Apex callouts, or JavaScript codes using XmlHttpRequest in an s-control or custom button. To be accessible, an external site must have its settings defined with RemoteProxy or registered in the Remote Site Settings page. Available in Tooling API version 37.0 and later.
RestrictionRule: Represents a restriction rule or a scoping rule. A restriction rule has EnforcementType set to Restrict and controls the access that specified users have to designated records. A scoping rule has EnforcementType set to Scoping and controls the default records that your users see without restricting access.
SandboxProcess: Represents the sandbox copy process for a SandboxInfo record.
SandboxProcessStage: Represents the status and progress during a spectific stage for a SandboxProcess record.
SchedulingObjective: Represents scheduling objective settings for Workforce Engagement. This object is available in API version 55.0 and later.
SchedulingRule: Represents scheduling rule settings for Workforce Engagement. This object is available in API version 53.0 and later.
ScndTelephPrvdOtbdDtl: Represents the outbound SIP routing configuration for a secondary telephony provider in Agentforce Contact Center BYOC. This object is available in API version 68.0 and later.
Scontrol: Represents a custom s-control, which is custom content that our system hosts, but client applications execute. An s-control can contain any type of content that you can display or run in a Web browser.
SearchLayout: Represents a search layout defined for an object.
SecondaryTelephonyProvider: Represents the SIP configuration for secondary telephony providers in Agentforce Contact Center Bring Your Own Carrier (BYOC). This object is available in API version 68.0 and later.
SecurityHealthCheck: Represents your org’s Health Check score. The score indicates how well your org’s security settings comply with Salesforce-recommended values in the baseline standard. Only users with the “View Setup and Configuration” user permission can retrieve data from this object. Available in Tooling API version 37.0 and later.
SecurityHealthCheckRisks: Represents your org’s security setting values, risks, and Salesforce-recommended setting values. Only users with the "View Setup and Configuration" user permission can retrieve data from this object. Available in Tooling API version 37.0 and later.
SensitiveDataRuleElmnt: Represents a predefined PII, PHI, and PCI named-entity type supported by the PII Redaction Model Service. This object is available in API version 68.0 and later.
SensitiveDataRuleElmntGrp: Stores Named Entity Recognition (NER)-based sensitive-data rules at the organization level to redact PII/PCI from voice and messaging transcripts. This object is available in API version 68.0 and later.
ServiceChannel: Represents a channel for work items that are received from your customers. This object is available in API version 65.0 and later.
ServiceFieldDataType: Deprecated in API version 34.0, the ServiceFieldDataType object is removed in version 58.0 and later.
ServicePresenceStatus: Represents a presence status that can be assigned to a service channel. This object is available in API version 65.0 and later.
ShiftSegmentType: Represents shift segment type settings for Shift Scheduling and Workforce Engagement. This object is available in API version 55.0 and later.
SiteDetail: Represents the details of a Salesforce site or Experience Cloud site. Available in API version 38.0 and later.
Skill: Represents the settings for a skill used for field service or to route chats to agents in Chat, such as the name of the skill and which agents the skills are assigned to. This object is available in API version 65.0 and later.
SOQLResult: A complex type that represents the result of a SOQL query in an ApexExecutionOverlayResult object. Available from API version 28.0 or later.
SourceMember: Reserved for internal use. Do not use this object. Accuracy of results isn’t guaranteed.
StandardAction: Represents the buttons, links, and actions (standard actions) for a standard or custom object. This object is available in API version 34.0 and later.
StaticResource: Represents the working copy of a static resource file for editing or saving. Static resources allow you to upload content that you can reference in a Visualforce page, including images, stylesheets, JavaScript, and other files. Available in Tooling API version 29.0 and later.
SubscriberPackage: Represents an installable package (first- or second-generation) across all Salesforce instances. Available in API version 41.0 and later.
SubscriberPackageVersion: Represents a package version (first- or second-generation) across all Salesforce instances. Available in API version 41.0 and later.
SubscriberPackageVersionUninstallRequest: Represents a request to uninstall a Package2Version (second-generation package version). Available in API version 41.0 and later.
SvcCatalogCategory: Represents the grouping of individual catalog items in Service Catalog. This object is available in API version 53.0 and later.
SvcCatalogCategoryItem: Represents the assignment of this service to a category within the Service Catalog. This object is available in API version 53.0 and later.
SvcCatalogFulfillFlowItem: Represents a variable in a fulfillment flow for Service Catalog that can accept input. This object is available in API version 53.0 through 56.0.
SvcCatalogFulfillmentFlow: Represents the flow associated with a specific catalog item in the Service Catalog. This object is available in API version 53.0 and later.
SvcCatalogItemDef: Represents the grouping of individual catalog items in Service Catalog. This object is available in API version 53.0 and later.
SymbolTable: A complex type that represents all user-defined tokens in the Body of an ApexClass, ApexClassMember, or ApexTriggerMember and their associated line and column locations within the Body.
TabDefinition: Represents a tab, and returns all tabs available in the org. Available in API version 43.0 and later.
TelephonyProvider: Represents the telephony provider configuration and trust settings for Agentforce Contact Center BYOC integrations. This object is available in API version 68.0 and later.
Territory2SupportedObject: Represents the object type supported by territories. This object is available in API version 57.0 and later.
TestSuiteMembership: Associates an Apex class with an ApexTestSuite. Available in Tooling API version 36.0 and later.
TimeSheetTemplate: Represents a template for creating time sheets in Field Service. Available in API version 46.0 and later.
TimeSheetTemplateAssignment: Represents the assignment of a time sheet template to a profile. Available in API version 48.0 and later.
TraceFlag: Represents a trace flag that triggers an Apex debug log at the specified logging level.
TrustedTelephonyProvider: Represents the mapping between an organization and its trusted telephony carrier configuration for Agentforce Contact Center BYOC. This object is available in API version 68.0 and later.
User: Represents a user. You can retrieve standard fields on User with the Tooling API, but custom fields can’t be retrieved.
UserAccessPolicy: Represents a user access policy. This object is available in API version 57.0 and later.
UserAccessPolicyAction: Represents an action applied by the user access policy. This object is available in API version 57.0 and later.
UserAccessPolicyFilter: Represents a user criteria filter for a user access policy. This object is available in API version 57.0 and later.
UserCriteria: Represents the member criteria to use in Experience Cloud site moderation rules. Available in Tooling API version 39.0 and later.
UserEntityAccess: Represents the access that the current user has to an object. Available in Tooling API version 34.0 and later.
UserFieldAccess: Represents the access that the current user has to a field. Available in Tooling API version 34.0 and later.
ValidationRule: Represents a validation rule or workflow rule which specifies the formula for when a condition is met. Available from API version 34.0 or later.
VirtualVisitConfig: Represents the configuration of an external video provider, which relays events from Salesforce to the provider. This object is available in API version 56.0 and later.
VoiceTelephonyDefinition: Represents the org-level voice telephony configuration for Agentforce Contact Center, including the dialing prefix, dialing region, default caller ID, and pre-dial flow used when placing outbound calls. This object is available in API version 68.0 and later.
VoiceTelephonyGroupOvride: Represents group-level telephony settings that override the default org-level configuration. This object is available in API version 68.0 and later.
VoiceTelephonyProfileOvride: Represents profile-level telephony settings that override the default org-level configuration. This object is available in API version 68.0 and later.
VoiceTelephonyUserOvride: Represents user-level telephony settings that override the default org-level configuration. This object is available in API version 68.0 and later.
WebLink: Represents a custom button or link. Available in the Tooling APIfrom API version 34.0 or later.
WebStoreTemplate: Represents a configuration for creating commerce stores. This object is available in API version 49.0 and later.
WorkflowAlert: Represents a workflow alert. A workflow alert is an email generated by a workflow rule or approval process and sent to designated recipients.
WorkflowOutboundMessage: Represents an outbound message. An outbound message sends information to a designated endpoint, like an external service. Outbound messages are configured from Setup. You must configure the external endpoint and create a listener for the messages using the SOAP API.
WorkflowRule: Represents a workflow rule that is used to fire off a specific workflow action when the specified criteria is met. Includes access to the associated WorkflowRule object in Salesforce Metadata API.
WorkflowTask: Represents a workflow task that is used to fire off a specific workflow action when the specified criteria is met. Includes access to the associated WorkflowRule object in Salesforce Metadata API.
WorkSkillRouting: Represents a setup object that stores a set of WorkSkillRoutingAttribute objects used to route a work item to an agent who has the skills necessary to take the work. Available in API version 46.0 and later.
WorkSkillRoutingAttribute: Represents a setup object that stores metadata related to the routing assignments between object field values and skills. Field values are used to route a work item to an agent who has the skills necessary to take the work. Available in API version 46.0 and later.
Allow Metadata Save Operations to Complete with Returned
Warnings: When a metadata save operation generates warnings, the default behavior of Tooling API is to fail the operation without returning the warnings. For objects in both the Tooling API and Metadata API WSDLs, you can indicate that you want error-free save operations to complete successfully, returning any warnings.
Composite Request Body: Describes a collection of subrequests to execute with the /composite resource.
Improve Performance with the Composite Resource: Use the /composite resource to improve the performance of a development tool or app built with Tooling API. This resource executes a series of Tooling API requests in a single call, minimizing the number of round trips needed between the client and server. You can use the output of one request as the input to a subsequent request. The requests’ response bodies and HTTP statuses are returned in a single response body. The entire request counts as a single call toward your API limits. Available in API version 40.0 and later.
