Salesforce Experience Cloud
Salesforce Experience Cloud List Views API

List view data and metadata
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: Salesforce Experience Cloud Salesforce CMS Connect Actions List Views API
  description: Manage content, channels, and media in Experience Cloud CMS. Supports creating, updating, and delivering managed content across channels for headless content delivery and site publishing. Part of the Salesforce Connect REST API.
  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/connect/cms
  description: Salesforce Instance
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance name or custom domain
security:
- oauth2: []
- bearerAuth: []
tags:
- name: List Views
  description: List view data and metadata
paths:
  /list-ui/{listViewId}:
    get:
      operationId: getListViewData
      summary: Salesforce Experience Cloud Get List View Data
      description: Returns the records and metadata for a specific list view including columns, sorting, filtering, and the record data. Used to render list views in custom UIs.
      tags:
      - List Views
      parameters:
      - name: listViewId
        in: path
        required: true
        description: The ID of the list view
        schema:
          type: string
      - name: fields
        in: query
        description: Additional fields to include in list view records
        schema:
          type: string
      - name: optionalFields
        in: query
        description: Optional fields to include if accessible
        schema:
          type: string
      - name: pageSize
        in: query
        description: Number of records per page
        schema:
          type: integer
          default: 50
      - name: pageToken
        in: query
        description: Token for the next page of records
        schema:
          type: string
      - name: sortBy
        in: query
        description: Field API name to sort by
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved list view data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListViewRepresentation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /list-ui/{objectApiName}:
    get:
      operationId: getListViewsByObject
      summary: Salesforce Experience Cloud Get List Views for Object
      description: Returns all available list views for the specified object type. Includes list view ID, label, and developer name.
      tags:
      - List Views
      parameters:
      - $ref: '#/components/parameters/ObjectApiName'
      - name: pageSize
        in: query
        description: Number of list views per page
        schema:
          type: integer
          default: 20
      - name: pageToken
        in: query
        description: Token for the next page
        schema:
          type: string
      - name: q
        in: query
        description: Search term to filter list views by name
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved list views
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListViewSummaryCollection'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    FieldValueRepresentation:
      type: object
      description: Field value with display formatting
      properties:
        displayValue:
          type: string
          description: Formatted display value (locale-aware)
        value:
          description: Raw field value
    ListViewSummaryCollection:
      type: object
      description: Collection of list view summaries
      properties:
        count:
          type: integer
        currentPageToken:
          type: string
        currentPageUrl:
          type: string
          format: uri
        lists:
          type: array
          items:
            type: object
            properties:
              apiName:
                type: string
              id:
                type: string
              label:
                type: string
              listUiUrl:
                type: string
                format: uri
        nextPageToken:
          type: string
        nextPageUrl:
          type: string
          format: uri
        objectApiName:
          type: string
    RecordRepresentation:
      type: object
      description: Representation of a record with field values
      properties:
        apiName:
          type: string
          description: API name of the sObject type
        childRelationships:
          type: object
          additionalProperties:
            type: object
        eTag:
          type: string
          description: Entity tag for optimistic concurrency
        fields:
          type: object
          description: Map of field API names to field values
          additionalProperties:
            $ref: '#/components/schemas/FieldValueRepresentation'
        id:
          type: string
          description: Record ID
        lastModifiedById:
          type: string
        lastModifiedDate:
          type: string
          format: date-time
        recordTypeId:
          type: string
        recordTypeInfo:
          type: object
          properties:
            available:
              type: boolean
            defaultRecordTypeMapping:
              type: boolean
            master:
              type: boolean
            name:
              type: string
            recordTypeId:
              type: string
        systemModstamp:
          type: string
          format: date-time
        weakEtag:
          type: integer
    ErrorResponse:
      type: object
      description: Standard error response
      properties:
        errorCode:
          type: string
        message:
          type: string
    ListViewInfo:
      type: object
      description: Metadata about a list view
      properties:
        cloneable:
          type: boolean
        createable:
          type: boolean
        deletable:
          type: boolean
        displayColumns:
          type: array
          items:
            type: object
            properties:
              fieldApiName:
                type: string
              label:
                type: string
              sortable:
                type: boolean
        eTag:
          type: string
        filterLogicString:
          type: string
        filteredByInfo:
          type: array
          items:
            type: object
        id:
          type: string
        label:
          type: string
        listReference:
          type: object
          properties:
            id:
              type: string
            listViewApiName:
              type: string
            objectApiName:
              type: string
            type:
              type: string
        orderedByInfo:
          type: array
          items:
            type: object
            properties:
              fieldApiName:
                type: string
              isAscending:
                type: boolean
              label:
                type: string
        updateable:
          type: boolean
        visibility:
          type: string
          enum:
          - Private
          - Public
    ListViewRepresentation:
      type: object
      description: List view data and metadata
      properties:
        count:
          type: integer
        currentPageToken:
          type: string
        currentPageUrl:
          type: string
          format: uri
        info:
          $ref: '#/components/schemas/ListViewInfo'
        nextPageToken:
          type: string
        nextPageUrl:
          type: string
          format: uri
        previousPageToken:
          type: string
        previousPageUrl:
          type: string
          format: uri
        records:
          type: array
          items:
            $ref: '#/components/schemas/RecordRepresentation'
  responses:
    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'
  parameters:
    ObjectApiName:
      name: objectApiName
      in: path
      required: true
      description: The API name of the Salesforce object (e.g., Account, Contact)
      schema:
        type: string
  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
            content: Manage CMS content
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
      description: Bearer token obtained through OAuth 2.0 flow
Salesforce Experience Cloud List Views API

Documentation

Specifications

Other Resources

OpenAPI Specification
