API reference

Inbound.

Read the email your inboxes receive. Every request needs an API key in the Authorization header; the reference overview covers keys, errors and rate limits.

List received messages

GET/v1/inbound/messagesFull access key

List the messages your inboxes received, newest first. Messages caught as spam are left out. Pass nextCursor back as cursor for the next page; limit is 1 to 100 (25 by default), and inbox narrows the list to one inbox. Every message is also sent to your webhooks as email.received.

Query parameters
Field	Type	About
`limit`	`integer`	Default `25`.
`cursor`	`string`
`inbox`	`string`	Only messages received by this inbox.

terminal

curl -X GET "https://app.usenotix.dev/api/v1/inbound/messages" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

Responses

200A page of received messages, newest first, with the cursor for the next page.

200 response fields
Field	Type	About
`data`required	`object[]`
`data[].messageId`required	`string`
`data[].conversationId`required	`string`
`data[].inbox`required	`object`
`data[].inbox.id`required	`string`
`data[].inbox.name`required	`string`
`data[].from`required	`string`
`data[].to`required	`string[]`
`data[].cc`required	`string[]`
`data[].subject`required	`string`
`data[].text`required	`string`	Can be null.
`data[].html`required	`string`	Sanitized HTML: no scripts, forms or frames; remote images moved to data-remote-src. Can be null.
`data[].strippedText`required	`string`	The new part of the message without quoted history. Can be null.
`data[].attachments`required	`object[]`
`data[].attachments[].filename`required	`string`
`data[].attachments[].contentType`required	`string`
`data[].attachments[].size`required	`integer`
`data[].attachments[].url`required	`string`
`data[].contactId`required	`string`	Can be null.
`data[].inReplyToEmailId`required	`string`	The Notix email this message answers, when found. Can be null.
`data[].spamVerdict`required	`string`
`data[].receivedAt`required	`string (date-time)`
`nextCursor`required	`string`	Can be null.

400Invalid limit or cursor.

Get a received message

GET/v1/inbound/messages/{id}Full access key

Read one received message with its text, sanitized HTML, the new part without quoted history (strippedText) and attachment links that work for 24 hours. inReplyToEmailId names the Notix email it answers, when there is one.

Path parameters
Field	Type	About
`id`required	`string`

terminal

curl -X GET "https://app.usenotix.dev/api/v1/inbound/messages/<id>" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

Responses

200The received message.

200 response fields
Field	Type	About
`messageId`required	`string`
`conversationId`required	`string`
`inbox`required	`object`
`inbox.id`required	`string`
`inbox.name`required	`string`
`from`required	`string`
`to`required	`string[]`
`cc`required	`string[]`
`subject`required	`string`
`text`required	`string`	Can be null.
`html`required	`string`	Sanitized HTML: no scripts, forms or frames; remote images moved to data-remote-src. Can be null.
`strippedText`required	`string`	The new part of the message without quoted history. Can be null.
`attachments`required	`object[]`
`attachments[].filename`required	`string`
`attachments[].contentType`required	`string`
`attachments[].size`required	`integer`
`attachments[].url`required	`string`
`contactId`required	`string`	Can be null.
`inReplyToEmailId`required	`string`	The Notix email this message answers, when found. Can be null.
`spamVerdict`required	`string`
`receivedAt`required	`string (date-time)`

404No received message with this id for the calling team.

Download the original message

GET/v1/inbound/messages/{id}/rawFull access key

Download the original message exactly as it arrived, as an .eml file. Notix keeps originals for 30 days; after that this answers 422.

Path parameters
Field	Type	About
`id`required	`string`

terminal

curl -X GET "https://app.usenotix.dev/api/v1/inbound/messages/<id>/raw" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

Responses

200The original message as an .eml file.

404No received message with this id for the calling team.

422The original is no longer kept (raw messages are kept for 30 days).