Use the REST API

Create an API key

1. Open Settings → API keys

   Only the workspace owner can create or revoke keys.

2. Create and copy the key

   Copy the full key when InboxJoy shows it. The full key appears once, at creation. InboxJoy stores only a hash and cannot show the key again.

3. Revoke the key when needed

   Revoking a key disables it immediately.

Authenticate each request

Send the key as a Bearer token on every request. The base URL is https://inboxjoy.online/api. Every endpoint lives under /v1.

curl https://inboxjoy.online/api/v1/leads \
  -H "Authorization: Bearer ij_your_key_here"

Keep owner and admin tasks in the browser

API keys are scoped to sending and content operations. They cannot call routes for API key management, team management, or billing. They also cannot delete a workspace. Those actions require a browser session signed in as an owner or admin.

List active leads

curl "https://inboxjoy.online/api/v1/leads?status=active&page=1&pageSize=25" \
  -H "Authorization: Bearer ij_your_key_here"

Import leads

curl https://inboxjoy.online/api/v1/leads/import \
  -H "Authorization: Bearer ij_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "leads": [
      { "email": "ada@example.com", "firstName": "Ada", "company": "Example Co" }
    ],
    "listName": "Q3 outbound"
  }'

Handle rate limits

Requests are limited to 300 per minute per workspace. If you exceed the limit, InboxJoy returns a 429 response with a message that tells you how long to wait before retrying.

Use the available endpoint guidance

A full OpenAPI reference covering every endpoint is coming. Until then, this page and the example requests cover the most common operations: leads, campaigns, and imports.