Skip to content
Inboxical Docs

Quickstart

1. Get your API key

Section titled “1. Get your API key”

Sign up at inboxical.com and copy your API key from the dashboard under API Keys.

API_KEY=ixk_live_...

2. Create a test inbox

Section titled “2. Create a test inbox”
Terminal window
curl -X POST https://api.inboxical.com/v1/inboxes \
  -H "X-API-Key: $API_KEY"
{
  "id": "ix_3f9a",
  "email_address": "[email protected]",
  "name": null,
  "created_at": "2026-03-21T12:00:00Z"
}

3. Send an email to it

Section titled “3. Send an email to it”

Point your app at the inbox address:

await myApp.register({ email: '[email protected]' })

Or send directly via any SMTP client or your existing email service.

4. Fetch messages

Section titled “4. Fetch messages”
Terminal window
curl https://api.inboxical.com/v1/inboxes/ix_3f9a/messages \
  -H "X-API-Key: $API_KEY"
[
  {
    "id": "msg_7b2c",
    "inbox_id": "ix_3f9a",
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Welcome to MyApp!",
    "text": "Thanks for signing up...",
    "html": "<h1>Thanks for signing up...</h1>",
    "received_at": "2026-03-21T12:00:03Z"
  }
]

5. Assert and clean up

Section titled “5. Assert and clean up”
expect(messages[0].subject).toBe('Welcome to MyApp!')


// Delete the inbox when done
await api.delete(`/inboxes/${inbox.id}`)

Next steps

Section titled “Next steps”