Resources · API reference

The LiteHQ REST API

Typed, idempotent, paginated. Everything in the product is one HTTP call away.

v1 · stable99.97% uptime

GETPOSTPATCHDELETE

Try a request in 30 seconds

curl

curl https://api.litehq.com/v1/bookings \

-H "Authorization: Bearer $LITEHQ_API_KEY" \

-H "Content-Type: application/json" \

-d '{

"resource_id": "rm_atrium",

"start": "2026-05-22T14:00:00Z",

"duration_minutes": 90,

"booked_by": "mem_lina_p"

# → 201 Created · { id: "bkg_01H...", status: "confirmed", tokens_charged: 3 }

Base URL · https://api.litehq.comGet an API key

Conventions

Predictable shapes. No surprises.

Cursor pagination
Every list endpoint returns a stable cursor. No offset drift on busy tenants.
Idempotency keys
Every POST accepts an `Idempotency-Key` header. Replays return the cached response.
Typed errors
Errors include `code`, `message`, and a docs URL. No HTML pages.

Bookings

Create, modify, and inspect bookings across every resource on the floor.

4 endpoints

GET/v1/bookings
List bookings — filter by resource, member, date range, status.
Try it
POST/v1/bookings
Create a booking. Pricing computed server-side; idempotent on the supplied key.
Try it
PATCH/v1/bookings/:id
Reschedule or update billing mode. Conflicts return 409 with the offending booking id.
Try it
DELETE/v1/bookings/:id
Cancel a booking. Honors the cancellation window and refund policy on the rate card.
Try it

Members

Member CRUD, tier assignments, and badge/door provisioning hooks.

3 endpoints

GET/v1/members
List members across all tenants you have access to. Cursor-paginated.
Try it
POST/v1/members
Invite a new member. Email is dispatched asynchronously — webhook fires on accept.
Try it
PATCH/v1/members/:id
Update tier, profile, or pool allocation. Audited automatically.
Try it

Companies

Tenant companies — billing entities that group members and own bookings.

3 endpoints

GET/v1/companies
List tenant companies for a given host.
Try it
POST/v1/companies
Onboard a new tenant. Triggers the welcome workflow if configured.
Try it
PATCH/v1/companies/:id
Update billing contact, address, or per-tenant pricing overrides.
Try it

Billing

Invoices, token transactions, and Stripe Connect proxies.

3 endpoints

GET/v1/invoices
List invoices. Includes Xero sync status and Stripe PaymentIntent linkage.
Try it
POST/v1/invoices/:id/charge
Trigger an immediate charge against the saved card. Returns the PaymentIntent.
Try it
GET/v1/tokens/transactions
Stream the token ledger. Double-entry; every row balances.
Try it

Visitors

Guest invitations, badge-ins, and on-arrival workflows.

3 endpoints

GET/v1/visitors
List upcoming and historical visits per location.
Try it
POST/v1/visitors
Pre-register a visitor. Generates a QR pass + host notification.
Try it
DELETE/v1/visitors/:id
Cancel an invitation. Suppresses pending host notifications.
Try it

Webhooks

Subscribe to events. Signed payloads, automatic retries with exponential backoff.

3 endpoints

GET/v1/webhooks
List registered endpoints and their delivery health.
Try it
POST/v1/webhooks
Register a new endpoint. URL must respond 2xx to the verification handshake.
Try it
POST/v1/webhooks/:id/replay
Replay a specific delivery. Useful for backfilling after a downtime window.
Try it

Auth

API keys, scoped tokens, and SSO management.

2 endpoints

POST/v1/auth/tokens
Mint a scoped API token. Required scopes and an expiry are mandatory.
Try it
DELETE/v1/auth/tokens/:id
Revoke a token immediately. Cached caller permissions purge within 30s.
Try it

SDKs

Generated from this spec, type-safe on day one.

@litehq/sdkOfficial
TypeScript / Node
npm install @litehq/sdk
README
litehq-pyOfficial
Python ≥3.10
pip install litehq
README
litehq-rbOfficial
Ruby ≥3.2
gem install litehq
README
litehq-goCommunity
Go ≥1.22
go get github.com/litehq/litehq-go
README

Build on the same API the app uses.

No private endpoints. Every action in the calendar is a typed REST call you can make yourself.

Get an API key Read the guides