Hide-My-Email.info API Docs
This documentation covers the HTTP API exposed by the service.
It distinguishes:
- public / integration-facing endpoints
- invitation-link endpoints
Base URL
http://Hide-My-Email.info
Versioning
Public integration API endpoints are documented under /api/v1/....
Authentication
Account-scoped endpoints require these headers:
secret: sk1.<accountId>.<...>x-account-access-id: aid1.<...>
Policy-document endpoints do not require secret. Invitee-facing invitation endpoints are public only for recipients using invitation links.
Common request headers
Available headers used by account-scoped integration endpoints:
| Header | Required | Description |
|---|---|---|
secret |
Account endpoints only | Account secret used to resolve the account context. |
x-account-access-id |
Required together with secret |
Random account access ID shown in My Account / Secrets. |
Content-Type: application/json |
Required for JSON request bodies | Send JSON payloads. |
Accept: application/json |
Optional | Requests JSON responses. |
Common response codes
| Code | Meaning |
|---|---|
200 OK |
Request succeeded and returned a body. |
204 No Content |
Request succeeded and returned no body. |
400 Bad Request |
Validation or business rule failure. |
401 Unauthorized |
Missing or invalid secret for an account-scoped endpoint. |
404 Not Found |
The target object does not exist or is not visible. |