Salesforce

Salesforce Layout API

The Layout API from Salesforce — 1 operation(s) for layout.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-layout-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-bulk-job-schema.json

OpenAPI Specification

salesforce-layout-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Layout API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Layout
paths:
  /data/v64.0/ui-api/layout/{SOBJECT_API_NAME}:
    parameters: []
    get:
      tags:
      - Layout
      summary: Salesforce Get Record Layout Metadata
      description: Get metadata about page layouts for the specified object type.
      operationId: GetRecordLayoutMetadata
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 27 Sep 2023 15:54:02 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"07ce091fdbe7461d6b2a8813c63d3124--gzip"'
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GetRecordLayoutMetadata'
              examples:
                Getrecordlayoutmetadata200Example:
                  summary: Default GetRecordLayoutMetadata 200 response
                  x-microcks-default: true
                  value:
                    eTag: example_value
                    id: abc123
                    layoutType: example_value
                    mode: example_value
                    objectApiName: example_value
                    recordTypeId: '500123'
                    saveOptions:
                    - example_value
                    sections:
                    - collapsible: true
                      columns: 10
                      heading: example_value
                      id: abc123
                      layoutRows: {}
                      rows: 10
                      useHeading: true
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    LayoutRow1:
      title: LayoutRow1
      required:
      - layoutItems
      type: object
      properties:
        layoutItems:
          type: array
          items:
            $ref: '#/components/schemas/LayoutItem1'
          description: ''
          example: []
      examples:
      - layoutItems:
        - editableForNew: false
          editableForUpdate: false
          label: Account Owner
          layoutComponents:
          - apiName: OwnerId
            componentType: Field
            label: Owner ID
          lookupIdApiName: OwnerId
          required: false
          sortable: false
        - editableForNew: true
          editableForUpdate: true
          label: Rating
          layoutComponents:
          - apiName: Rating
            componentType: Field
            label: Account Rating
          lookupIdApiName: null
          required: false
          sortable: false
    LayoutItem1:
      title: LayoutItem1
      required:
      - editableForNew
      - editableForUpdate
      - label
      - layoutComponents
      - lookupIdApiName
      - required
      - sortable
      type: object
      properties:
        editableForNew:
          type: boolean
          example: true
        editableForUpdate:
          type: boolean
          example: true
        label:
          type: string
          example: Example Title
        layoutComponents:
          type: array
          items:
            $ref: '#/components/schemas/LayoutComponent1'
          description: ''
          example: []
        lookupIdApiName:
          type:
          - string
          - 'null'
          example: example_value
        required:
          type: boolean
          example: true
        sortable:
          type: boolean
          example: true
      examples:
      - editableForNew: false
        editableForUpdate: false
        label: Account Owner
        layoutComponents:
        - apiName: OwnerId
          componentType: Field
          label: Owner ID
        lookupIdApiName: OwnerId
        required: false
        sortable: false
    Section1:
      title: Section1
      required:
      - collapsible
      - columns
      - heading
      - id
      - layoutRows
      - rows
      - useHeading
      type: object
      properties:
        collapsible:
          type: boolean
          example: true
        columns:
          type: integer
          contentEncoding: int32
          example: 10
        heading:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        layoutRows:
          type: array
          items:
            $ref: '#/components/schemas/LayoutRow1'
          description: ''
          example: []
        rows:
          type: integer
          contentEncoding: int32
          example: 10
        useHeading:
          type: boolean
          example: true
      examples:
      - collapsible: false
        columns: 2
        heading: Account Information
        id: 01BB0000002rP1oMAE
        layoutRows:
        - layoutItems:
          - editableForNew: false
            editableForUpdate: false
            label: Account Owner
            layoutComponents:
            - apiName: OwnerId
              componentType: Field
              label: Owner ID
            lookupIdApiName: OwnerId
            required: false
            sortable: false
          - editableForNew: true
            editableForUpdate: true
            label: Rating
            layoutComponents:
            - apiName: Rating
              componentType: Field
              label: Account Rating
            lookupIdApiName: null
            required: false
            sortable: false
        - layoutItems:
          - editableForNew: true
            editableForUpdate: true
            label: Account Name
            layoutComponents:
            - apiName: Name
              componentType: Field
              label: Account Name
            lookupIdApiName: Id
            required: true
            sortable: false
          - editableForNew: true
            editableForUpdate: true
            label: Phone
            layoutComponents:
            - apiName: Phone
              componentType: Field
              label: Account Phone
            lookupIdApiName: null
            required: false
            sortable: false
        - layoutItems:
          - editableForNew: true
            editableForUpdate: true
            label: Parent Account
            layoutComponents:
            - apiName: ParentId
              componentType: Field
              label: Parent Account ID
            lookupIdApiName: ParentId
            required: false
            sortable: false
          - editableForNew: true
            editableForUpdate: true
            label: Fax
            layoutComponents:
            - apiName: Fax
              componentType: Field
              label: Account Fax
            lookupIdApiName: null
            required: false
            sortable: false
        - layoutItems:
          - editableForNew: true
            editableForUpdate: true
            label: Account Number
            layoutComponents:
            - apiName: AccountNumber
              componentType: Field
              label: Account Number
            lookupIdApiName: null
            required: false
            sortable: false
          - editableForNew: true
            editableForUpdate: true
            label: Website
            layoutComponents:
            - apiName: Website
              componentType: Field
              label: Website
            lookupIdApiName: null
            required: false
            sortable: false
        - layoutItems:
          - editableForNew: true
            editableForUpdate: true
            label: Account Site
            layoutComponents:
            - apiName: Site
              componentType: Field
              label: Account Site
            lookupIdApiName: null
            required: false
            sortable: false
          - editableForNew: true
            editableForUpdate: true
            label: Ticker Symbol
            layoutComponents:
            - apiName: TickerSymbol
              componentType: Field
              label: Ticker Symbol
            lookupIdApiName: null
            required: false
            sortable: false
        - layoutItems:
          - editableForNew: true
            editableForUpdate: true
            label: Type
            layoutComponents:
            - apiName: Type
              componentType: Field
              label: Account Type
            lookupIdApiName: null
            required: false
            sortable: false
          - editableForNew: true
            editableForUpdate: true
            label: Ownership
            layoutComponents:
            - apiName: Ownership
              componentType: Field
              label: Ownership
            lookupIdApiName: null
            required: false
            sortable: false
        - layoutItems:
          - editableForNew: true
            editableForUpdate: true
            label: Industry
            layoutComponents:
            - apiName: Industry
              componentType: Field
              label: Industry
            lookupIdApiName: null
            required: false
            sortable: false
          - editableForNew: true
            editableForUpdate: true
            label: Employees
            layoutComponents:
            - apiName: NumberOfEmployees
              componentType: Field
              label: Employees
            lookupIdApiName: null
            required: false
            sortable: false
        - layoutItems:
          - editableForNew: true
            editableForUpdate: true
            label: Annual Revenue
            layoutComponents:
            - apiName: AnnualRevenue
              componentType: Field
              label: Annual Revenue
            lookupIdApiName: null
            required: false
            sortable: false
          - editableForNew: true
            editableForUpdate: true
            label: SIC Code
            layoutComponents:
            - apiName: Sic
              componentType: Field
              label: SIC Code
            lookupIdApiName: null
            required: false
            sortable: false
        rows: 8
        useHeading: false
    LayoutComponent1:
      title: LayoutComponent1
      required:
      - apiName
      - componentType
      - label
      type: object
      properties:
        apiName:
          type:
          - string
          - 'null'
          example: example_value
        componentType:
          type: string
          example: example_value
        label:
          type: string
          example: Example Title
        behavior:
          type: string
          example: example_value
        customLinkUrl:
          type: string
          example: https://www.example.com
      examples:
      - apiName: OwnerId
        componentType: Field
        label: Owner ID
    GetRecordLayoutMetadata:
      title: GetRecordLayoutMetadata
      required:
      - eTag
      - id
      - layoutType
      - mode
      - objectApiName
      - recordTypeId
      - saveOptions
      - sections
      type: object
      properties:
        eTag:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        layoutType:
          type: string
          example: example_value
        mode:
          type: string
          example: example_value
        objectApiName:
          type: string
          example: example_value
        recordTypeId:
          type: string
          example: '500123'
        saveOptions:
          type: array
          items:
            type: string
          description: ''
          example: []
        sections:
          type: array
          items:
            $ref: '#/components/schemas/Section1'
          description: ''
          example: []
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '