API Endpoints

The Unspam.email API provides a structured way to programmatically interact with your account and monitoring data. This guide details the available endpoints for developers who wish to integrate Unspam.email's functionality into their own applications.

Base URL and Authentication

Base URL

All unspam.email API requests should be directed to the following base URL:

https://api.unspam.email

Authentication

Access to the unspam.email API is secured using an API token. This token must be included in the header of every API request.

• Header Name: Authorization
• Header Value: Bearer YOUR_API_TOKEN

You can obtain your API token by authenticating via the /api/login endpoint.

Authentication Endpoint

User Login

• POST /api/login : Authenticates a user and returns an API token.

Email Testing Endpoints

List Emails with Support for Pagination

• GET /api/emails : Retrieves a list of your tested emails with optional filtering and sorting parameters. Supports orders  and direction  for sorting .

Get Specific Email Test Result

• GET /api/emails/{resultId}/results : Retrieves detailed results for a specific email test using the given resultId .

Generate a Unique Test Email

• GET /api/get-email : Generates a unique email address and result ID. Use this email address to send your test message.

Inbox Placement Endpoints

Create Inbox Placement Test

• POST /api/inbox-placement : Initiates an inbox placement test across multiple mailbox providers.

List Inbox Placement Tests

• GET /api/inbox-placement : Retrieves a list of all your inbox placement test results.

Get Specific Inbox Placement Result

• GET /api/inboxes/{resultId}/results : Retrieves inbox placement results for the specified resultId .

Get Seed List

• GET /api/inbox-placement/seed-list : Returns a list of seed (test) email addresses used for inbox placement testing.

Email Preview Endpoints

Get Email Screenshots

GET /api/emails/{resultId}/screenshots : Retrieves device-specific screenshots (desktop, tablet, mobile) of the tested email.

Heatmap Endpoints

Get Email Heatmaps

• GET /api/emails/{resultId}/heatmap Retrieves eye-tracking heatmaps that show focus and attention for the tested email across different devices.

Response Codes

For usage examples, see the API Usage Examples article.