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.
1GET /ui-api/object-info/{objectApiName}This example gets Account
metadata.
1GET /ui-api/object-info/AccountThis 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- Supported Objects
- Most User Interface API resources support these objects. The list views, most recently used (MRU) list views, and related lists resources support a smaller set of objects.
-
- Account
- AccountBrand
- AccountContactRelation
- AccountForecast
- AcctMgrPeriodicTargetDstr
- AcctMgrTarget
- AcctMgrTargetDstr
- AccountProductForecast
- AccountProductPeriodForecast
- AccountParticipant
- AccountPartner
- AccountTeamMember
- ActionCadence
- ActionPlan
- ActionPlanItem
- ActionPlanTemplate
- ActionPlanTemplateItem
- ActionPlanTemplateItemValue
- ActionPlanTemplateVersion
- Address
- AiVisitRecommendation
- AiVisitRecommendRequest
- AssessmentIndDefinedValue
- AssessmentIndValue
- AssessmentTask
- AssessmentTaskContentDocument
- AssessmentTaskOrder
- Asset
- AssetRelationship
- AssetStatePeriod
- AssetWarranty
- AssignedResource
- AttachedContentNote
- BasicDataRecord
- BusinessAccount
- BusinessLicenseApplication
- BusinessMilestone
- BusinessProfile
- Campaign
- CampaignMember
- CareBarrier
- CareBarrierType
- CarePgmProvHealthcareProvider
- CareProgram
- CareProgramEnrollee
- CareRegisteredDevice
- Case
- Claim
- ClaimCase
- ClaimItem
- ClaimParticipant
- Contact
- ContactRequest
- ContentDocument
- ContentNote
- ContentVersion
- ContentWorkspace
- Contract
- ContractContactRole
- ContractLineItem
- CoverageType
- Custom Object
- CustomerProperty
- DataExportDefinition
- DataStreamDefinition
- DeleteEvent
- DeliveryTask
- DigitalSignature
- ElectronicMediaGroup
- Employee
- EmployeeAsset
- EmployeeContact
- EmployeeJob
- EmployeeJobPosition
- EmployeeOrganization
- Entitlement
- EntityArchivingSetup
- EnvironmentHubMember
- Examination
- Expense
- ExpenseReport
- ExpenseReportEntry
- HealthCareDiagnosis
- HealthCareProcedure
- HealthcareProvider
- Image
- IndividualApplication
- InspectionAssessmentInd
- InsuranceClaimAsset
- InsurancePolicy
- InsurancePolicyAsset
- InsurancePolicyCoverage
- InsurancePolicyMemberAsset
- InsurancePolicyParticipant
- InsuranceProfile
- JobFamily
- JobPosition
- JobProfile
- KnowledgeArticleVersion
- Lead
- LicensingRequest
- ListEmail
- LoanApplicant
- LoanApplicantAddress
- LoanApplicantDeclaration
- LoanApplicantEmployment
- LoanApplicantIncome
- LoanApplicationAsset
- LoanApplicationFinancial
- LoanApplicationLiability
- LoanApplicationProperty
- LoanApplicationTitleHolder
- Location
- LoyaltyBenefit
- LoyaltyBenefitType
- LoyaltyLedger
- LoyaltyProgram
- LoyaltyProgramCurrency
- LoyaltyProgramMember
- LoyaltyProgramPartner
- LoyaltyTier
- LoyaltyTierBenefit
- LoyaltyTierGroup
- MaintenanceAsset
- MaintenancePlan
- MaintenanceWorkRule
- MarketingAction
- MarketingResource
- MessagingChannel
- MessagingEndUser
- MessagingSession
- MsgChannelLanguageKeyword
- Note
- OccupationLicenseApplication
- OperatingHours
- OperatingHoursHoliday
- Opportunity
- OpportunityLineItem
- OpportunityLineItemSchedule
- OpportunityParticipant
- OpportunityPartner
- OpportunityTeamMember
- Order
- OrderItem
- OrderItemSummaryChange
- OrderSummary
- OrgMetric
- OrgMetricScanSummary
- OrgMetricScanResult
- OtherComponentTask
- Partner
- PersonAccount
- PersonExamination
- PersonLifeEvent
- PgmRebateTypBnftMapping
- PreliminaryApplicationRef
- PriceAdjustmentSchedule
- Pricebook2
- PricebookEntry
- Producer
- ProducerPolicyAssignment
- Product2
- Product2DataTranslation
- ProductAttribute
- ProductAttributeSet
- ProductAttributeSetItem
- ProductAttributeSetProduct
- ProductCategoryDataTranslation
- ProductCategoryMedia
- ProductCoverage
- ProductMedia
- ProductServiceCampaign
- ProductTransfer
- ProductWarrantyTerm
- ProgramRebateType
- ProgramRebateTypeBenefit
- ProgramRebateTypeFilter
- ProgramRebateTypePayout
- ProgramRebateTypPayoutSrc
- Promotion
- Quote
- QuoteDocument
- QuoteLineItem
- RebateMemberProductAggregate
- RebatePayment
- RebatePayoutAdjustment
- RebateProgram
- RebateProgramMember
- RebateProgramMemberPayout
- RebateProgramPayoutPeriod
- ReceivedDocument
- RecordAction
- RecordsetFilterCriteria
- RecordsetFilterCriteriaRule
- RecordType
- RegulatoryAuthority
- RegulatoryAuthorizationType
- RegulatoryCode
- RegulatoryCodeAssessmentInd
- RegulatoryCodeViolation
- ResidentialLoanApplication
- ResourceAbsence
- ResourcePreference
- RetailVisitKpi
- RetailVisitWorkTask
- RetailVisitWorkTaskOrder
- SalesAgreement
- SalesAgreementProduct
- SecuritiesHolding
- ServiceAppointment
- ServiceContract
- ServiceCrew
- ServiceCrewMember
- ServiceResource
- ServiceResourceCapacity
- ServiceResourceSkill
- ServiceTerritory
- ServiceTerritoryLocation
- ServiceTerritoryMember
- SetupAssistantStep
- Shift
- ShiftPattern
- Shipment
- SignatureTask
- SignatureTaskLineItem
- SkillRequirement
- SocialPost
- SurveyInvitation
- SurveyResponse
- SurveySubject
- Tenant
- TimeSheet
- TimeSheetEntry
- TimeSlot
- TrainingCourseParticipant
- TransactionJournal
- TrnCourse
- UsageEntitlement
- UsageEntitlementPeriod
- User
- ViolationEnforcementAction
- ViolationType
- Visit
- VisitedParty
- Visitor
- VoiceCall
- WarrantyTerm
- WaveAutoInstallRequest
- WebStoreCatalog
- WebStoreSearchProdSettings
- WorkerCompCoverageClass
- WorkContract
- WorkOrder
- WorkOrderLineItem
- WorkType
- Supported Objects for List Views
- These list views resources support a subset of objects.
- /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}
-
- Account
- AcctMgrTarget
- AccountForecast
- AccountParticipant
- ActionCadence
- ActionPlanItem
- ActionPlanTemplate
- ActionPlanTemplateItem
- ActionPlanTemplateItemValue
- ActionPlanTemplateVersion
- Address
- AiVisitRecommendation
- AiVisitRecommendRequest
- AssessmentTask
- AssessmentTaskOrder
- Asset
- AssetStatePeriod
- AssetWarranty
- BasicDataRecord
- BusinessLicenseApplication
- BusinessMilestone
- BusinessProfile
- Campaign
- Case
- Claim
- ClaimCase
- ClaimItem
- ClaimParticipant
- Contact
- ContactRequest
- ContentVersion
- Contract
- CoverageType
- CustomerProperty
- Custom Object
- DataStreamDefinition
- DeleteEvent
- DeliveryTask
- Entitlement
- EntityMilestone
- EnvironmentHubMember
- Examination
- Expense
- ExpenseReport
- ExpenseReportEntry
- Image
- IndividualApplication
- InspectionAssessmentInd
- InsuranceClaimAsset
- InsurancePolicy
- InsurancePolicyAsset
- InsurancePolicyCoverage
- InsurancePolicyMemberAsset
- InsurancePolicyParticipant
- InsuranceProfile
- JobProfile
- Lead
- ListEmail
- LoanApplicant
- LoanApplicationLiability
- Location
- LoyaltyBenefit
- LoyaltyBenefitType
- LoyaltyLedger
- LoyaltyProgram
- LoyaltyProgramCurrency
- LoyaltyProgramMember
- LoyaltyProgramPartner
- LoyaltyTier
- LoyaltyTierBenefit
- LoyaltyTierGroup
- MaintenancePlan
- MessagingChannel
- MessagingSession
- OccupationLicenseApplication
- OperatingHours
- OperatingHoursHoliday
- Opportunity
- OpportunityParticipant
- Order
- OrderSummary
- PersonExamination
- PersonLifeEvent
- PgmRebateTypBnftMapping
- PreliminaryApplicationRef
- Pricebook2
- Producer
- ProducerPolicyAssignment
- Product2
- ProductCoverage
- ProductServiceCampaign
- ProductTransfer
- ProductWarrantyTerm
- ProgramRebateType
- ProgramRebateTypeFilter
- ProgramRebateTypeBenefit
- ProgramRebateTypePayout
- ProgramRebateTypPayoutSrc
- Promotion
- Quote
- RebateMemberProductAggregate
- RebatePayment
- RebatePayoutAdjustment
- RebateProgram
- RebateProgramMember
- RebateProgramMemberPayout
- RebateProgramPayoutPeriod
- RecordsetFilterCriteria
- RecordsetFilterCriteriaRule
- RegulatoryAuthority
- RegulatoryAuthorizationType
- RegulatoryCode
- RegulatoryCodeAssessmentInd
- RegulatoryCodeViolation
- ResourcePreference
- RetailVisitKpi
- RetailVisitWorkTask
- RetailVisitWorkTaskOrder
- ReturnOrder
- SalesAgreement
- SalesAgreementProduct
- SecuritiesHolding
- ServiceAppointment
- ServiceContract
- ServiceCrew
- ServiceCrewMember
- ServiceResource
- ServiceResourceSkill
- ServiceTerritory
- ServiceTerritoryMember
- Shift
- ShiftPattern
- Shipment
- SignatureTask
- SignatureTaskLineItem
- SkillRequirement
- SocialPost
- SurveyInvitation
- SurveyResponse
- SurveySubject
- Tenant
- TimeSheet
- TimeSheetEntry
- TrainingCourseParticipant
- TransactionJournal
- TrnCourse
- ViolationEnforcementAction
- ViolationType
- Visit
- Visitor
- VoiceCall
- WarrantyTerm
- WorkerCompCoverageClass
- WorkOrder
- WorkOrderLineItem
- WorkType
- Supported Objects for MRU List Views
- These MRU list views resources support a subset of objects.
-
- Account
- AccountForecast
- AccountParticipant
- AcctMgrTarget
- ActionCadence
- ActionPlanItem
- ActionPlanTemplate
- ActionPlanTemplateItem
- ActionPlanTemplateItemValue
- ActionPlanTemplateVersion
- Address
- AiVisitRecommendation
- AiVisitRecommendRequest
- AssessmentTask
- AssessmentTaskContentDocument
- AssessmentTaskOrder
- Asset
- AssetWarranty
- BusinessLicenseApplication
- BusinessMilestone
- BusinessProfile
- Campaign
- Case
- Claim
- ClaimCase
- ClaimItem
- ClaimParticipant
- Contact
- ContactRequest
- Contract
- CoverageType
- CustomerProperty
- DataStreamDefinition
- DeliveryTask
- Entitlement
- EnvironmentHubMember
- Examination
- Expense
- ExpenseReport
- ExpenseReportEntry
- Image
- IndividualApplication
- InspectionAssessmentInd
- InsuranceClaimAsset
- InsurancePolicy
- InsurancePolicyAsset
- InsurancePolicyCoverage
- InsurancePolicyMemberAsset
- InsurancePolicyParticipant
- InsuranceProfile
- JobProfile
- Lead
- ListEmail
- LoanApplicant
- LoanApplicationLiability
- Location
- LoyaltyBenefit
- LoyaltyBenefitType
- LoyaltyLedger
- LoyaltyProgram
- LoyaltyProgramCurrency
- LoyaltyProgramPartner
- LoyaltyTier
- LoyaltyTierBenefit
- LoyaltyTierGroup
- MaintenancePlan
- MessagingChannel
- MessagingSession
- OccupationLicenseApplication
- OperatingHours
- OperatingHoursHoliday
- Opportunity
- OpportunityParticipant
- Order
- OrderSummary
- PersonExamination
- PersonLifeEvent
- PgmRebateTypBnftMapping
- PreliminaryApplicationRef
- Pricebook2
- Producer
- ProducerPolicyAssignment
- Product2
- ProductCoverage
- ProductServiceCampaign
- ProductTransfer
- ProductWarrantyTerm
- ProgramRebateType
- ProgramRebateTypeBenefit
- ProgramRebateTypeFilter
- ProgramRebateTypePayout
- ProgramRebateTypPayoutSrc
- Promotion
- Quote
- RebateMemberProductAggregate
- RebatePayment
- RebatePayoutAdjustment
- RebateProgram
- RebateProgramMember
- RebateProgramMemberPayout
- RebateProgramPayoutPeriod
- RecordsetFilterCriteria
- RecordsetFilterCriteriaRule
- RegulatoryAuthority
- RegulatoryAuthorizationType
- RegulatoryCodeAssessmentInd
- RegulatoryCodeViolation
- ResourcePreference
- RetailVisitKpi
- RetailVisitWorkTask
- RetailVisitWorkTaskOrder
- ReturnOrder
- SalesAgreement
- SalesAgreementProduct
- SecuritiesHolding
- ServiceAppointment
- ServiceResource
- ServiceTerritory
- ServiceTerritoryMember
- ServiceResourceSkill
- ServiceCrew
- ServiceCrewMember
- ServiceContract
- Shift
- ShiftPattern
- Shipment
- SignatureTask
- SignatureTaskLineItem
- SkillRequirement
- SocialPost
- SurveyInvitation
- SurveyResponse
- SurveySubject
- TimeSheet
- TimeSheetEntry
- TrainingCourseParticipant
- TransactionJournal
- TrnCourse
- ViolationEnforcementAction
- ViolationType
- Visit
- Visitor
- VoiceCall
- WarrantyTerm
- WorkerCompCoverageClass
- WorkType
- WorkOrder
- WorkOrderLineItem
- These related lists resources support a subset of objects.
- /ui-api/related-list-records/${parentRecordId}/${relatedListId}
- /ui-api/related-list-records/batch/${parentRecordId}/${relatedListIds}
- /ui-api/related-list-count/${parentRecordId}/${relatedListId}
- /ui-api/related-list-count/batch/${parentRecordId}/${relatedListIds}
- /ui-api/related-list-info/${parentObjectApiName}
- /ui-api/related-list-info/${parentObjectApiName}/${relatedListId}
- /ui-api/related-list-info/batch/${parentObjectApiName}/${relatedListIds}
-
- ActionPlanTemplateItem
- ActionPlanTemplateItemValue
- ActionPlanTemplateVersion
- AssessmentTask
- Asset
- AuthorizedInsuranceLine
- Claim
- ClaimCase
- ClaimItem
- ClaimParticipant
- ContactEncounterParticipant
- Contract
- ContractContactRole
- ContractLineItem
- CoverageType
- DistributorAuthorization
- Entitlement
- EntityMilestone
- Expense
- HealthcareProvider
- Individual
- InsuranceClaimAsset
- InsurancePolicyAsset
- InsurancePolicyCoverage
- InsurancePolicyParticipant
- JobProfile
- LoanApplicant
- LoanApplicantDeclaration
- LoanApplicantEmployment
- LoanApplicantIncome
- LoanApplicationAsset
- LoanApplicationFinancial
- LoanApplicationTitleHolder
- Location
- LoyaltyBenefit
- LoyaltyProgramMember
- LoyaltyProgramPartner
- LoyaltyTier
- LoyaltyTierGroup
- MaintenanceAsset
- MaintenancePlan
- MessagingSession
- ProducerPolicyAssignment
- ProductCoverage
- ProductTransfer
- ProductWarrantyTerm
- ProgramRebateType
- ProgramRebateTypeBenefit
- ProgramRebateTypeFilter
- ProgramRebateTypePayout
- Quote
- QuoteDocument
- QuoteLineItem
- RebateMemberProductAggregate
- RebatePayoutAdjustment
- RebateProgramMember
- RebateProgramMemberPayout
- RebateProgramPayoutPeriod
- RecordsetFilterCriteria
- ResourceAbsence
- ResourcePreference
- RetailVisitKpi
- ReturnOrder
- ReturnOrderLineItem
- SalesAgreementProduct
- SalesAgreementProductSchedule
- ServiceAppointment
- ServiceContract
- ServiceCrewMember
- ServiceResource
- ServiceResourceSkill
- SkillRequirement
- SurveyResponse
- Tenant
- TimeSheet
- UsageEntitlement
- UsageEntitlementPeriod
- User
- Visitor
- WorkOrder
- WorkOrderLineItem
- WorkPlanSelectionRule
- WorkPlanTemplate
- WorkStep
- WorkStepTemplate