Skip to content
MiniMailer
Docs
Toggle sidebar
Quick links
Documentation
Knowledge Base
API Reference
Changelog
No results found

Compliance

Account-level compliance and audit export operations.

GET /controller-audit

Request a controller audit export

Submits a GDPR Article 28(3)(h) audit export of the processing footprint MiniMailer holds for the authenticated user's account: sending domains, message metadata, delivery feedback, and webhook delivery trails. The export is assembled asynchronously and delivered by email; the acceptance response confirms the request is recorded.

Requires the compliance:write scope.

GET /controller-audit
curl -X GET https://api.minimailer.app/controller-audit \
  -H "Authorization: Bearer $MINIMAILER_API_TOKEN" \
  -H "Accept: application/vnd.api+json"

Responses

Status
Description
202 Controller audit export request accepted and processing.
401 Authentication is required. ErrorDocument
403 The token lacks the scope this operation requires (error code missing_scope), or the request breaks a JSON:API protocol rule (client_generated_id, unsupported_relationship_update). Never returned for a record that belongs to another account — that case is a 404. ErrorDocument
406 The Accept header mentions the JSON:API media type only in instances modified by disallowed media type parameters (or only with unsupported ext extensions), so no acceptable representation remains. ErrorDocument
429 The request was rate limited. Branch on the error code: rate_limited means the account exceeded its API rate limit, and agent_throttled means the agent named by agent_id has a restricted sender reputation and has exhausted the send allowance for its tier. ErrorDocument