List messages in a sandbox inbox
/api/v1/sandbox/inboxes/{id}/messagesNewest first. An inbox keeps its newest 50 messages for 30 days; older ones are deleted automatically.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | The id identifier. |
q | query | string | Matches subject, From or To (contains). |
limit | query | integer | Page size, at most 100. |
offset | query | integer | Rows to skip. |
Request
/api/v1/sandbox/inboxes/{id}/messagescurl -X GET 'https://app.mailyte.com/api/v1/sandbox/inboxes/01JBT8XQ2M9WYC3K4F6R7S8T9V/messages' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY'const response = await fetch('https://app.mailyte.com/api/v1/sandbox/inboxes/01JBT8XQ2M9WYC3K4F6R7S8T9V/messages', {
method: 'GET',
headers: {
Authorization: 'Bearer mk_live_YOUR_API_KEY',
},
});
const { data } = await response.json();import requests
response = requests.get(
"https://app.mailyte.com/api/v1/sandbox/inboxes/01JBT8XQ2M9WYC3K4F6R7S8T9V/messages",
headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]<?php
$response = Http::withToken('mk_live_YOUR_API_KEY')
->get('https://app.mailyte.com/api/v1/sandbox/inboxes/01JBT8XQ2M9WYC3K4F6R7S8T9V/messages');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/sandbox/inboxes/01JBT8XQ2M9WYC3K4F6R7S8T9V/messages")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectitemsarray<object>idstringULID of the stored message.
inbox_idstringsubjectstringheader_fromstringThe From header, as written.
header_toarray<string>The To header addresses.
envelope_rcptsarray<string>Every address the message was sent to, INCLUDING Bcc: blind recipients are in the envelope, never in the headers, so this is the only place they show.
size_bytesintegerattachment_countintegersourcestringsmtp | api | inbound`api` for a test-mode API key send; `inbound` for mail sent to the inbox's `inbound_address`.
simulated_outcomestringdelivered | bounce | softbounce | complaint | suppressedThe outcome simulated for this message (a `@sim.mailyte.com` address or an `X-Mailyte-Simulate` header). Null means the default: accepted, then delivered.
spam_scorenumberNull until the message has been scored; scoring runs after it arrives.
read_atstringWhen it was marked read. Null means unread.
received_atstringWhen the sandbox accepted it.
totalintegerMatching rows in all, not just this page.
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.