API reference

This reference is generated from Lekalao’s OpenAPI document. Each page describes one route: parameters, body, answers, and examples in curl, JavaScript, PHP and Python.

Try it

The Try it button on each page sends a real call:

In Server, replace lekalao.example.com with the address of your own Lekalao.
In Authorization, paste a token (Settings → API tokens).

The playground acts on your real data. Use a test team, or a Read token, to explore.

In short


Address	`https://your-lekalao/api/v1`
Authentication	`Authorization: Bearer <token>`. See Authentication.
Format	JSON; `Accept: application/json`.
Identifiers	`id`, a uuid.
Pagination	`page`, `per_page` (100 at most); `links` and `meta` in the answer.
Rate limit	120 calls a minute per token.
Idempotency	The `Idempotency-Key` header on writes, for 24 hours.

The detail is in Conventions and Errors.

The OpenAPI document

Every installation serves its own, up to date with its version:

curl https://lekalao.example.com/api/v1/openapi.json -o lekalao-openapi.json

Import it into Postman or Insomnia, or generate a client:

npx @openapitools/openapi-generator-cli generate \
  -i lekalao-openapi.json -g typescript-fetch -o ./lekalao-client

The document published here is written out in full and more detailed; the one from the installation follows its routes exactly.

Overview

Lists

Subscribers

Tags

Segments

Imports

Templates

Campaigns

Automations

Transactional e-mails

Revenue

Platform

Try it

In short

The OpenAPI document

​Try it

​In short

​The OpenAPI document

Try it

In short

The OpenAPI document