The bluefox.email API

The bluefox.email API lets you manage every resource in your project - campaigns, templates, segments, domains, sender identities, contacts, subscriber lists, and more - and send transactional and triggered emails with attachments.

For AI agents and code generators

The full OpenAPI 3.0 spec is served live from the API itself, so an agent can fetch it directly and start calling endpoints without reading this page:

GET https://api.staging.bluefox.email/v1/openapi.json

It always reflects the current state of the API - every endpoint, request/response schema, and error shape on every resource's reference page (see the sidebar) is generated from that same document.

Authentication

Every endpoint is authenticated with a project API key, sent as a bearer token:

Authorization: Bearer YOUR_API_KEY

Create and manage keys under Project Settings > API Keys in the app, or via the /v1/projectId/{projectId}/api-keys endpoints themselves. Never expose an API key in frontend/client-side code - call the API from your backend.

A few endpoints (documented on the Subscriptions and Contacts reference pages) also accept requests from a whitelisted browser Origin, for use directly from a signup form or widget without exposing an API key.

Response format

Every response is wrapped the same way:

// success
{ "status": 200, "result": { "...": "..." } }

// error
{ "status": 400, "error": { "name": "VALIDATION_ERROR", "message": "Missing required field: name" } }

Pagination

List endpoints accept:

Parameter	Default	Notes
limit	10	Capped at 30
skip	0
sort	resource-specific	See each resource's reference page (in the sidebar) for the allowed fields
order	desc	asc or desc
filter[<field>]	-	Exact-match filter on a top-level field, e.g. filter[name]=Welcome

...and return count (the total number of matching items, not just this page) and next (the full URL of the next page, or null on the last page) alongside items.

Base URL

https://api.bluefox.email

Every project-scoped resource is shaped as /v1/projectId/{projectId}/{resource}. A handful of endpoints that predate this shape - /v1/contacts/{projectId}, /v1/send-transactional, /v1/send-triggered, /v1/subscriber-lists/{id}, and /v1/signup-forms/{id} - use an older flat URL and are documented separately below. They're also included in the spec for completeness.

API Reference

Every resource - Project, API Keys, Design Systems, Domains, Sender Identities, Webhook, Contacts, Campaigns, Transactional Emails, Triggered Emails, Templates, Segments, Subscriber Lists, and Suppression List - has its own reference page in the sidebar, generated from the same OpenAPI spec AI agents use: every endpoint, parameter, request body, and response shape.

Legacy endpoints

These older, flat-URL endpoints still work and are documented separately, but new integrations should use the resources listed in the sidebar instead:

• Contacts Management – Create, retrieve, update, and delete contacts programmatically, independent of any list.
• Subscriber List Management – Programmatically subscribe, unsubscribe, pause, activate, and update subscribers in your lists.
• Send Transactional Email – Deliver real-time, one-to-one emails such as password resets, order confirmations, and notifications.
• Send Triggered Email – Automate email sequences based on user actions, such as onboarding emails or follow-ups.
• Send Attachments – Attach files to your emails while ensuring proper formatting and size limitations.

Explore the API documentation to seamlessly integrate BlueFox Email into your workflows. 🚀