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

Leanplum API

The complete Leanplum REST API as Leanplum itself publishes it — one OpenAPI 3.0.0 document (x-api-id "leanplum-api") covering all 42 methods across eight tags: User Behavior, User Information, Messages, A/B Tests, Files and Variables, Export Data, Import Data and Campaigns. Every call goes to the single endpoint https://api.leanplum.com/api and names its method in an `action` parameter, authenticated with an appId plus a permission-scoped clientKey.

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

Tagged areas include User Behavior, User Information, Message, A/B Tests, and Files and Variables. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 42 operations across 42 paths, organized into 8 resource areas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against 2 base URLs: https://api.leanplum.com, http://api.leanplum.com.

42 operations 42 paths 0 schemas 16 GET26 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.leanplum.com/api
Authentication
API Key, API Key
Resource Areas
8

Authentication & Security 2

Leanplum API declares 2 security schemes for authenticating requests. An API key is passed in the query as appId (appIdQuery). An API key is passed in the query as clientKey (clientKeyQuery). By default, every request must be authenticated.

  • appIdQuery — The application ID. To find yours, select your app in the navigation column, and click Edit Apps. Under Keys, click Show.
  • clientKeyQuery — The client access key. Must be either your production, development, read-only, or data export key, depending on which API method you want to use.

Paths & Operations 42

Across 42 paths, the API surfaces 42 operations — 16 GET, 26 POST. They span 8 resource areas: User Behavior, User Information, Messages, A/B Tests, Files and Variables, Export Data, Import Data, Campaigns. Each is listed below with its method, path, parameters, and response codes.

User Behavior 9
POST
/api?action=advance
advance
body → default
POST
/api?action=pauseState
pauseState
body → default
POST
/api?action=resumeState
resumeState
body → default
POST
/api?action=pauseSession
pauseSession
body → default
POST
/api?action=resumeSession
resumeSession
body → default
POST
/api?action=heartbeat
heartbeat
body → default
POST
/api?action=start
start
body → default
POST
/api?action=stop
stop
body → default
POST
/api?action=track
track
body → default
User Information 7
POST
/api?action=setUserAttributes
setUserAttributes
body → default
POST
/api?action=setDeviceAttributes
setDeviceAttributes
body → default
POST
/api?action=setTrafficSourceInfo
setTrafficSourceInfo
body → default
POST
/api?action=registerDevice
registerDevice
body → default
POST
/api?action=deleteUser
deleteUser
body → default
POST
/api?action=block
block
body → default
POST
/api?action=unblock
unblock
body → default
Messages 7
GET
/api?action=getMessage
getMessage
5 params → default
GET
/api?action=getMessages
getMessages
5 params → default
GET
/api?action=getUnsubscribeCategories
getUnsubscribeCategories
3 params → default
POST
/api?action=sendMessage
sendMessage
body → default
POST
/api?action=addAndroidNotificationChannel
addAndroidNotificationChannel
body → default
GET
/api?action=getAndroidNotificationChannels
getAndroidNotificationChannels
3 params → default
POST
/api?action=deleteAndroidNotificationChannel
deleteAndroidNotificationChannel
body → default
A/B Tests 3
GET
/api?action=getAbTest
getAbTest
5 params → default
GET
/api?action=getAbTests
getAbTests
5 params → default
GET
/api?action=getVariant
getVariant
5 params → default
Files and Variables 5
GET
/api?action=getVars
getVars
8 params → default
POST
/api?action=setVars
setVars
body → default
POST
/api?action=deleteVars
deleteVars
body → default
GET
/api?action=downloadFile
downloadFile
4 params → default
POST
/api?action=uploadFile
uploadFile
body → default
Export Data 8
POST
/api?action=addPostback
addPostback
body → default
GET
/api?action=listPostbacks
listPostbacks
3 params → default
POST
/api?action=deletePostback
deletePostback
body → default
GET
/api?action=exportData
exportData
14 params → default
GET
/api?action=exportReport
exportReport
10 params → default
GET
/api?action=exportUser
exportUser
5 params → default
GET
/api?action=exportUsers
exportUsers
6 params → default
GET
/api?action=getExportResults
getExportResults
4 params → default
Import Data 2
POST
/api?action=multi
multi (CSV)
body → default
GET
/api?action=getMultiResults
getMultiResults
4 params → default
Campaigns 1
POST
/api?action=startCampaign
startCampaign
body → default

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

leanplum-api-openapi.json Raw ↑

Other APIs Leanplum publishes across the network.

Leanplum A/B Tests API
Leanplum Content & Variables API
Leanplum Data Export API
Leanplum Events & Tracking API
Leanplum Messaging API
Leanplum Postbacks & Batch API
Leanplum User & Device Attributes API
Where this information came from

This is an independent, third-party profile of Leanplum 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.