Lydira API
TR

v1

Lydira API

One key, one base path, and a vocabulary that does not change between endpoints. Push bookings out of your own system, read them back as a change feed, and let a webhook tell you when something moved.

Start hereBrowse the reference58endpoints, generated from the specification
Pick your address first. Lydira runs one server per region and your account is on exactly one of them, so the samples on this site start on a placeholder. Choose your cell at the top of the page and they all switch to it. It is the host in your Lydira tab's address bar, and Settings → API keys states it next to the key.

Bearer auth

One key per integration, scoped and revocable. No OAuth dance, no refresh.

Cursor paging

Stable under writes. Walk page.next_cursor until has_more is false.

Idempotent writes

Send Idempotency-Key and a retry replays the first answer instead of writing twice.

Honest errors

Every refusal names a code you can branch on, not just a status.

Your first call

Health needs no key, so it is the one request that can only fail for the right reasons. If this answers, your base URL is right.

GET /api/v1/health
curl https://YOUR-CELL.lydira.com/api/v1/health

{ "ok": true, "api": "v1" }

Then prove the key works

/me resolves the account behind the key, the companies you can file against, and the plan features that decide which endpoints answer at all.

GET /api/v1/me
curl https://YOUR-CELL.lydira.com/api/v1/me \
  -H 'Authorization: Bearer sek_YOUR_API_KEY'

Guides

Quickstart

Key to first booking in four calls.

Authentication

Scopes, roles, IP allowlists, rotation.

Conventions

Envelopes, paging, idempotency, rate limits.

Errors

Every code, what it means, whether to retry.

Webhooks

Three events, ten record types, one signature.

Import entities

The catalogue you push bookings into.

API reference

This reference is generated from the API's own specification. An endpoint cannot ship without appearing here. 58 ops · 15 entities · 23 error codes