API reference
API documentation
Two references, both read-only. New here? Start with the workflow guides, or skim the conventions.
Public API reference
Every tenant-accessible endpoint — routes, parameters, models and examples. Open to everyone, no key required. This is what you need for day-to-day integration: jobs, discovery, search, monitoring and reporting.
Admin API reference
The complete surface — public + admin + premium in one document: key management, tenant provisioning, global configuration, version rollout, plus the archiving and search endpoints. It is gated: you enter a full-scope admin key on the page, which is sent as a request header to load the reference (never placed in the URL).
Premium API reference
Enhanced add-on functionality — long-term archiving & retention(archive locations and policies) and indexing & search over collected mail. These features are part of the premium tier, not the standard license; the reference is open so you can see what an upgrade unlocks.
Try it out
Both references are read-only. To send live requests, open the API-hosted Swagger UI and authenticate with your API key — a tenant key unlocks the public endpoints, an admin key unlocks everything.