Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

List Campaigns

List all mail campaigns with optional filtering by status, search, and whether the campaign can take new properties.
Every campaign has one of five statuses:
StatusMeaning
draftBeing built. No mail is sent and properties cannot be added yet.
readySaved with no mail queued. Properties can be added. A campaign that has sent all of its scheduled mail also returns to ready.
activeMail is queued or going out.
pausedStopped until it is resumed. Properties added now wait at step 1.
endedEnded permanently. No more mail is sent, properties cannot be added, and it cannot be paused or resumed.
Campaigns that were Completed or Cancelled before October 14, 2026 are reported as ended.
query pagenumberdefault: 1
Page number
query per_pagenumberdefault: 25
Results per page (1-100)
query statusstring
Filter by status: draft, ready, active, paused, or ended. ended matches every ended campaign. The older values completed and cancelled still work and match exactly the campaigns they matched before. Any other value returns 400 validation_error.
query accepting_propertiesboolean
Set to true to list only campaigns that properties can be added to right now: campaigns built to accept properties that are ready, active, or paused. Combine with status to narrow further, for example status=paused&accepting_properties=true. Omit it, or send false, for no filter.
query searchstring
Search by campaign name
Request example
curl "https://api.v2.dealmachine.com/v1/mail/campaigns?accepting_properties=true" \ -H "Authorization: Bearer dm_sk_live_xxx"
Response example
{ "data": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "organization_id": 42, "name": "Spring Seller Campaign", "description": "Postcards for potential sellers", "status": "active", "type": "one_off", "source": "api", "is_accepting_properties": true, "can_add_properties": true, "contact_name": "John Smith", "contact_phone": "555-123-4567", "contact_email": "john@example.com", "qr_code_link": null, "return_name": "Acme Real Estate", "return_address_1": "456 Business Ave", "return_address_2": null, "return_city": "Austin", "return_state": "TX", "return_zip": "78702", "total_recipients": 150, "total_sent": 120, "total_delivered": 115, "created_at": "2026-03-01T14:23:45Z", "updated_at": "2026-03-10T09:15:00Z", "launched_at": "2026-03-02T10:00:00Z", "completed_at": null, "steps": [ { "id": "1", "step_order": 1, "step_name": "Send", "design_id": "design-uuid-123", "design_prompt": null, "delay_days": 0, "interval_days": 0, "repeat_count": 1, "skip_if_responded": false } ] } ], "pagination": { "page": 1, "per_page": 25, "total": 1, "has_more": false } }