Salesforce Sales Cloud Salesforce User Interface API — Layouts

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Sales Cloud Salesforce User Interface API — Layouts
  description: 'Salesforce Sales Cloud Salesforce User Interface API — Layouts. 1 operations. Lead operation: Salesforce Sales
    Cloud Get record layout metadata. Self-contained Naftiko capability covering one Salesforce Sales Cloud business surface.'
  tags:
  - Salesforce Sales Cloud
  - Layouts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_SALES_CLOUD_API_KEY: SALESFORCE_SALES_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: ui-layouts
    baseUri: https://{instance}.salesforce.com/services/data/v59.0/ui-api
    description: Salesforce Sales Cloud Salesforce User Interface API — Layouts business capability. Self-contained, no shared
      references.
    resources:
    - name: layout-objectApiName
      path: /layout/{objectApiName}
      operations:
      - name: getrecordlayout
        method: GET
        description: Salesforce Sales Cloud Get record layout metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectApiName
          in: path
          type: string
          description: The API name of the sObject
          required: true
        - name: layoutType
          in: query
          type: string
        - name: mode
          in: query
          type: string
        - name: recordTypeId
          in: query
          type: string
          description: The record type ID for record-type-specific layouts
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_SALES_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: ui-layouts-rest
    port: 8080
    description: REST adapter for Salesforce Sales Cloud Salesforce User Interface API — Layouts. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/layout/{objectapiname}
      name: layout-objectapiname
      description: REST surface for layout-objectApiName.
      operations:
      - method: GET
        name: getrecordlayout
        description: Salesforce Sales Cloud Get record layout metadata
        call: ui-layouts.getrecordlayout
        with:
          objectApiName: rest.objectApiName
          layoutType: rest.layoutType
          mode: rest.mode
          recordTypeId: rest.recordTypeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ui-layouts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Sales Cloud Salesforce User Interface API — Layouts. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: salesforce-sales-cloud-get-record
      description: Salesforce Sales Cloud Get record layout metadata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ui-layouts.getrecordlayout
      with:
        objectApiName: tools.objectApiName
        layoutType: tools.layoutType
        mode: tools.mode
        recordTypeId: tools.recordTypeId
      outputParameters:
      - type: object
        mapping: $.