Docs/Getting started

Start here

You need one thing to start: an API key. It takes a minute to create, and the API is included in every Emailchaser plan, trial included.

Create your API key on the API & MCP page

  1. Open API & MCP, API keys tab in the app. It is also API & MCP in the side menu.
  2. Click Create API Key.
  3. Give the key a name you will recognize later, such as "CRM sync" or "Clay".
  4. Under Access, pick Read & write or Read only. Authentication explains the difference.
  5. Click Create, then copy the key.

We show a key only once. Store it somewhere safe, such as your password manager or your server's secrets. If you lose it, delete it and create a new one.

Keys you create never expire. You can pause, resume or delete a key at any time on the same page, and a paused or deleted key stops working at once.

Check the key works with one request

Save the key in an environment variable, then list your campaigns. It reads only, so it works with either kind of key:

Shell
export EMAILCHASER_API_KEY="run_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

curl "https://api.emailchaser.com/r/campaigns?limit=1" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY"

A 200 with your newest campaign means you're connected. A 401 means the key or the header is wrong: Authentication lists every message and what it means.

Then build the thing you came for

A few things worth knowing before you write code

  • Every path starts with https://api.emailchaser.com/r, and every body is JSON.
  • Most IDs are integers that can be larger than 2^32, so store them as 64-bit integers or strings. Some IDs are strings with a prefix, such as s_ for a Lead Finder search.
  • Dates are ISO 8601 (RFC 3339), normally in UTC. Filters such as since and until also accept a plain YYYY-MM-DD, read as midnight UTC.
  • Most calls answer in a few seconds. Two can take up to two minutes: POST /copilot/plan and POST /dfy/orders. Give those a client timeout of at least 130 seconds.
  • Some calls cost money or credits: buying credits, ordering domains and mailboxes, verifying emails, importing people from Lead Finder, sourcing prospects and approving an Autopilot run. Each one says so on its reference page. Searching Lead Finder and counting an audience are free.
  • Retries are safe for most calls, because POST /leads matches leads by email and updates do the same thing twice. Three calls are not: POST /campaigns and POST /webhooks create a new item each time, and POST /credits/purchase charges your card each time. POST /dfy/orders is safe to retry with the same Idempotency-Key.

Questions about the API? Email support@emailchaser.com.