Appearance
Search inbox
GET
/api/emails/{namespace}/inbox
This endpoint returns the latest emails from a specific namespace's inbox.
When the wait query flag is set to true and no emails are found yet, the endpoint waits briefly and redirects back to the same URL so the client can retry the same request automatically.
Authorizations
ApiKey
Type
API Key (header: X-Api-Key)
Parameters
Path Parameters
namespace*
Type
Requiredstring
Query Parameters
limit*
The maximum number of emails that can be returned in this request. Must be between 1 and 20
Type
Requirednumber
Example
10Minimum
1Maximum
20Default
10offset*
The number of emails to skip/ignore, useful for pagination
Type
Requirednumber
Example
0Minimum
0Default
0from_timestamp
Filter emails by starting unix timestamp in seconds
Type
number
Example
1714857600Minimum
0to_timestamp
Filter emails by ending unix timestamp in seconds
Type
number
Example
1714857600Minimum
0to_addr_prefix
Filter emails by 'to' address. Address must start with this. Example: 'foo' would return for 'foobar@...' but not 'barfoo@...'
Type
string
Example
"john@example.com"from_addr_includes
Filter emails by 'from' address. Address must contain this. Example: 'foo' would return for 'foobar@...' but not 'barfoo@...'
Type
string
Example
"john@example.com"subject_includes
Filter emails by subject. This is case insensitive. Subject must include this. Example: 'password' would return for 'Password reset', 'Reset password notification' but not 'Reset'
Type
string
Example
"example"wait
If this flag is true then the request will keep waiting till at least one response is returned
Type
boolean
Example
trueResponses
application/json
JSON "total_count": 1, "options": { "limit": 10, "offset": 0, "from_timestamp": 1714857600, "to_timestamp": 1714857600, "to_addr_prefix": "john@example.com", "from_addr_includes": "john@example.com", "subject_includes": "password", "wait": true }, "data": [ { "id": "email_123", "from": { "address": "john@example.com", "name": "John Doe" }, "to": [ { "address": "john@example.com", "name": "John Doe" } ], "cc": [ { "address": "john@example.com", "name": "John Doe" } ], "bcc": [ { "address": "john@example.com", "name": "John Doe" } ], "subject": "Password reset", "html": "string", "text": "string", "received_date": "2026-04-25T08:30:00.000Z", "received_timestamp": 1714857600, "expires_timestamp": 1714944000, "spam_score": 0, "headers": { "additionalProperties": "string" }, "attachments": [ { "id": "att_123", "filename": "invoice.pdf", "content_type": "application/pdf", "size": 1024 } ] } ]
{
}