Appearance
Update namespace settings
POST
/api/namespace/{namespace}/settings
Authorizations
ApiKey
TypeAPI Key (header: X-Api-Key)
Parameters
Path Parameters
namespace*
Typestring
RequiredRequest Body
application/json
JSON
{
"retention_time": 0
}
Responses
application/json
JSON
{
"id": "string",
"namespace": "string",
"shared": true,
"settings": {
"retention_time": 0
}
}
List all namespaces for user
Search emails in inbox
GET
/api/emails/{namespace}/inbox
This endpoint returns the latest emails from a specific namespace's inbox
Authorizations
ApiKey
TypeAPI Key (header: X-Api-Key)
Parameters
Path Parameters
namespace*
Typestring
RequiredQuery Parameters
limit*
The maximum number of emails that can be returned in this request. Must be between 1 and 20
Typenumber
RequiredExample
10minimum
1maximum
20default
10offset*
The number of emails to skip/ignore, useful for pagination
Typenumber
RequiredExample
0minimum
0default
0from_timestamp
Filter emails by starting unix timestamp in seconds
Typenumber
Example
1714857600minimum
0to_timestamp
Filter emails by ending unix timestamp in seconds
Typenumber
Example
1714857600minimum
0to_addr_prefix
Filter emails by 'to' address. Address must start with this. Example: 'foo' would return for 'foobar@...' but not 'barfoo@...'
Typestring
Example
examplefrom_addr_includes
Filter emails by 'from' address. Address must contain this. Example: 'foo' would return for 'foobar@...' but not 'barfoo@...'
Typestring
Example
examplesubject_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'
Typestring
Example
examplewait
If this flag is true then the request will keep waiting till at least one response is returned
Typeboolean
Example
trueResponses
application/json
JSON
{
"total_count": 0,
"options": {
},
"data": [
{
"id": "string",
"from": {
},
"to": [
{
}
],
"cc": [
{
}
],
"bcc": [
{
}
],
"subject": "string",
"html": "string",
"text": "string",
"received_date": "string",
"received_timestamp": 0,
"expires_timestamp": 0,
"spam_score": 0,
"headers": {
},
"attachments": [
{
}
]
}
]
}
Get latest email from namespace
GET
/api/emails/{namespace}/latest
Authorizations
ApiKey
TypeAPI Key (header: X-Api-Key)
Parameters
Path Parameters
namespace*
Typestring
RequiredResponses
application/json
JSON
{
"data": {
"id": "string",
"from": {
},
"to": [
{
}
],
"cc": [
{
}
],
"bcc": [
{
}
],
"subject": "string",
"html": "string",
"text": "string",
"received_date": "string",
"received_timestamp": 0,
"expires_timestamp": 0,
"spam_score": 0,
"headers": {
},
"attachments": [
{
}
]
}
}
Get email attachment
Get SMTP settings for namespace
Get shared email by encoded ID
GET
/api/share/email/{encodedEmailId}
Authorizations
ApiKey
TypeAPI Key (header: X-Api-Key)
Parameters
Path Parameters
encodedEmailId*
Typestring
RequiredResponses
application/json
JSON
{
"data": {
"id": "string",
"from": {
},
"to": [
{
}
],
"cc": [
{
}
],
"bcc": [
{
}
],
"subject": "string",
"html": "string",
"text": "string",
"received_date": "string",
"received_timestamp": 0,
"expires_timestamp": 0,
"spam_score": 0,
"headers": {
},
"attachments": [
{
}
]
}
}
Get shared email attachment
GET
/api/share/email/{encodedEmailId}/attachment/{attachmentId}
Authorizations
ApiKey
TypeAPI Key (header: X-Api-Key)
Parameters
Path Parameters
encodedEmailId*
Typestring
RequiredattachmentId*
Typestring
RequiredResponses
application/json
JSON
{
"data": {
"id": "string",
"filename": "string",
"content_type": "string",
"size": 0,
"expires_at": "string",
"download_url": "string"
}
}