Documentation | GQ CRM

Getting Started

Welcome to the GQ CRM | Marketing Mail API. This guide will help you integrate our email service into your application.

Quick Start

Create a project in your dashboard
Configure your SMTP settings
Get your API Key from the project page
Start sending emails using our API

API Overview

The GQ CRM | Marketing Mail API is a simple JSON-over-HTTPS API. You send emails through your own SMTP configuration, while we handle delivery, open and click tracking (plan-dependent), and sending logs. Requests are authenticated with an API key in the X-API-Key header — a project key for sending and a workspace key for the Contacts API — and each response follows a consistent format:

// Success
{ "success": true, "data": { ... }, "message": "..." }
// Error
{ "success": false, "error": "human-readable reason", "data": { ...optional } }

Base URL

https://gq-crm.com/api

API Endpoints

Method	Path	Description
POST	/api/send	Send one or more emails (single recipient, array, or template-based)
GET	/api/health	Service health check
GET	/api/contacts	List/search contacts with incremental sync (workspace key, `contacts:read`)
POST / PATCH / DELETE	/api/contacts, /api/contacts/[id]	Create, update and delete contacts (workspace key, `contacts:write`)
POST	/api/contacts/[id]/send	Send an email to one contact (project key, `send:email`)

Health Check

Verify the API is reachable before integrating:

{
  "status": "healthy",
  "timestamp": "2026-08-01T10:00:00.000Z",
  "service": "marketing-mail"
}

API Documentation