Get an inbound message
Platform module
GET/inbound-messages/{id}inboundMessages.get
Mail received (0550, 1411): forwarded to a project inbox, or a reply to a notification email. People who file documents on the project read its inbox mail; a person reads their own replies. Project inbox mail is filed once, as a Document record of the project, or discarded with a reason. Returns one inbound message with its `ETag`. A inbound message the caller may not see returns 404.
- Requires the capability knowledge.document.write.
- OAuth scopes: knowledge.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the inbound message. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: InboundMessage
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the inbound message. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| purpose | "Project Inbox" | "Reply" | Yes | What the mail was sent to. |
| inbound_address_id | string (uuid) | null | Yes | Identifier of the project inbox the mail was sent to. |
| from_address | string | Yes | Sender address.Constraints: length 1 to 320 |
| subject_line | string | null | Yes | Subject.Constraints: length 1 to 998 |
| body_text | string | null | Yes | Plain-text body with quoted text stripped.Constraints: length 1 to 20000 |
| dkim_verified | boolean | Yes | True when the sender's DKIM signature verified. |
| inbound_status | "Received" | "Verified" | "Filed" | "Rejected" | Yes | Processing status. |
| rejection_reason | string | null | Yes | Why the mail was rejected.Constraints: length 1 to 500 |
| received_at | string (date-time) | Yes | When the mail arrived. |
| filed_document_id | string (uuid) | null | Yes | Identifier of the document the mail was filed as. |
| filed_record_id | string (uuid) | null | Yes | Identifier of the record of the project the mail was filed to. |
| filed_by | string (uuid) | null | Yes | Identifier of the person who filed the mail. |
| filed_at | string (date-time) | null | Yes | When the mail was filed. |
| discarded_at | string (date-time) | null | Yes | When the mail was discarded. |
| discarded_by | string (uuid) | null | Yes | Identifier of the person who discarded the mail. |
| discard_reason | string | null | Yes | Why the mail was discarded.Constraints: length 1 to 500 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"purpose": "Project Inbox",
"inbound_address_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"from_address": "rigging@bayside-audio.test",
"subject_line": "Rigging plot v4",
"body_text": "Updated plot attached.",
"dkim_verified": true,
"inbound_status": "Verified",
"rejection_reason": "DKIM failed.",
"received_at": "2026-10-08T14:30:00Z",
"filed_document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"filed_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"filed_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"filed_at": "2026-10-08T14:30:00Z",
"discarded_at": "2026-10-08T14:30:00Z",
"discarded_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"discard_reason": "Spam."
}Code samples
curl -X GET "$XOS_BASE_URL/inbound-messages/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.inboundMessages.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.inbound_messages.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos inbound-messages get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f