Get started

The BoostMail /v1 API lets you manage subscribers, segments, campaigns, and transactional email over HTTPS. Every request targets the versioned base URL https://api.boostmail.app/v1. This page takes you from a fresh account to your first successful call.

Mint a key and make a call

1. Mint an API key. In the BoostMail dashboard, go to Account -> API Keys -> Create key. Name the key and pick its scopes. For this quickstart, include subscribers:read, the scope GET /v1/subscribers requires. Copy the secret when it appears: BoostMail shows it once, at creation, and cannot display it again. See the Authentication guide for the full key format and scope list.

2. Set the key as an environment variable. Store it as BOOSTMAIL_API_KEY so you never paste it directly into a command or commit it to source control.

   export BOOSTMAIL_API_KEY="bm_live_..."

3. Make your first authenticated call. GET /v1/subscribers with a bearer token is the simplest read in the API:

   curl https://api.boostmail.app/v1/subscribers \
     -H "Authorization: Bearer $BOOSTMAIL_API_KEY"

   A successful call returns a paginated envelope:

   {
     "data": [...],
     "next_cursor": null
   }

   If you get 403 insufficient_scope instead, the key you minted does not include subscribers:read. Mint a new key with that scope, or see the Authentication guide for how scopes work.

Next steps

• Read the Guides for the contract every endpoint shares: authentication, rate limits, errors, pagination, versioning, sending, and suppression.
• Follow the Send a transactional email tutorial for a complete, end-to-end example.

Note

Swap in the real key BoostMail showed you, not the placeholder above. Every call in these docs targets the same /v1 base URL introduced above: https://api.boostmail.app/v1.