How to Get Started with the Demoboost API

The Demoboost Public API allows you to connect Demoboost with other tools and access your organization's data programmatically.

With the API, you can retrieve organization information and user data to build integrations and automate workflows.

In this guide, we'll show you how to generate an API key, authenticate your requests, and start using the Demoboost API.

Step 1: Navigate to API Settings

1. Select Settings from the left-hand navigation menu.
2. Open the API Keys tab.
3. Click Generate new key.

This will open a window where you can configure your new API key.

Step 2: Generate Your API Key

In the Generate API key window, configure the following:

1. Key name: Give your API key a descriptive name to help you identify its purpose, such as "Production integration" or "Internal reporting".
2. Expiry date (optional): Set a date after which the API key will automatically expire. Leave this field empty if you don't want to set an expiration date.

Once you've entered the details, click Generate key.

Your new API key will be created and displayed.

Important: Your full API key is shown only once. Copy it immediately and store it securely. If you lose it, you'll need to revoke the existing key and generate a new one.

Step 3: Authenticate Your API Requests

Now that you've generated an API key, you're ready to connect to the Demoboost Public API.

All authenticated API requests require your API key to be included in the X-Api-Key header.

The API uses the following base URL:

https://open.demoboost.com

For example, to retrieve a list of users in your organization, you can make the following request:

curl https://open.demoboost.com/v1/users \

-H "X-Api-Key: YOUR_API_KEY"

Replace YOUR_API_KEY with the key you generated in Step 3.

If your request is successful, the API will return the requested user data.

For a complete explanation of authentication methods, visit the Demoboost Authentication Guide.

Step 4: Managing Your API Keys

To manage your API credentials, return to Settings → API Keys.

For security, we recommend creating separate API keys for different integrations, setting expiration dates where appropriate, and revoking any keys that are no longer needed.

Important: Keep your API keys private and never include them in publicly accessible code or repositories.

For more technical details, including available endpoints, authentication methods, rate limits, and code examples, visit the Demoboost Public API Documentation.