Docs
Get Inbox
GET /inboxes/{inboxId}
GET
/inboxes/{inboxId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Returns all emails in the event inbox, ordered from newest to oldest. Each item includes a truncated preview of the email body (up to 120 characters).
The inboxId is the same as your eventId — each event has exactly one inbox scoped to it.
Requires EventCommunicationsRead permission on the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| inboxId | Guid | Required | The event ID (inbox ID equals event ID). |
Response
Returns an array of inbox items.
| Field | Type | Description |
|---|---|---|
| id | Guid | Unique email ID. |
| eventId | Guid | The event this email belongs to. |
| messageId | string | Raw SMTP Message-ID header. |
| inReplyTo | string | Message-ID of the email being replied to, if any. |
| dateTime | DateTime | Date and time the email was received. |
| from | string | Sender address. |
| to | string | Primary recipient address. |
| subject | string | Email subject line. |
| isRead | bool | Whether the email has been marked as read. |
| emailPreview | string | Truncated plain-text body preview (max 120 characters). |
| refrences | string[] | Array of referenced Message-IDs (SMTP References header). |