Your first request

The Emailx API uses https://app.emailx.ai. Production access is not enabled in the current beta: a request can return 503 api_disabled. Ask your Emailx contact for an enabled environment and its matching key before continuing. A test key and a production key are not interchangeable.

Request beta access

Create an expiring key in Emailx under Settings > API keys. For this quickstart, choose workspaces:read and campaigns:read. Agency client access also needs agency:read and a current assignment.

Choose the correct environment

Use the canonical application origin for an enabled production account:

export EMAILX_BASE_URL="https://app.emailx.ai"

Load EMAILX_API_KEY from your secret manager. Never put a key in a URL, committed file, or copied support log. Production access requires a separately enabled account and key. A test key reads real staging records; it does not create a sandbox.

Check your connection

curl "$EMAILX_BASE_URL/api/v1/me" \
  -H "Authorization: Bearer $EMAILX_API_KEY"

import json, os, urllib.request
request = urllib.request.Request(
    os.environ["EMAILX_BASE_URL"] + "/api/v1/me",
    headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"]},
)
with urllib.request.urlopen(request, timeout=30) as response:
    print(json.load(response))

const response = await fetch(`${process.env.EMAILX_BASE_URL}/api/v1/me`, {
  headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}` },
  signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`Emailx: ${response.status}`);
console.log(await response.json());

A successful response wraps credential metadata in data. Check the environment, expiry and scopes before continuing. See Inspect your API key for the response fields.

Discover current access

curl "$EMAILX_BASE_URL/api/v1/workspaces?limit=25" \
  -H "Authorization: Bearer $EMAILX_API_KEY"

Choose an ID from data. Configured grants on the credential are an upper bound; this list reflects current access.

Read a channel's campaigns

Replace 123 with the workspace ID you just received.

curl "$EMAILX_BASE_URL/api/v1/workspaces/123/campaigns?channel=linkedin&limit=25" \
  -H "Authorization: Bearer $EMAILX_API_KEY"

An empty data array is a valid result. Use next_cursor when has_more is true.

Next steps

Prepare a draft, handle pagination, or install the CLI. Run API requests from your backend or terminal; browser session cookies do not authenticate them.

Get started

Sending well

Build a workflow

Your first request

Next steps

​Next steps

Next steps