Getting started

Quick start

Create an account, finish onboarding, copy your publishable key, and verify the API with a single request.

1. Create your workspace

Sign up (email or OAuth). Complete onboarding so your tenant, base API key, and defaults exist. You'll land in the Dashboard.

2. Copy your publishable key

Go to Settings → API keys. Your base publishable key is shown once per rotation; it is safe to use in browsers and embeds when scoped appropriately.

Key format

Keys look like baas_publishable_… (publishable) or baas_server_secret_… (secret, server-only). There is no separate npm SDK—use HTTP from any stack.

3. Call widget availability (publishable key)

Replace YOUR_APP_URL with your deployment origin (e.g. https://your-app.vercel.app) and paste your key. This uses the public widget surface (no dashboard login required).

cURL
curl -sS "YOUR_APP_URL/api/widget/availability?key=baas_publishable_YOUR_KEY&resource_id=YOUR_RESOURCE_UUID&start_date=2025-01-01&end_date=2025-01-31"

You can pass the key as x-publishable-key or Authorization: Bearer … instead of ?key=—see Authentication.

4. Use dashboard APIs while logged in

From the same origin as the app, with an active session (e.g. in the dashboard or your own authenticated pages), you can call routes like GET /api/resources—the session cookie identifies your tenant.

Browser / same-origin fetch
// Run from a page on YOUR_APP_URL while logged in
const res = await fetch('/api/resources')
const data = await res.json()
console.log(data.resources)

Next steps