Getting started with the API

The MailPurse REST API exposes your account’s lists, contacts, campaigns, servers and billing over JSON over HTTPS. All endpoints are prefixed with /api.

API Overview 1 min read Updated 1 day ago

The MailPurse REST API exposes your account’s lists, contacts, campaigns, servers and billing over JSON over HTTPS.

Base URL

All endpoints are prefixed with /api. The customer API lives under /api/v1:

code
https://your-domain.example/api/v1

First request

  1. Create an API token in your account.
  2. Send it as a Bearer token.
  3. Try listing your lists:
bash
curl /api/v1/lists \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Permissions

Each endpoint checks a granular permission such as lists.permissions.can_access_lists. If a request returns 403, enable that permission on the token’s customer account.

Was this page helpful?