curl https://api.v2.dealmachine.com/v1/mail/campaigns/a1b2c3d4/recipients \
-H "Authorization: Bearer dm_sk_live_xxx"
{
"data": [
{
"id": "1",
"campaign_id": "a1b2c3d4",
"internal_property_id": "12345",
"recipient_name": "John Doe",
"recipient_address_1": "123 Main St",
"recipient_city": "Austin",
"recipient_state": "TX",
"recipient_zip": "78701",
"status": "delivered",
"current_step_order": 1,
"created_at": "2026-03-02T10:00:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 150,
"has_more": true
}
}
Mail Campaigns
List Recipients
List recipients enrolled in a campaign
GET
/
v1
/
mail
/
campaigns
/
{id}
/
recipients
curl https://api.v2.dealmachine.com/v1/mail/campaigns/a1b2c3d4/recipients \
-H "Authorization: Bearer dm_sk_live_xxx"
{
"data": [
{
"id": "1",
"campaign_id": "a1b2c3d4",
"internal_property_id": "12345",
"recipient_name": "John Doe",
"recipient_address_1": "123 Main St",
"recipient_city": "Austin",
"recipient_state": "TX",
"recipient_zip": "78701",
"status": "delivered",
"current_step_order": 1,
"created_at": "2026-03-02T10:00:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 150,
"has_more": true
}
}
List all recipients enrolled in a campaign with their current delivery status.
string
required
Campaign ID (UUID)
number
default:"1"
Page number
number
default:"25"
Results per page (1-100)
curl https://api.v2.dealmachine.com/v1/mail/campaigns/a1b2c3d4/recipients \
-H "Authorization: Bearer dm_sk_live_xxx"
{
"data": [
{
"id": "1",
"campaign_id": "a1b2c3d4",
"internal_property_id": "12345",
"recipient_name": "John Doe",
"recipient_address_1": "123 Main St",
"recipient_city": "Austin",
"recipient_state": "TX",
"recipient_zip": "78701",
"status": "delivered",
"current_step_order": 1,
"created_at": "2026-03-02T10:00:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 150,
"has_more": true
}
}
⌘I