api_service: UI API
compatibility_target: v63.0
entry_points:
- label: Shared Integration API Index
  url: https://developer.salesforce.com/devcenter/integration-apis
- label: UI API Overview
  url: https://developer.salesforce.com/docs/atlas.en-us.254.0.uiapi.meta/uiapi/ui_api_resources_overview.htm
- label: UI API Requests Overview
  url: https://developer.salesforce.com/docs/atlas.en-us.254.0.uiapi.meta/uiapi/ui_api_requests_overview.htm
- label: UI API Responses Overview
  url: https://developer.salesforce.com/docs/atlas.en-us.254.0.uiapi.meta/uiapi/ui_api_responses_overview.htm
categories:
- category: Apps
  endpoints:
  - name: Get Apps
    method: GET
    path: /services/data/v63.0/ui-api/apps
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-apps-api
    coverage: covered
    test_file: apps/get_apps_live_test.go
  - name: Get Last Selected App
    method: GET
    path: /services/data/v63.0/ui-api/apps/selected
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-apps-api
    coverage: covered
    test_file: apps/get_selected_app_live_test.go
  - name: Get an App
    method: GET
    path: /services/data/v63.0/ui-api/apps/{appId}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-apps-api
    coverage: covered
    test_file: apps/get_selected_app_live_test.go
  - name: Update Last Selected App
    method: PATCH
    path: /services/data/v63.0/ui-api/apps/{appId}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-apps-api
    coverage: covered
    test_file: apps/patch_selected_app_live_test.go
  - name: Get Personalized Navigation Items
    method: GET
    path: /services/data/v63.0/ui-api/apps/{appId}/user-nav-items
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-apps-api
    coverage: covered
    test_file: apps/get_user_nav_items_live_test.go
  - name: Update Personalized Navigation Items
    method: PUT
    path: /services/data/v63.0/ui-api/apps/{appId}/user-nav-items
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-apps-api
    coverage: covered
    test_file: apps/put_user_nav_items_live_test.go
- category: Actions
  endpoints:
  - name: Get Lightning Page Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/flexipage/{flexipageNames}
    doc: todo
    coverage: covered
    test_file: actions/get_flexipage_actions_live_test.go
  - name: Get Global Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/global
    doc: todo
    coverage: covered
    test_file: actions/get_global_actions_live_test.go
  - name: Get List View Chart Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/list-view-chart/{objectApiName}
    doc: todo
    coverage: covered
    test_file: actions/get_list_view_chart_actions_live_test.go
  - name: Get List View Record Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/list-view-record/{recordIds}
    doc: todo
    coverage: covered
    test_file: actions/get_list_view_record_actions_live_test.go
  - name: Get List View Header Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/list-view/{listViewIds}
    doc: todo
    coverage: covered
    test_file: actions/get_list_view_actions_live_test.go
  - name: Get Lookup Field Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/lookup/{objectApiNames}
    doc: todo
    coverage: covered
    test_file: actions/get_lookup_actions_live_test.go
  - name: Get MRU List View Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/mru-list/{objectApiNames}
    doc: todo
    coverage: covered
    test_file: actions/get_mru_list_actions_live_test.go
  - name: Get Photo Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/photo/{recordIds}
    doc: todo
    coverage: covered
    test_file: actions/get_photo_actions_live_test.go
  - name: Get Record Detail Page Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/record/{recordIds}
    doc: todo
    coverage: covered
    test_file: actions/get_record_actions_live_test.go
  - name: Get Record Edit Page Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/record/{recordId}/record-edit
    doc: todo
    coverage: covered
    test_file: actions/get_record_edit_actions_live_test.go
  - name: Get Related List Record Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/record/{recordId}/related-list-record/{relatedListRecordIds}
    doc: todo
    coverage: covered
    test_file: actions/get_related_list_record_actions_live_test.go
  - name: Get Related List Actions
    method: GET
    path: /services/data/v63.0/ui-api/actions/record/{recordId}/related-list/{relatedListIds}
    doc: todo
    coverage: covered
    test_file: actions/get_related_list_actions_live_test.go
- category: Favorites
  endpoints:
  - name: Get Favorites
    method: GET
    path: /services/data/v63.0/ui-api/favorites
    doc: todo
    coverage: covered
    test_file: favorites/get_favorites_live_test.go
  - name: Create a Favorite
    method: POST
    path: /services/data/v63.0/ui-api/favorites
    doc: todo
    coverage: covered
    test_file: favorites/helpers_test.go
  - name: Update a Batch of Favorites
    method: PUT
    path: /services/data/v63.0/ui-api/favorites/batch
    doc: todo
    coverage: covered
    test_file: favorites/update_favorites_batch_live_test.go
  - name: Delete a Favorite
    method: DELETE
    path: /services/data/v63.0/ui-api/favorites/{favoriteId}
    doc: todo
    coverage: covered
    test_file: favorites/delete_favorite_live_test.go
  - name: Get a Favorite
    method: GET
    path: /services/data/v63.0/ui-api/favorites/{favoriteId}
    doc: todo
    coverage: covered
    test_file: favorites/get_favorite_live_test.go
  - name: Update a Favorite
    method: PATCH
    path: /services/data/v63.0/ui-api/favorites/{favoriteId}
    doc: todo
    coverage: covered
    test_file: favorites/update_favorite_live_test.go
  - name: Update Usage of a Favorite
    method: PATCH
    path: /services/data/v63.0/ui-api/favorites/{favoriteId}/usage
    doc: todo
    coverage: covered
    test_file: favorites/update_favorite_usage_live_test.go
