Salesforce Experience Cloud Salesforce User Interface API — List Views

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Experience Cloud Salesforce User Interface API — List Views
  description: 'Salesforce Experience Cloud Salesforce User Interface API — List Views. 2 operations. Lead operation: Salesforce
    Experience Cloud Get List View Data. Self-contained Naftiko capability covering one Salesforce Experience Cloud business
    surface.'
  tags:
  - Salesforce Experience Cloud
  - List Views
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_EXPERIENCE_CLOUD_API_KEY: SALESFORCE_EXPERIENCE_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: user-interface-list-views
    baseUri: https://{instance}.salesforce.com/services/data/v59.0/ui-api
    description: Salesforce Experience Cloud Salesforce User Interface API — List Views business capability. Self-contained,
      no shared references.
    resources:
    - name: list-ui-listViewId
      path: /list-ui/{listViewId}
      operations:
      - name: getlistviewdata
        method: GET
        description: Salesforce Experience Cloud Get List View Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: listViewId
          in: path
          type: string
          description: The ID of the list view
          required: true
        - name: fields
          in: query
          type: string
          description: Additional fields to include in list view records
        - name: optionalFields
          in: query
          type: string
          description: Optional fields to include if accessible
        - name: pageSize
          in: query
          type: integer
          description: Number of records per page
        - name: pageToken
          in: query
          type: string
          description: Token for the next page of records
        - name: sortBy
          in: query
          type: string
          description: Field API name to sort by
    - name: list-ui-objectApiName
      path: /list-ui/{objectApiName}
      operations:
      - name: getlistviewsbyobject
        method: GET
        description: Salesforce Experience Cloud Get List Views for Object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: pageSize
          in: query
          type: integer
          description: Number of list views per page
        - name: pageToken
          in: query
          type: string
          description: Token for the next page
        - name: q
          in: query
          type: string
          description: Search term to filter list views by name
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_EXPERIENCE_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: user-interface-list-views-rest
    port: 8080
    description: REST adapter for Salesforce Experience Cloud Salesforce User Interface API — List Views. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/list-ui/{listviewid}
      name: list-ui-listviewid
      description: REST surface for list-ui-listViewId.
      operations:
      - method: GET
        name: getlistviewdata
        description: Salesforce Experience Cloud Get List View Data
        call: user-interface-list-views.getlistviewdata
        with:
          listViewId: rest.listViewId
          fields: rest.fields
          optionalFields: rest.optionalFields
          pageSize: rest.pageSize
          pageToken: rest.pageToken
          sortBy: rest.sortBy
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/list-ui/{objectapiname}
      name: list-ui-objectapiname
      description: REST surface for list-ui-objectApiName.
      operations:
      - method: GET
        name: getlistviewsbyobject
        description: Salesforce Experience Cloud Get List Views for Object
        call: user-interface-list-views.getlistviewsbyobject
        with:
          pageSize: rest.pageSize
          pageToken: rest.pageToken
          q: rest.q
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: user-interface-list-views-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Experience Cloud Salesforce User Interface API — List Views. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: salesforce-experience-cloud-get-list
      description: Salesforce Experience Cloud Get List View Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: user-interface-list-views.getlistviewdata
      with:
        listViewId: tools.listViewId
        fields: tools.fields
        optionalFields: tools.optionalFields
        pageSize: tools.pageSize
        pageToken: tools.pageToken
        sortBy: tools.sortBy
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-experience-cloud-get-list-2
      description: Salesforce Experience Cloud Get List Views for Object
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: user-interface-list-views.getlistviewsbyobject
      with:
        pageSize: tools.pageSize
        pageToken: tools.pageToken
        q: tools.q
      outputParameters:
      - type: object
        mapping: $.