Salesforce

Salesforce Lightning API

The Lightning API from Salesforce — 6 operation(s) for lightning.

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-lightning-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-lightning-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Lightning 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: Lightning
paths:
  /data/v64.0/ui-api/actions/flexipage/{FLEXIPAGE_NAMES}:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Get Lightning Page Actions
      description: Get the actions on Lightning pages (FlexiPages).
      operationId: GetLightningPageActions
      parameters:
      - name: FLEXIPAGE_NAMES
        in: path
        description: A Lightning page name, or a comma-delimited list of Lightning page names.
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 11:45:49 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-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: '"ff4486597111fb5e059e5dab793c8231--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:
                allOf:
                - $ref: '#/components/schemas/GetLightningPageActions'
                - examples:
                  - actions:
                      Sample_Lightning_page:
                        actions:
                        - actionListContext: Flexipage
                          actionTarget: /services/data/v58.0/quickActions/LogACall/describe
                          actionTargetType: Describe
                          apiName: Global.LogACall
                          externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
                          id: 0JV4H0000295294WAA
                          isMassAction: 'false'
                          label: Log a Call
                          lwcComponent: null
                          primaryColor: 06A59A
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: null
                          sourceObject: Sample_Lightning_page
                          subtype: LogACall
                          targetObject: Task
                          targetUrl: null
                          type: QuickAction
                        - actionListContext: Flexipage
                          actionTarget: /services/data/v58.0/quickActions/NewAccount/describe
                          actionTargetType: Describe
                          apiName: Global.NewAccount
                          externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png
                          id: 0JV4H0000295295WAA
                          isMassAction: 'false'
                          label: New Account
                          lwcComponent: null
                          primaryColor: 5867E8
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: null
                          sourceObject: Sample_Lightning_page
                          subtype: Create
                          targetObject: Account
                          targetUrl: null
                          type: QuickAction
                        links: []
                        url: /services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page
                    eTag: ff4486597111fb5e059e5dab793c8231
                    url: /services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page
                contentMediaType: application/json;charset=UTF-8
              example:
                actions:
                  Sample_Lightning_page:
                    actions:
                    - actionListContext: Flexipage
                      actionTarget: /services/data/v58.0/quickActions/LogACall/describe
                      actionTargetType: Describe
                      apiName: Global.LogACall
                      externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
                      id: 0JV4H0000295294WAA
                      isMassAction: 'false'
                      label: Log a Call
                      lwcComponent: null
                      primaryColor: 06A59A
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: null
                      sourceObject: Sample_Lightning_page
                      subtype: LogACall
                      targetObject: Task
                      targetUrl: null
                      type: QuickAction
                    - actionListContext: Flexipage
                      actionTarget: /services/data/v58.0/quickActions/NewAccount/describe
                      actionTargetType: Describe
                      apiName: Global.NewAccount
                      externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png
                      id: 0JV4H0000295295WAA
                      isMassAction: 'false'
                      label: New Account
                      lwcComponent: null
                      primaryColor: 5867E8
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: null
                      sourceObject: Sample_Lightning_page
                      subtype: Create
                      targetObject: Account
                      targetUrl: null
                      type: QuickAction
                    links: []
                    url: /services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page
                eTag: ff4486597111fb5e059e5dab793c8231
                url: /services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/LightningToggleMetrics:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Lightning Toggle Metrics
      description: 'Return details about users who switched between Salesforce Classic and Lightning Experience.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_togglemetrics.htm'
      operationId: LightningToggleMetrics
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/LightningUsageByBrowserMetrics:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Lightning Usage by Page
      description: 'Represents standard pages users viewed most frequently in Lightning Experience.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebypagemetrics.htm'
      operationId: LightningUsagebyPage
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/LightningUsageByAppTypeMetrics:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Lightning Usage by App Type
      description: 'Return the total number of Lightning Experience and Salesforce Mobile users.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyapptypemetrics.htm'
      operationId: LightningUsagebyAppType
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/LightningUsageByFlexiPageMetrics:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Lightning Usage by Flexipage
      description: 'Return details about the custom pages viewed most frequently in Lightning Experience.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyflexipagemetrics.htm'
      operationId: LightningUsagebyFlexiPage
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/LightningExitByPageMetrics:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Lightning Exit by Page Metrics
      description: 'Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm'
      operationId: LightningExitbyPageMetrics
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Actions17:
      title: Actions17
      required:
      - Sample_Lightning_page
      type: object
      properties:
        Sample_Lightning_page:
          $ref: '#/components/schemas/SampleLightningPage'
      examples:
      - Sample_Lightning_page:
          actions:
          - actionListContext: Flexipage
            actionTarget: /services/data/v58.0/quickActions/LogACall/describe
            actionTargetType: Describe
            apiName: Global.LogACall
            externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g
            iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
            id: 0JV4H0000295294WAA
            isMassAction: 'false'
            label: Log a Call
            lwcComponent: null
            primaryColor: 06A59A
            relatedListRecordId: null
            relatedSourceObject: null
            section: null
            sourceObject: Sample_Lightning_page
            subtype: LogACall
            targetObject: Task
            targetUrl: null
            type: QuickAction
          - actionListContext: Flexipage
            actionTarget: /services/data/v58.0/quickActions/NewAccount/describe
            actionTargetType: Describe
            apiName: Global.NewAccount
            externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s
            iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png
            id: 0JV4H0000295295WAA
            isMassAction: 'false'
            label: New Account
            lwcComponent: null
            primaryColor: 5867E8
            relatedListRecordId: null
            relatedSourceObject: null
            section: null
            sourceObject: Sample_Lightning_page
            subtype: Create
            targetObject: Account
            targetUrl: null
            type: QuickAction
          links: []
          url: /services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page
    Actions18:
      title: Actions18
      required:
      - actionListContext
      - actionTarget
      - actionTargetType
      - apiName
      - externalId
      - iconUrl
      - id
      - isMassAction
      - label
      - lwcComponent
      - primaryColor
      - relatedListRecordId
      - relatedSourceObject
      - section
      - sourceObject
      - subtype
      - targetObject
      - targetUrl
      - type
      type: object
      properties:
        actionListContext:
          type: string
          example: example_value
        actionTarget:
          type: string
          example: example_value
        actionTargetType:
          type: string
          example: example_value
        apiName:
          type: string
          example: example_value
        externalId:
          type: string
          example: '500123'
        iconUrl:
          type: string
          example: https://www.example.com
        id:
          type: string
          example: abc123
        isMassAction:
          type: string
          example: example_value
        label:
          type: string
          example: Example Title
        lwcComponent:
          type:
          - string
          - 'null'
          example: example_value
        primaryColor:
          type: string
          example: example_value
        relatedListRecordId:
          type:
          - string
          - 'null'
          example: '500123'
        relatedSourceObject:
          type:
          - string
          - 'null'
          example: example_value
        section:
          type:
          - string
          - 'null'
          example: example_value
        sourceObject:
          type: string
          example: example_value
        subtype:
          type: string
          example: example_value
        targetObject:
          type: string
          example: example_value
        targetUrl:
          type:
          - string
          - 'null'
          example: https://www.example.com
        type:
          type: string
          example: example_value
      examples:
      - actionListContext: Flexipage
        actionTarget: /services/data/v58.0/quickActions/LogACall/describe
        actionTargetType: Describe
        apiName: Global.LogACall
        externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g
        iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
        id: 0JV4H0000295294WAA
        isMassAction: 'false'
        label: Log a Call
        lwcComponent: null
        primaryColor: 06A59A
        relatedListRecordId: null
        relatedSourceObject: null
        section: null
        sourceObject: Sample_Lightning_page
        subtype: LogACall
        targetObject: Task
        targetUrl: null
        type: QuickAction
    GetLightningPageActions:
      title: GetLightningPageActions
      required:
      - actions
      - eTag
      - url
      type: object
      properties:
        actions:
          $ref: '#/components/schemas/Actions17'
        eTag:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - actions:
          Sample_Lightning_page:
            actions:
            - actionListContext: Flexipage
              actionTarget: /services/data/v58.0/quickActions/LogACall/describe
              actionTargetType: Describe
              apiName: Global.LogACall
              externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g
              iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
              id: 0JV4H0000295294WAA
              isMassAction: 'false'
              label: Log a Call
              lwcComponent: null
              primaryColor: 06A59A
              relatedListRecordId: null
              relatedSourceObject: null
              section: null
              sourceObject: Sample_Lightning_page
              subtype: LogACall
              targetObject: Task
              targetUrl: null
              type: QuickAction
            - actionListContext: Flexipage
              actionTarget: /services/data/v58.0/quickActions/NewAccount/describe
              actionTargetType: Describe
              apiName: Global.NewAccount
              externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s
              iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png
              id: 0JV4H0000295295WAA
              isMassAction: 'false'
              label: New Account
              lwcComponent: null
              primaryColor: 5867E8
              relatedListRecordId: null
              relatedSourceObject: null
              section: null
              sourceObject: Sample_Lightning_page
              subtype: Create
              targetObject: Account
              targetUrl: null
              type: QuickAction
            links: []
            url: /services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page
        eTag: ff4486597111fb5e059e5dab793c8231
        url: /services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page
    SampleLightningPage:
      title: SampleLightningPage
      required:
      - actions
      - links
      - url
      type: object
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/Actions18'
          description: ''
          example: []
        links:
          type: array
          items:
            type: string
          description: ''
          example: []
        url:
          type: string
          example: https://www.example.com
      examples:
      - actions:
        - actionListContext: Flexipage
          actionTarget: /services/data/v58.0/quickActions/LogACall/describe
          actionTargetType: Describe
          apiName: Global.LogACall
          externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2g
          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/log_a_call_120.png
          id: 0JV4H0000295294WAA
          isMassAction: 'false'
          label: Log a Call
          lwcComponent: null
          primaryColor: 06A59A
          relatedListRecordId: null
          relatedSourceObject: null
          section: null
          sourceObject: Sample_Lightning_page
          subtype: LogACall
          targetObject: Task
          targetUrl: null
          type: QuickAction
        - actionListContext: Flexipage
          actionTarget: /services/data/v58.0/quickActions/NewAccount/describe
          actionTargetType: Describe
          apiName: Global.NewAccount
          externalId: 00D58000000arpq:Sample_Lightning_page::Flexipage:Desktop:09D58000002PE2s
          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_account_120.png
          id: 0JV4H0000295295WAA
          isMassAction: 'false'
          label: New Account
          lwcComponent: null
          primaryColor: 5867E8
          relatedListRecordId: null
          relatedSourceObject: null
          section: null
          sourceObject: Sample_Lightning_page
          subtype: Create
          targetObject: Account
          targetUrl: null
          type: QuickAction
        links: []
        url: /services/data/v58.0/ui-api/actions/flexipage/Sample_Lightning_page
  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}".

        '