Skip to content

Inboxes

Base URL: https://api.inboxical.com/v1


POST /inboxes

Creates a new isolated test inbox with a unique email address.

Request body (optional JSON)

FieldTypeDescription
namestringHuman-readable label for this inbox

Example

Terminal window
curl -X POST https://api.inboxical.com/v1/inboxes \
-H "X-API-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "signup-test" }'

Response 201

{
"id": "ix_3f9a",
"email_address": "[email protected]",
"name": "signup-test",
"message_count": 0,
"created_at": "2026-03-21T12:00:00Z"
}

GET /inboxes

Returns a paginated list of your inboxes.

Query parameters

ParamDefaultDescription
page1Page number
limit20Items per page (max 100)

Example

Terminal window
curl https://api.inboxical.com/v1/inboxes?page=1&limit=20 \
-H "X-API-Key: $API_KEY"

Response 200

{
"inboxes": [
{
"id": "ix_3f9a",
"email_address": "[email protected]",
"name": "signup-test",
"message_count": 3,
"created_at": "2026-03-21T12:00:00Z"
}
],
"total": 42,
"page": 1,
"limit": 20
}

GET /inboxes/:id

Example

Terminal window
curl https://api.inboxical.com/v1/inboxes/ix_3f9a \
-H "X-API-Key: $API_KEY"

Response 200 — same shape as create response.


DELETE /inboxes/:id

Permanently deletes the inbox and all its messages.

Terminal window
curl -X DELETE https://api.inboxical.com/v1/inboxes/ix_3f9a \
-H "X-API-Key: $API_KEY"

Response 204 — no body.