https://burner.kiwi/api/v1
Calls to authenticated endpoints must set the HTTP header X-Burner-Key to the token returned by the GET /inbox endpoint.
GET /inbox
Returns a new inbox and token. The returned token must be set as a header in subsequent API calls related to this inbox. You must save this token as it will not be returned to you again.
{
"success": true,
"errors": null,
"result": {
"email": {
"address": "881is60i@rogerin.space",
"id": "6bf737d2-90ab-487a-bb72-52cfa7ee81g0",
"created_at": 1524804051,
"ttl": 1524890451
},
"token": "6bf737d2-90ab-487a-bb72-52cfa7ee81g0.1524890451.p3fJghFADrvtA05NdT8gaCpPSjhP3c6Q_u-SrbPgNDA"
},
"meta": {
"version": "dev",
"by": "Hayden Woodhead"
}
}Authenticated Endpoint
GET /inbox/$id
Returns an inbox's details.
{
"success": true,
"errors": null,
"result": {
"address": "881is60i@rogerin.space",
"id": "6bf737d2-90ab-487a-bb72-52cfa7ee8116",
"created_at": 1524804051,
"ttl": 1524890451
},
"meta": {
"version": "dev",
"by": "Hayden Woodhead"
}
}Authenticated Endpoint
GET /inbox/$id/messages
Returns an inbox's messages. Note: these messages have not been sanitized for XSS or any other nasty vulnerability.
It is the responsibility of the caller to ensure the message body is displayed in a suitable way. These messages have only
had target="_blank" added to any a tags.
{
"success": true,
"errors": null,
"result": [
{
"id": "7d86c90e-ecb3-4656-b742-07abfa33954d",
"received_at": 1524805729,
"sender": "bobby@example.com",
"from": "Bobby Tables <bobby@example.com>",
"subject": "Fwd: Hello there!",
"body_html": "<html><head></head><body><div dir=\"ltr\"><div class=\"gmail_quote\"><div dir=\"ltr\">Why hello there. How are you doing today?<br/><br/>Regards<br/>Bobby Tables</div>\n</div><br/></div>\n</body></html>",
"body_plain": "Why hello there. How are you doing today?\r\n\r\nRegards\r\nBobby Tables\r\n",
"ttl": 1524890451
}
],
"meta": {
"version": "dev",
"by": "Hayden Woodhead"
}
}In the event of an error the success will be false, errors will be non null and result will be null.
For example:
{
"success": false,
"errors": {
"code": 401,
"msg": "Unauthorized: given auth key invalid"
},
"result": null,
"meta": {
"version": "dev",
"by": "Hayden Woodhead"
}
}While I will make my best effort to ensure correctness/uptime/API stability, I make no guarantees. If you require the use of this API for any business-related/critical purposes I suggest hosting your own version. Check out how to here.