Salesforce Experience Cloud

Salesforce Experience Cloud Favorites API

User favorites management

Documentation GitHub OpenAPI

Operations 3

GET /favorites Salesforce Experience Cloud Get Favorites #

POST /favorites Salesforce Experience Cloud Add a Favorite #

DELETE /favorites/{favoriteId} Salesforce Experience Cloud Remove a Favorite #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/salesforce-experience-cloud-favorites-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Salesforce Experience Cloud Salesforce User Interface…
  description: Access record data, layouts, list views, and navigation items for building custom user interfaces. Powers Lightning web components in Experience Cloud sites with metadata-driven UI rendering. Returns both data and metadata in a single response.
  version: 59.0.0
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Master Subscription Agreement
    url: https://www.salesforce.com/company/legal/sfdc-website-terms-of-service/
servers:
- url: https://{instance}.salesforce.com/services/data/v59.0/ui-api
  description: Salesforce Instance
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance name or custom domain
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Favorites
  description: User favorites management
paths:
  /favorites:
    get:
      operationId: getFavorites
      summary: Salesforce Experience Cloud Get Favorites
      description: Returns the list of favorites for the context user, including records, list views, and other favorited items.
      tags:
      - Favorites
      responses:
        '200':
          description: Successfully retrieved favorites
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FavoritesRepresentation'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: addFavorite
      summary: Salesforce Experience Cloud Add a Favorite
      description: Adds a record, list view, or other item to the user's favorites.
      tags:
      - Favorites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FavoriteInput'
      responses:
        '201':
          description: Favorite added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Favorite'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /favorites/{favoriteId}:
    delete:
      operationId: removeFavorite
      summary: Salesforce Experience Cloud Remove a Favorite
      description: Removes the specified item from the user's favorites.
      tags:
      - Favorites
      parameters:
      - name: favoriteId
        in: path
        required: true
        description: The ID of the favorite to remove
        schema:
          type: string
      responses:
        '204':
          description: Favorite removed successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ErrorResponse'
  schemas:
    FavoritesRepresentation:
      type: object
      description: User's favorites
      properties:
        favorites:
          type: array
          items:
            $ref: '#/components/schemas/Favorite'
    Favorite:
      type: object
      description: A user favorite item
      properties:
        color:
          type: string
        iconUrl:
          type: string
          format: uri
        id:
          type: string
        name:
          type: string
        sortOrder:
          type: integer
        target:
          type: string
        targetType:
          type: string
          enum:
          - Record
          - ListView
          - Object
          - Dashboard
          - Report
    ErrorResponse:
      type: object
      description: Standard error response
      properties:
        errorCode:
          type: string
        message:
          type: string
    FavoriteInput:
      type: object
      description: Input for adding a favorite
      required:
      - name
      - target
      - targetType
      properties:
        name:
          type: string
          description: Name of the favorite
        sortOrder:
          type: integer
          description: Sort position
        target:
          type: string
          description: ID or reference of the item to favorite
        targetType:
          type: string
          description: Type of item being favorited
          enum:
          - Record
          - ListView
          - Object
  securitySchemes:
    oauth2:
      type: oauth2
      description: Salesforce OAuth 2.0 authentication
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your data
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
      description: Bearer token obtained through OAuth 2.0 flow