API Reference

Api ReferenceUpdated February 18, 2025

API Reference

Complete documentation for all MachFive API endpoints.

Base URL

All API requests should be made to:

https://app.machfive.io

Endpoints

The MachFive API provides the following endpoints:

  • Campaigns – List campaigns in your workspace
  • Generate – Generate sequence for one lead (sync, 3–10 min)
  • Generate Batch – Submit multiple leads (async, returns list_id)
  • Lists – List status and export results
  • Errors – Error codes and troubleshooting

Quick Reference

ResourceEndpointMethodDescription
Campaigns/api/v1/campaignsGETList campaigns in your workspace
Generate/api/v1/campaigns/:id/generatePOSTGenerate sequence for one lead (sync, 3–10 min)
Batch/api/v1/campaigns/:id/generate-batchPOSTSubmit multiple leads (async, returns list_id)
Lists/api/v1/listsGETList lead lists (batch jobs)
List/api/v1/lists/:idGETGet list status (poll until completed)
Export/api/v1/lists/:id/exportGETDownload results (CSV or JSON)

Authentication

All requests require authentication. See Authorization for details.