Skip to main content
GET
/
api
/
v1
/
external
/
test-auth
curl -X GET "https://api.mailgreet.com/api/v1/external/test-auth" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "message": "API key authentication successful",
  "data": {
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "clerk_user_id": "user_2abc123def456",
    "api_key_name": "Default API Key",
    "authenticated_at": "2026-01-18T14:00:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.mailgreet.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint allows you to test your API key authentication before making other requests. It’s the recommended first step when integrating with the MailGreet API.

​
Authentication

​
Authorization
string
required
Bearer token. Format: Bearer YOUR_API_KEY

​
Response

​
success
boolean
Indicates if the request was successful
​
message
string
Success message confirming authentication
​
data
object
curl -X GET "https://api.mailgreet.com/api/v1/external/test-auth" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "message": "API key authentication successful",
  "data": {
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "clerk_user_id": "user_2abc123def456",
    "api_key_name": "Default API Key",
    "authenticated_at": "2026-01-18T14:00:00Z"
  }
}