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 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.
1GET /ui-api/object-info/{objectApiName}
This example gets Account metadata.
1GET /ui-api/object-info/Account
This resource gets record data and metadata. It operates on any supported object record.
1GET /ui-api/record-ui/{recordIds}
This example gets data and metadata to display an Opportunity record.
1GET /ui-api/record-ui/006RM000002XCd1YAG
List of Supported Objects
  • 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