Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Testmail GraphQL API

Full-featured GraphQL API for querying test emails from Testmail programmable inboxes. Supports advanced filtering, custom sorting, field selection, live queries, pagination, and spam reports. Bearer token authentication via Authorization header.

Testmail GraphQL API is one of 2 APIs that Testmail publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Email Testing and GraphQL. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.testmail.app/api.

1 operations 1 paths 7 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.testmail.app/api/graphql
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Testmail GraphQL API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — API key as Bearer token. Obtain from the Testmail developer console and pass as: Authorization: Bearer YOURAPIKEY

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

GraphQL 1

GraphQL inbox query endpoint

POST
/graphql
Execute a GraphQL query against the Testmail inbox
graphqlQuery body → 200307400401429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GraphQLEmail (9 properties), InboxResult (4 properties), GraphQLError (3 properties), GraphQLRequest (3 properties). Each schema is shown below with its type and property counts.

GraphQLRequest
object
GraphQL request body.
3 properties 1 required
GraphQLResponse
object
GraphQL response envelope.
2 properties
GraphQLErrorResponse
object
GraphQL error response when no data is returned.
1 property
GraphQLEmail
object
A single test email returned by the GraphQL inbox query. Fields are only returned if requested in the GraphQL selection set.
9 properties
GraphQLError
object
A single GraphQL error.
3 properties
ParsedAddress
object
Parsed email address components.
2 properties
InboxResult
object
Result of the inbox GraphQL query.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

testmail-app-graphql-api-openapi.yml Raw ↑

Other APIs Testmail publishes across the network.

Testmail Inbox API