v0 - API Reference

Get Burners

GET https://burnermail.io/api/burner_emails

This endpoint allows you to get a list of your burners.

Headers

Name	Type	Description
API_KEY	string	Authentication key.

200 Burner list successfully retrieved.

[
    {
        "email": "[email protected]",
        "active": true,
        "forwarded_emails": 19,
        "blocked_emails": 0,
        "description": ""
    },
    {
        "email": "[email protected]",
        "active": true,
        "forwarded_emails": 91,
        "blocked_emails": 0,
        "description": ""
    }, 
    ...
]

401 Invalid (empty, incorrect or missing) API_KEY header.

Generate Burner

POST https://burnermail.io/api/burner_emails

This endpoint generates a random burner with the specified domain name or the default one that you have set in Settings.

Headers

Name	Type	Description
API_KEY	string	Authentication key.

Request Body

Name	Type	Description
domain	string	Optionally provide a domain name. If no domain name is provided, then the default one will be used.

201 The burner email address was successfully created and can now be used.

{
    "email": "[email protected]",
    "active": true,
    "forwarded_emails": 0,
    "blocked_emails": 0,
    "description": ""
}

401 Invalid (empty, incorrect or missing) API_KEY header.

422 Invalid domain specified.

Generate Custom Burner

POST https://burnermail.io/api/burner_emails/custom

This endpoint generates a custom burner email address.

Headers

Name	Type	Description
API_KEY	string	Authentication key.

Request Body

Name	Type	Description
address	string	The burner email address prefix - the part before the "at" sign ([e-mail])
domain	string	The domain for the burner email address - the part after the "at" sign ([e-mail])

201 Successfully created custom burner.

{
    "email": "[email protected]",
    "active": true,
    "forwarded_emails": 0,
    "blocked_emails": 0,
    "description": ""
}

422 Invalid domain specified.

Delete Burner

POST https://burnermail.io/api/burner_emails/delete

This endpoint deletes a specific burner. Please keep in mind that his action is PERMANENT and there is no going back!

Headers

Name	Type	Description
API_KEY	string	Authentication key.

Request Body

Name	Type	Description
burner_email	string	The full burner email address that you want to delete. (eg. [email protected])

201 The burner email address was successfully deleted.

{
    "success": true
}

401 Invalid (empty, incorrect or missing) API_KEY header.

422 Invalid email address specified.