How To Use GlockApps API: Step-by-Step Tutorial

Estimated reading time: 8 minutes

The GlockApps API helps you automate email deliverability testing, retrieve spam test data, and integrate GlockApps with your existing workflows. Whether you’re building a custom application, using an automation platform, or working with AI assistants like ChatGPT, Claude, or Gemini, the API makes it easy to run spam tests and analyze results programmatically.

Now available on all plans, including the free tier, the GlockApps API is no longer just for developers. With today’s AI assistants capable of understanding API documentation and making HTTP requests, marketers, agencies, and deliverability teams can retrieve live data, analyze reports, and automate repetitive tasks using simple natural-language prompts.

In this guide, you’ll learn how to use the GlockApps API, explore its key capabilities and use cases, and see how it fits into both traditional integrations and modern AI-powered workflows.

What is an API and Why You Should Use It

An API (Application Programming Interface) is a structured interface that enables seamless communication between different software components.

The primary objective of an API is to streamline the integration of services and applications by providing developers with direct access to the features of GlockApps. This facilitates the automation of data analysis and verification processes, while also enabling the delivery of testing results to your partners and clients efficiently.

The GlockApps API grants access to powerful tools for spam filter testing, email deliverability analysis, DNS record validation, and more. It supports the automation of project and folder creation, test execution (both manual and automated), and data retrieval from test results, enhancing accuracy.

Key use cases for the API include:

Software Developers: To build integrations between GlockApps API and third-party services or applications.
Email Marketing Companies: To maximize the efficiency and reliability of email campaigns through automated testing and analysis.
Organizations Focusing on Process Automation: To integrate GlockApps API into existing systems and automate critical tasks such as spam filter testing, email deliverability analysis, and related operations.
AI-Powered Workflows: To run tests and retrieve deliverability data through easy prompts with no code required.

How to Use the Documentation

The API documentation, provided via Swagger, is an essential tool for working with the GlockApps API.

Access Documentation

It contains comprehensive descriptions of available methods, endpoints, parameters, response formats, and example requests. The documentation is organized around the following key components:

Endpoints

Each endpoint describes a specific action you can perform (retrieving a list of projects or creating a new test).

Request Methods

The core methods supported by the API include GET, POST, PUT, PATCH, and DELETE, each serving a distinct purpose:

GET: Retrieves data from the server. They are commonly used for fetching lists of projects, tests, reports, etc.
POST: This function creates new resources, such as projects, folders, or manual tests. It requires API Write Access permissions.
PUT: Fully updates existing resources, such as modifying project or folder details.
PATCH: Partially updates resources, allowing changes to specific fields. For example, you can activate/deactivate automated tests, move tests between folders, or add custom notes to tests.
DELETE: Removes entities, such as projects, folders, or test reports.

Access Rights

Access to API methods:

GET and POST (and other write operations: PUT, PATCH, DELETE) are available on every plan, including free accounts.
No plan upgrade or request needed.

API Key

An API key is required to interact with the API, which can be found in your account settings. It must be included in the request header:

x-api-key: <your_api_key>

Request Format

All requests must be sent over HTTPS, with data transmitted in JSON format.

If you adhere to these guidelines, you can effectively utilize the GlockApps API for a wide range of email deliverability and automation tasks.

Methods for Making API Requests

There are several ways to execute requests to the GlockApps API, including Swagger UI, cURL, Postman, and other tools:

Swagger UI

An interactive tool integrated into the documentation, allowing you to send requests and view results directly from your browser without the need for coding.

cURL

A command-line utility for making HTTP requests, ideal for use in scripts and terminal environments.

Postman

A popular API testing tool that enables you to send requests, configure parameters, and analyze responses.

AI Assistants

Share your API key and documentation with ChatGPT, Claude, Gemini, Perplexity, or any other AI assistant, and it can easily read the endpoints listed below to help you construct requests. There’s no need to install a separate connector. It operates just like providing a developer with the same documentation.

Example of Using the API

This example demonstrates the process of creating a manual test.

Step 1: Obtain an API Key

Retrieve your API key from your account settings.

Step 2: Retrieve the Project ID

To create a test, you first need to identify the project ID of the relevant project. Use the following GET request with your API key:

curl -X GET https://api.glockapps.com/gateway/spamtest-v2/api/projects \ -H ‘x-api-key: <your_api_key>’

The response will include details about your projects, including their unique identifiers (projectId). In that case, we got projectId = 16

Video Examples:

Step 3: Retrieve the List of Providers

Next, fetch the list of available providers using the following GET request:

