Skip to content
Documentation/API reference
API · emails

Retrieve email

GET /api/v2/emails/{id}

Authorization

emails:read. Use a workspace-scoped bearer key or an authorized user session.

Parameters

All resource access is checked against the selected workspace and user permissions.

NameTypeContract
idpath · requiredResource UUID

Request

Set INBOXIT_API_KEY in your server environment. The CLI can also use an authenticated user session.

Example
curl -X GET 'https://inboxit.wtf/api/v2/emails/RESOURCE_UUID' \
  -H "Authorization: Bearer $INBOXIT_API_KEY"

CLI equivalent

Use INBOXIT_TOKEN for a scoped key, or inboxit login for a user session.

Example
inboxit emails get --id RESOURCE_UUID

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example
{
  "id": "EMAIL_UUID",
  "status": "delivered",
  "track_opens": true,
  "track_clicks": true,
  "open_count": 1,
  "click_count": 0,
  "tracking_links": []
}

Behavior & errors

Response excerpt. Includes first opened_at/clicked_at timestamps and per-link url, clicks, first_clicked_at and last_clicked_at where tracked. Workspace and private inbox access rules apply. Tracking must be opted into when sending HTML; no retroactive tracking or direct SMTP tracking. No open/click webhook events yet. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.