Tooling API Objects

Tooling API includes the following objects:

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 Salesforce users and external email addresses to be notified when unhandled Apex exceptions occur. 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.
ApexLog
Represents a debug log.
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 an Apex page. ApexPage uses the cached version of the class 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.
AssignmentRule
Don’t use this object.
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.
AutoResponseRule
Specifies whether the autoresponse rule is active (true).
BusinessProcess
Represents a business process.
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.
ContainerAsyncRequest
Allows you to compile and asynchronously deploy a MetadataContainer object to your organization.
CspTrustedSite
Represents a CSP Trusted Site. The Lightning Component framework uses Content Security Policy (CSP) to impose restrictions on content. The main objective is to help prevent cross-site scripting (XSS) and other code injection attacks. To use third-party APIs that make requests to an external (non-Salesforce) server or to use a WebSocket connection, add a CSP Trusted Site. 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.
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.
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.
CustomTab
Represents a custom tab.
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.
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.
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.
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.
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 an email template.
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.
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.
EmbeddedServiceLiveAgent
Represents a setup node for creating an Embedded Chat deployment. Available in Tooling API version 38.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.
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. 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.
EventSubscription
Represents a subscription to an event type. Removed in API version 46.0. Available in API version 41.0 to 45.0.
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.
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.
FlowDefinition
The parent of a set of flow versions.
FlowElementTestCoverage
Represents a flow element that was executed by a given Apex test method. Available in API version 44.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.
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.
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.
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.
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.
HomePageComponent
Represents a home page component.
HomePageLayout
Represents a home page layout.
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.
KeywordList
Represents a list of keywords used in community moderation. Available in Tooling API version 36.0 and later.
Layout
Represents a page layout.
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.
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.
MatchingRule
Setup object specifying a MatchingRule to use with DuplicateJob instances that share a DuplicateJobDefinition. Available in Tooling API version 42.0 and later.
MenuItem
Represents a menu item.
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.
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.
ModerationRule
Represents a rule used in your community to moderate member-generated content. Available in Tooling API version 36.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.
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.
PathAssistant
Represents a Path. Available in Tooling API version 36.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.
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.
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.
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.
PlatformEventChannel
Represents a Change Data Capture custom channel that you can subscribe to for receiving notifications of Salesforce record changes. Change Data Capture sends notifications for created, updated, deleted, and undeleted records only for the selected entities.
PlatformEventChannelMember
Represents an entity selected for Change Data Capture notifications on a standard or custom channel.
PostTemplate
Represents an approval post template for Approvals in Chatter.
Profile
Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce.
ProfileLayout
Represents a profile layout.
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.
QuickActionDefinition
Represents the definition of a quick action.
QuickActionList
Represents a list of quick actions.
QuickActionListItem
Represents an item in a quick action list.
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 component. RecordActionDeployment is available in API version 45.0 and later.
RecordType
Represents a custom record type.
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.
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.
SandboxInfo
Represents a sandbox.
SandboxProcess
Represents the sandbox copy process for a SandboxInfo record.
SearchLayout
Represents a search layout defined for an object.
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.
ServiceFieldDataType
Don’t use this object.
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.
SiteDetail
Represents the details of a site or community. Available in API version 38.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
Represents a single sObject of all source that you are tracking in a scratch org. Examples of SourceMembers include Apex classes, custom objects, permission sets, and custom applications. Salesforce uses SourceMember objects to track what has changed in your scratch org. Available in Tooling API version 41.0 and later.
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.
StandardValueSet
Represents a set of values used by a standard picklist. Available in API version 39.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.
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.
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 Lightning. 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.
TransactionSecurityPolicy
Represents a transaction security policy definition.
User
Represents a user. You can retrieve standard fields on User with the Tooling API, but custom fields can’t be retrieved.
UserCriteria
Represents the member criteria to use in community 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.
WebLink
Represents a custom button or link. Available in the Tooling APIfrom API version 34.0 or 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.
WorkflowFieldUpdate
Represents a workflow field update.
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.