API overview

The Shroud.email API lets you manage email aliases and discover the custom domains available to your account. Use it to integrate email privacy into your own tools and workflows.

For the hosted service, send requests to https://app.shroud.email. If you self-host, use your instance’s web application domain instead. This documentation site does not serve API requests.

Getting started

1. Read the authentication guide to learn how to use an account token safely.
2. Use the API reference in the sidebar for each operation’s parameters, request bodies, responses, and examples.
3. Start with a test alias before using an integration with addresses you depend on.

The reference is generated from the application’s OpenAPI specification. You can also use that specification with OpenAPI-compatible client generators and development tools. It is the source of truth for endpoint details; these guides focus on how to get started.

Getting help

For integration questions, ask in GitHub Discussions. Report API bugs in the issue tracker. Remove account credentials, bearer tokens, and private email addresses before sharing request logs.