REST API Documentation

MailSlurp is an email API that lets you create and control email accounts over HTTP without an SMTP mail server. You can call the API using an API Key and an HTTP client or use one of the official SDK libraries.

See the docs for more information: REST Endpoint Documentation

All API endpoints are relative to base URL and should include x-api-key header that is your MailSlurp API Key.

Common controllers

Other resources


You must obtain an API Key for MailSlurp to call the API. Create a free account to do so. Include your API Key in requests with the x-api-key header or use an SDK client and configure it to use your API Key.

$ curl -H 'x-api-key:your_mailslurp_api_key' -X POST

Example usage

Create email account

You can create and email address by making a POST request to the /inboxes/ endpoint:

$ curl -H "x-api-key:$API_KEY" -X POST
> {"id":"baefb45e-40ab-49fa-a0cb-2d41adc522b5","userId":"6f68f0cc-4760-4e82-87ad-449c9037773b","created":"2021-05-04T07:26:06.595Z","createdAt":"2021-05-04T07:26:06.595Z","name":null,"description":null,"emailAddress":"","expiresAt":null,"favourite":false,"tags":null,"teamAccess":false,"readOnly":false}

See endpoint documentation for more examples.