Getting Started

The Demoboost Public API lets you read your organization's data programmatically. You can access users and organization info. The Public API is enabled for your organization by Demoboost — once it is, you can create API keys and start making requests immediately.

Step 1 — Create an API Key

Once the add-on is enabled, go to Settings → API Keys → New Key. Give it a name and, optionally, an expiry date. When you click Create, the full secret is shown once — copy it immediately.

The secret is not stored by Demoboost. If you lose it, revoke the key and create a new one.

Step 2 — Make Your First Call

Pass the key in the X-Api-Key header. Here's a quick health-check with curl:

curl https://open.demoboost.com/v1/ping \
  -H "X-Api-Key: dmb_live_<your-secret>"

Expected response:

{"status":"ok"}

Step 3 — List Your Users

curl https://open.demoboost.com/v1/users \
  -H "X-Api-Key: dmb_live_<your-secret>"

The response is paginated. Pass cursor from nextCursor to fetch the next page:

curl "https://open.demoboost.com/v1/users?cursor=<nextCursor>" \
  -H "X-Api-Key: dmb_live_<your-secret>"

Base URL

All API requests go to https://open.demoboost.com.

Next Steps