Octal API Documentation

Our API is organized around REST principles. It features predictable resource-oriented URLs engineered around our email testing infrasctructure. The API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

This is the documentation for version 1.0 of the API.

Authentication

All API requests require an API key to be included in the header:

x-api-key: YOUR_API_KEY

To obtain an API key, please visit your account dashboard.

Base URL

https://app.octal.email