Newer Version Available

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

Supported Objects

User Interface API supports all custom objects and many standard objects.

To get a directory of objects that are supported by the API and accessible to the context user, use the /ui-api/object-info resource.

To understand how the API operates on supported objects, let’s look at some examples.

This resource gets object metadata. It operates on any supported object.
This example gets Account metadata.
This resource gets record data and metadata. It operates on any supported object record.
This example gets data and metadata to display an Opportunity record.
List of Supported Objects

User Interface API supports the following objects.

The list view resources support a smaller set of objects.

Note

  • Account
  • AccountTeamMember
  • Asset
  • AssetRelationship
  • AssignedResource
  • AttachedContentNote
  • BusinessAccount
  • Campaign
  • CampaignMember
  • Case
  • Contact
  • ContentDocument
  • ContentNote
  • ContentVersion
  • ContentWorkspace
  • Contract
  • ContractContactRole
  • ContractLineItem
  • Custom Object
  • Entitlement
  • EnvironmentHubMember
  • Lead
  • LicensingRequest
  • MaintenanceAsset
  • MaintenancePlan
  • MarketingAction
  • MarketingResource
  • Note
  • OperatingHours
  • Opportunity
  • OpportunityLineItem
  • OpportunityTeamMember
  • Order
  • OrderItem
  • PersonAccount
  • Pricebook2
  • PricebookEntry
  • Product2
  • Quote
  • QuoteDocument
  • QuoteLineItem
  • ResourceAbsence
  • ResourcePreference
  • ServiceAppointment
  • ServiceContract
  • ServiceCrew
  • ServiceCrewMember
  • ServiceResource
  • ServiceResourceCapacity
  • ServiceResourceSkill
  • ServiceTerritory
  • ServiceTerritoryLocation
  • ServiceTerritoryMember
  • Shipment
  • SkillRequirement
  • SocialPost
  • Tenant
  • TimeSheet
  • TimeSheetEntry
  • TimeSlot
  • UsageEntitlement
  • UsageEntitlementPeriod
  • User
  • WorkOrder
  • WorkOrderLineItem
  • WorkType
List of Supported Objects for List Views

The list view resources support the following objects.

  • Account
  • Asset
  • Campaign
  • Case
  • Contact
  • ContentVersion
  • Contract
  • Custom Object
  • Entitlement
  • EntityMilestone
  • EnvironmentHubMember
  • Lead
  • MaintenancePlan
  • OperatingHours
  • Opportunity
  • Order
  • Pricebook2
  • Product2
  • Quote
  • ResourcePreference
  • ReturnOrder
  • ServiceAppointment
  • ServiceContract
  • ServiceCrew
  • ServiceCrewMember
  • ServiceResource
  • ServiceResourceSkill
  • ServiceTerritory
  • ServiceTerritoryMember
  • Shipment
  • SkillRequirement
  • SocialPost
  • Tenant
  • TimeSheet
  • TimeSheetEntry
  • WorkOrder
  • WorkOrderLineItem
  • WorkType