Skip to content
Documentation/API reference
API · messages

List messages

GET /api/v2/inboxes/{id}/messages

Authorization

messages: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
limitquery integer · optional1–50, default 20
beforequery UID · optionalPositive mailbox UID; use next_before from the previous page

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/RESOURCE_UUID/messages?limit=20' \
  -H "Authorization: Bearer $INBOXIT_API_KEY"

CLI equivalent

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

Example
inboxit messages list --id RESOURCE_UUID --query '{"limit":"20"}'

Response

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

Example
{
  "uid_validity": "123456",
  "messages": [],
  "next_before": null
}

Behavior & errors

Requires an active inbox (409 otherwise). Scope persisted UIDs by inbox and uid_validity. null next_before ends pagination. 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.