EmailgisticsAPI
Getting started

Overview

What the Emailgistics API is, who it’s for, and what it covers.

The Emailgistics API gives you programmatic access to data and behavior for the Emailgistics shared mailboxes you administer. It’s a REST API — JSON request and response bodies, Bearer authentication, HTTPS only.

The HTTP API and webhooks are both features of the Enterprise plan. If you’re on a different plan and want to use them, contact sales.

Two surfaces are documented here:

  • The HTTP API at /api/v1, for pulling reporting data, listing per-message activity, and listing and downloading attachments. Authenticated with a Bearer API key you generate in Emailgistics.
  • Webhooks, for running custom logic in your own systems — Emailgistics POSTs to a URL you host whenever a message arrives in an Emailgistics mailbox. Emailgistics authenticates with a secret you configure on the webhook — no Emailgistics API key is involved.

Where to start

What this API isn’t for

The internal admin and add-in surfaces (/administration/..., /crm/...) are not part of the public contract. Don’t build against them — they change without notice.

Versioning, briefly

The API is at v1. We make additive changes (new endpoints, new optional fields) without notice; breaking changes are versioned. See Versioning.

On this page