Getting started

Lueira's Public API (v1) is a REST API over HTTPS, with JSON requests and responses. Every endpoint hangs off a single base URL.

Base URL

shell

https://api.lueira.com/api/v1

1. Create an API key

From Lueira's admin panel, go to Settings → Developers → API Keys and create a new key, choosing the scopes you need.

The secret is only ever shown once, right after creation. Store it in a secrets manager: if you lose it you'll need to rotate the key.

2. Make your first request

Every authenticated request uses an Authorization: Bearer header. For example, to list your customers:

curl

curl "https://api.lueira.com/api/v1/customers" \
  -H "Authorization: Bearer luk_your_key_here"

3. Node.js example

Node.js

const res = await fetch("https://api.lueira.com/api/v1/customers", {
  headers: { Authorization: `Bearer ${process.env.LUEIRA_API_KEY}` },
});
const { data } = await res.json();
console.log(data);

4. Python example

Python

import os, requests

res = requests.get(
    "https://api.lueira.com/api/v1/customers",
    headers={"Authorization": f"Bearer {os.environ['LUEIRA_API_KEY']}"},
)
print(res.json())

5. Next steps

Authentication — key format and available scopes.
Pagination — how to page through large lists.
Errors — the shape of error responses.
Rate limits — how many requests you can make per minute and per month.
Webhooks — get real-time notifications for events on your account.
MCP server — connect AI assistants to your account.