API reference / Inboxes
Get an inbox
Get an inbox by its canonical email address.
GET/v1/inboxes/{inboxId}
Requires an API key with the inboxes:read scope. MCP tool: get_inbox. CLI: goshenemail inboxes get.
Request
Path parameters
| Name | Type | Required | Notes |
|---|---|---|---|
inboxId | string (email) | Yes | up to 254 characters |
Response
| Field | Type | Notes |
|---|---|---|
inboxId | string | |
address | string | |
displayName | string | |
createdAt | string | |
group | string | null | |
deliveryStatus | "pending" | "ready" | |
setupAvailable | boolean |
Errors return { "error": { "code", "message", "transient" } } with a 4xx or 5xx status. See Errors.
Examples
curl
curl "https://api.goshenemail.com/v1/inboxes/research%40agents.goshenemail.com" \
-H "Authorization: Bearer $GOSHENEMAIL_API_KEY"CLI
goshenemail inboxes get --inbox-id "research@agents.goshenemail.com"