Skip to content
Documentation/API reference
API · inboxes

List inboxes

GET /api/v2/inboxes

Authorization

inboxes: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.

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/inboxes' \
  -H "Authorization: Bearer $INBOXIT_API_KEY"

CLI equivalent

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

Example
inboxit inboxes list

Response

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

Example
{
  "inboxes": []
}

Behavior & errors

Items: id, name, address, status, receiving_address, receiving_status, created_at. Wait until status active before message access or custom address assignment. 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.