Skip to content

Getting started

The Teamander Mail API is a REST API served over HTTPS at https://mail.teamander.com/v1. Requests and responses are JSON. Every request authenticates with an API key sent as a Bearer token.

  1. Get an API key. Create one from your dashboard, or with the POST /v1/api-keys endpoint if you already have a key with the apikey:manage scope. The raw key (tmk_...) is shown once — store it in a secret manager.

  2. Add and verify a sending domain (for production). Call POST /v1/domains, publish the returned SPF/DKIM/DMARC records at your DNS provider, then POST /v1/domains/{domain}/verify.

  3. Send an email.

    Terminal window
    curl https://mail.teamander.com/v1/emails/send \
    -H "Authorization: Bearer $TEAMANDER_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
    "to": "jane@example.com",
    "from": "billing@yourdomain.com",
    "subject": "Your receipt",
    "html": "<h1>Thanks!</h1><p>Your receipt is attached.</p>"
    }'

A successful send returns 201 with the queued recipients:

{
"queued": [
{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "recipient": "jane@example.com", "status": "queued" }
]
}

All endpoints live under the /v1 prefix:

https://mail.teamander.com/v1