API reference / Inboxes
List inboxes
List a page of account inboxes, optionally filtered by group. Pass nextPageToken as pageToken. Mailbox keys list only their assigned inbox and cannot filter groups or use page tokens.
GET/v1/inboxes
Requires an API key with the inboxes:read scope. MCP tool: list_inboxes. CLI: goshenemail inboxes list.
Request
Query parameters
| Name | Type | Required | Notes |
|---|---|---|---|
limit | integer | 1–100, default 50 | |
pageToken | string | 1–1024 characters | |
group | string | 1–64 characters |
Response
| Field | Type | Notes |
|---|---|---|
inboxes | object[] | |
inboxId | string | |
address | string | |
displayName | string | |
createdAt | string | |
group | string | null | |
deliveryStatus | "pending" | "ready" | |
setupAvailable | boolean | |
nextPageToken | string |
Errors return { "error": { "code", "message", "transient" } } with a 4xx or 5xx status. See Errors.
Examples
curl
curl "https://api.goshenemail.com/v1/inboxes" \
-H "Authorization: Bearer $GOSHENEMAIL_API_KEY"CLI
goshenemail inboxes list