How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Salesforce Lightning API

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

Salesforce Lightning API is one of 294 APIs that Salesforce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Lightning. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 6 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v63.0.

Requests are made against a single base URL, https://{instance}.salesforce.com/services/data/v{version}/jobs.

6 operations 6 paths 4 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v63.0
Base URL
https://{instance}.salesforce.com/services/data
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Salesforce Lightning API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {accesstoken}".

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

Lightning 6
GET
/data/v64.0/ui-api/actions/flexipage/{FLEXIPAGE_NAMES}
Salesforce Get Lightning Page Actions
GetLightningPageActions 1 param → 200
GET
/data/v64.0/sobjects/LightningToggleMetrics
Salesforce Lightning Toggle Metrics
LightningToggleMetrics 1 param → 200
GET
/data/v64.0/sobjects/LightningUsageByBrowserMetrics
Salesforce Lightning Usage by Page
LightningUsagebyPage 1 param → 200
GET
/data/v64.0/sobjects/LightningUsageByAppTypeMetrics
Salesforce Lightning Usage by App Type
LightningUsagebyAppType 1 param → 200
GET
/data/v64.0/sobjects/LightningUsageByFlexiPageMetrics
Salesforce Lightning Usage by Flexipage
LightningUsagebyFlexiPage 1 param → 200
GET
/data/v64.0/sobjects/LightningExitByPageMetrics
Salesforce Lightning Exit by Page Metrics
LightningExitbyPageMetrics 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Actions18 (19 properties), SampleLightningPage (3 properties), GetLightningPageActions (3 properties), Actions17 (1 property). Each schema is shown below with its type and property counts.

Actions17
object
1 property 1 required
Actions18
object
19 properties 19 required
GetLightningPageActions
object
3 properties 3 required
SampleLightningPage
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

salesforce-lightning-api-openapi.yml Raw ↑

Other APIs Salesforce publishes across the network.

Salesforce REST API
Salesforce SOAP API
Salesforce Bulk API
Salesforce Streaming API
Salesforce Metadata API
Salesforce Tooling API
Salesforce Connect API (Chatter)
Salesforce Analytics REST API
Salesforce Reports and Dashboards REST API
Salesforce Einstein Platform Services API
Salesforce Einstein Prediction Service API
Salesforce GraphQL API
Where this information came from

This is an independent, third-party profile of Salesforce Lightning API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.