- category: Layouts
  endpoints:
  - name: Get Record Layout Metadata
    method: GET
    path: /services/data/v63.0/ui-api/layout/{objectApiName}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-layout-api
    coverage: covered
    test_file: records/get_layout_live_test.go
- category: List Views
  endpoints:
  - name: Get List View Metadata by ID
    method: GET
    path: /services/data/v63.0/ui-api/list-info/{listViewId}
    doc: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-ui-list-api.html?type=Develop
    coverage: covered
    test_file: lists/get_list_info_by_object_live_test.go
  - name: Get List Views for an Object
    method: GET
    path: /services/data/v63.0/ui-api/list-info/{objectApiName}
    doc: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-ui-list-api.html?type=Develop
    coverage: covered
    test_file: lists/get_list_info_by_object_live_test.go
  - name: Get List View Metadata by API Name
    method: GET
    path: /services/data/v63.0/ui-api/list-info/{objectApiName}/{listViewApiName}
    doc: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-ui-list-api.html?type=Develop
    coverage: covered
    test_file: lists/get_list_info_live_test.go
  - name: Get List View Records by ID
    method: GET
    path: /services/data/v63.0/ui-api/list-records/{listViewId}
    doc: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-ui-list-api.html?type=Develop
    coverage: covered
    test_file: lists/get_list_records_by_id_live_test.go
  - name: Get List View Records by API Name
    method: GET
    path: /services/data/v63.0/ui-api/list-records/{objectApiName}/{listViewApiName}
    doc: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-ui-list-api.html?type=Develop
    coverage: covered
    test_file: lists/get_list_records_by_api_name_live_test.go
  - name: Get List View Records
    method: POST
    path: /services/data/v63.0/ui-api/list-records/{objectApiName}/{listViewApiName}
    doc: https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/lightning-ui-list-api.html?type=Develop
    coverage: covered
    test_file: lists/post_list_records_by_api_name_live_test.go
- category: Lookups
  endpoints:
  - name: Get Lookup Field Suggestions
    method: GET
    path: /services/data/v63.0/ui-api/lookups/{objectApiName}/{fieldApiName}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: lookups/get_lookup_suggestions_live_test.go
  - name: Get Lookup Field Suggestions for a Specified Object
    method: GET
    path: /services/data/v63.0/ui-api/lookups/{objectApiName}/{fieldApiName}/{targetApiName}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: lookups/get_lookup_suggestions_target_live_test.go
- category: Navigation
  endpoints:
  - name: Get All Navigation Items
    method: GET
    path: /services/data/v63.0/ui-api/nav-items
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-apps-api
    coverage: covered
    test_file: navigation/get_nav_items_live_test.go
- category: Object Info
  endpoints:
  - name: Get a Directory of Supported Objects
    method: GET
    path: /services/data/v63.0/ui-api/object-info
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-object-info-api
    coverage: covered
    test_file: records/get_object_info_directory_live_test.go
  - name: Get Object Metadata
    method: GET
    path: /services/data/v63.0/ui-api/object-info/{objectApiName}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-object-info-api
    coverage: covered
    test_file: records/get_object_info_live_test.go
  - name: Get Values for All Picklist Fields of a Record Type
    method: GET
    path: /services/data/v63.0/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-object-info-api
    coverage: covered
    test_file: records/get_picklist_values_by_record_type_live_test.go
  - name: Get Values for a Picklist Field
    method: GET
    path: /services/data/v63.0/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-object-info-api
    coverage: covered
    test_file: records/get_picklist_values_by_field_live_test.go
- category: Record Defaults
  endpoints:
  - name: Get Default Values to Clone a Record
    method: GET
    path: /services/data/v63.0/ui-api/record-defaults/clone/{recordId}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/get_record_defaults_live_test.go
  - name: Get Default Values to Create a Record
    method: GET
    path: /services/data/v63.0/ui-api/record-defaults/create/{objectApiName}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/get_record_defaults_live_test.go
- category: Record UI
  endpoints:
  - name: Get Record Data and Object Metadata
    method: GET
    path: /services/data/v63.0/ui-api/record-ui/{recordIds}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/get_record_ui_live_test.go
- category: Records
  endpoints:
  - name: Create a Record
    method: POST
    path: /services/data/v63.0/ui-api/records
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/helpers_test.go
  - name: Get a Batch of Records
    method: GET
    path: /services/data/v63.0/ui-api/records/batch/{recordIds}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/get_records_batch_live_test.go
  - name: Delete a Record
    method: DELETE
    path: /services/data/v63.0/ui-api/records/{recordId}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/delete_record_live_test.go
  - name: Get a Record
    method: GET
    path: /services/data/v63.0/ui-api/records/{recordId}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/get_record_live_test.go
  - name: Update a Record
    method: PATCH
    path: /services/data/v63.0/ui-api/records/{recordId}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/update_record_live_test.go
  - name: Get Child Records
    method: GET
    path: /services/data/v63.0/ui-api/records/{recordId}/child-relationships/{relationshipName}
    doc: https://developer.salesforce.com/docs/component-library/bundle/lightning-ui-record-api
    coverage: covered
    test_file: records/get_child_relationships_live_test.go
- category: Themes
  endpoints:
  - name: Get Active Theme
    method: GET
    path: /services/data/v63.0/ui-api/themes/active
    doc: todo
    coverage: covered
    test_file: themes/get_active_theme_live_test.go