Quickstart

Three steps from zero to your first authenticated call. Every request hits the versioned /api/v1 surface and authenticates with a Bearer token.

1 · Create an API key

In Settings → API keys, create a scoped key. It is shown once, stored hashed, and revocable at any time.

# 1. Create a scoped key in Settings → API keys.
#    Keys are shown once, scoped (e.g. customers.read), and revocable.
export VIMUB_KEY="vimub_live_..."

2 · Make a request

# 2. Make your first request — auth is a Bearer token.
curl https://vimub.com/api/v1/customers \
  -H "Authorization: Bearer $VIMUB_KEY"

# → { "data": [ ... ], "has_more": true, "next_cursor": "2026-06-01T..." }

3 · Paginate

List endpoints return { data, has_more, next_cursor }. Pass next_cursor back as ?cursor= to walk the full set.

# 3. Paginate with the cursor (most-recent first, ?limit= up to 100).
curl "https://vimub.com/api/v1/customers?limit=100&cursor=2026-06-01T09:30:00Z" \
  -H "Authorization: Bearer $VIMUB_KEY"

Full endpoint reference (customers, reviews, bookings, invoices, campaigns, webhooks) with try-it-out is at /docs/api. For event subscriptions, see the webhooks guide.