User Interface API Developer Guide
jNewer Version Available
Supported 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.
- Supported Objects
- Most User Interface API resources support these objects. The list views and most recently used (MRU) list views resources support a smaller set of objects.
- 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
- Supported Objects for List Views
- The list views resources support a subset of objects.
- List views resources:
- /ui-api/list-ui/${objectApiName}
- /ui-api/list-info/${listViewId} and /ui-api/list-info/${objectApiName}/${listViewApiName}
- /ui-api/list-records/${listViewId} and /ui-api/list-records/${objectApiName}/${listViewApiName}
- /ui-api/list-ui/${listViewId} and /ui-api/list-ui/${objectApiName}/${listViewApiName}
- Supported objects for list views resources:
- 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
- Supported Objects for MRU List Views
- The MRU list views resources support a subset of objects.
- MRU list views resources:
- Supported objects for MRU list views resources:
- Account
- Asset
- Campaign
- Case
- Contact
- Contract
- Entitlement
- EnvironmentHubMember
- Lead
- MaintenancePlan
- OperatingHours
- Opportunity
- Order
- Product2
- Pricebook2
- Quote
- ResourcePreference
- ReturnOrder
- ServiceAppointment
- ServiceResource
- ServiceTerritory
- ServiceTerritoryMember
- ServiceResourceSkill
- ServiceCrew
- ServiceCrewMember
- ServiceContract
- Shipment
- SkillRequirement
- SocialPost
- TimeSheet
- TimeSheetEntry
- WorkType
- WorkOrder
- WorkOrderLineItem