Salesforce Experience Cloud

Salesforce Experience Cloud List Views API

List view data and metadata

GitHub OpenAPI

Operations 2

GET /list-ui/{listViewId} Salesforce Experience Cloud Get List View Data #
GET /list-ui/{objectApiName} Salesforce Experience Cloud Get List Views for Object #

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.exp_cloud_apis.meta/exp_cloud_apis/
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_oauth_and_connected_apps.htm
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.communities_dev.meta/communities_dev/communities_dev_intro_before.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickstart_dev_org.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_cms.htm
📖
GettingStarted
https://developer.salesforce.com/docs/platform/cms/guide/cms-developer-guide.html
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.exp_cloud_lwr.meta/exp_cloud_lwr/template_overview.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.graphql.meta/graphql/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.graphql.meta/graphql/
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_managed_content_resources.htm
📖
GettingStarted
https://developer.salesforce.com/docs/platform/cms/guide/cms-dev-retrieve-cms-content-with-a-connected-app.html
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_cms_delivery_content.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce-experience-cloud/refs/heads/main/openapi/salesforce-experience-cloud-list-views-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://www.postman.com/salesforce-developers/workspace/salesforce-developers
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/features_communities.htm
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_cms_content.htm
🔗
Schema
https://developer.salesforce.com/docs/atlas.en-us.graphql.meta/graphql/graphql_schema.htm
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/salesforce-experience-cloud/refs/heads/main/graphql/salesforce-experience-cloud-graphql.md
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_managed_content_enhanced_resources.htm
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_cms_contents.htm
🔗
Reference
https://developer.salesforce.com/docs/atlas.en-us.exp_cloud_lwr.meta/exp_cloud_lwr/get_started_comp_api.htm

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-list-views-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

salesforce-experience-cloud-list-views-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Salesforce Experience Cloud Salesforce User Interface List…
  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: 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:
  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'
  schemas:
    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
    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
    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
    ErrorResponse:
      type: object
      description: Standard error response
      properties:
        errorCode:
          type: string
        message:
          type: string
    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'
  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
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
      description: Bearer token obtained through OAuth 2.0 flow