Quickstart

This Quickstart takes you from zero to your first successful call against the Poptin API. You'll create an API key, authenticate a request, list your poptins, and confirm the response - without writing any code.

Prerequisites

• An active Poptin account with permission to create API keys.
• The ability to send an authenticated HTTPS request - or use the Try It explorer built into the API Reference.

That's it. No SDK, local setup, or webhook configuration required to complete this Quickstart.

Step 1 - Create an API key

1. Sign in to the Poptin app.
2. Go to Settings → API keys.
3. Create a new key. It will start with pk_live_ and is shown only once at creation - copy it immediately and store it in a secure secret manager.
4. Note the account (or subaccount) the key belongs to. Keys are scoped to the account they were created for and cannot cross accounts.

If you lose a key, revoke it and create a new one. Never commit keys to source control or paste them into client-side code.

Step 2 - Know the base URL

Every Public API operation lives under a single base URL:

https://api.popt.in/v1

Endpoint paths in the API Reference are appended to this base. No environment switches, no regional hosts.

Step 3 - Make your first call

The fastest way to verify your key works is the Try It explorer in the API Reference.

1. Open the API Reference.
2. Pick a safe read-only operation to start with - list poptins (your popups and forms) is the recommended first call.
3. In the Authentication panel, paste your pk_live_… key. Try It sends it as a bearer token on the Authorization header automatically.
4. Click Try It.

Prefer your own HTTP client? Point it at the same operation, send Authorization: Bearer pk_live_…, and you'll get the same result. Executable request and response samples live on each Reference page.

Step 4 - Confirm success

A successful call returns an HTTP 2xx status and a JSON body containing the poptins on your account. If the account is new and has no poptins yet, you'll still get a success response with an empty result set - that also confirms your key is valid.

All successful responses follow a consistent shape. See Response envelope for the full structure and how to read paginated results.

If the call fails, the two most common causes are a missing or malformed Authorization header and a key that belongs to a different account than the data you're trying to read.

Next steps