curl -X GET https://api.glockapps.com/gateway/spamtest-v2/api/providers \ -H ‘x-api-key: <your_api_key>’

The response will return available provider groups and seed accounts.

Video Examples:

Step 4: Creating a Manual Test

Knowing the project ID and selecting, for example, the providers AOL (“providerGroupId”: “2”) and Outlook (“providerGroupId”: “3”), you can create a template for a manual test with the following command:

curl -X POST https://api.glockapps.com/gateway/spamtest-v2/api/projects/<your_projectId>/manualTest \ -H ‘Content-Type: application/json’ \ -H ‘x-api-key: <your_api_key>’ \ -d ‘{ “providerGroupIds”: [“2”, “3”], “testType”: “ManualTest” }’

Video Examples:

Step 5: Completing the Test

To complete the test and retrieve the results, send an email to the provided email addresses, including the testID in the email body.

Example of Using the GlockApps API with an AI Assistant

Modern AI assistants can understand API documentation and generate API requests for you. Instead of manually writing cURL commands or navigating the GlockApps dashboard, you can provide your API key together with the GlockApps API documentation and ask your AI assistant to retrieve and analyze your deliverability data.

Copy your API key from your GlockApps account settings and provide it to your AI assistant along with a link to the documentation. The AI can use the documentation to understand the available endpoints and generate the appropriate API requests.

Step 2: Ask for the information you need

You can use natural-language prompts such as:

“Run a spam test for my latest campaign and summarize the results.”
“Analyze my latest spam test report and prioritize the issues by impact.”
“Summarize my latest deliverability report.”
“Compare my last three spam tests and explain what changed.”
“List all SPF, DKIM, or DMARC issues in my latest report.”
“Did any of my sending IPs appear on a blocklist?”

Your AI assistant retrieves the requested data through the GlockApps API and presents it in a clear, easy-to-understand format.

Step 3: Review the results

Instead of reading raw JSON responses or manually comparing reports, your AI assistant can summarize inbox placement, explain authentication issues, identify spam filter warnings, and recommend the most important actions to improve deliverability.

What Can AI Analyze from a GlockApps Spam Test?

With access to your GlockApps spam test data through the API, AI can quickly analyze key deliverability metrics and explain what they mean for your email campaigns.

GlockApps data	How AI can help you
Inbox placement	Explain why emails landed in Spam or Tabs
Spam filter results	Identify the rules that affected your score
SPF, DKIM, DMARC	Detect authentication issues and recommend fixes
IP & domain reputation	Highlight reputation risks before your next campaign
HTML & content analysis	Suggest improvements to email content and formatting
Historical reports	Compare tests, identify trends, and summarize changes

How your AI assistant can help you understand the spam test results

Conclusion

The GlockApps API is an essential tool for businesses and developers seeking to optimize email deliverability and streamline operational workflows. The API supports diverse use cases by offering comprehensive documentation, robust endpoint capabilities, and flexible request methods, from integrating third-party services to automating spam filter tests. Whether you’re integrating GlockApps into your own application, building automated workflows, or connecting the API to AI agents, the GlockApps API helps you automate deliverability testing, retrieve live spam test data, and make faster, more informed decisions.

Don’t waste any time – get started with GlockApps API today!

Get Started with GlockApps API

FAQ

What is the GlockApps API?

The GlockApps API is a powerful tool that lets you automate email deliverability testing, retrieve spam test data, and integrate GlockApps with your applications, automations, or AI assistants. Whether you’re building a custom integration or using AI to analyze spam test reports, the API provides secure access to your email deliverability and authentication data.

Who can benefit from using the GlockApps API?

The GlockApps API is designed for anyone who wants to automate email deliverability workflows, including:
– Email marketers and deliverability specialists
– Agencies managing multiple sending domains or clients
– Developers building custom integrations
– Teams using AI assistants to analyze spam test reports
– Organizations automating email testing and reporting

What request methods are supported by the API?

The GlockApps API supports the following methods:
– GET: Retrieve data such as projects and test results.
– POST: Create new resources like projects or tests.
– PUT: Fully update existing resources.
– PATCH: Partially update resources (e.g., activate tests or update folders).
– DELETE: Remove entities like projects or reports.

What tools can I use to make API requests?

You can use:
– Swagger UI;
– cURL;
– Postman.
– AI assistants such as ChatGPT, Claude, or Gemini
– Custom applications or automation platforms

Can I use the GlockApps API without writing code?

Yes. Modern AI assistants can understand the GlockApps API documentation and generate requests for you. In many cases, you only need your API key, the API documentation, and a natural-language prompt to retrieve and analyze your spam test data.