Skip to main content
GET
/
api
/
campaigns
/
recipients
/
express-send
/
campaign
/
{campaignId}
Get express-send recipients by campaign ID with status filtering
curl --request GET \
  --url https://apiv1.delightloop.ai/api/campaigns/recipients/express-send/campaign/{campaignId}
{
  "recipients": [
    {
      "recipientId": "recipient_12345",
      "campaignId": "camp-abcd1234",
      "organizationId": "org_123",
      "landingPageId": "landing_123",
      "claimPageId": "claim_123",
      "contactDetails": {
        "contactId": "contact_123",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "company": "Acme Corp",
        "jobTitle": "Software Engineer",
        "addressLine1": "123 Main St",
        "addressLine2": "Apt 4B",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "USA",
        "phone": "+1234567890",
        "linkedInUrl": "https://linkedin.com/in/johndoe",
        "profileImage": "https://cdn.delightloop.ai/profiles/user-profile-456.jpg"
      },
      "sourceType": "contact_list",
      "sourceId": "source_123",
      "status": "pending",
      "createdAt": "2023-12-01T10:00:00Z",
      "updatedAt": "2023-12-01T10:30:00Z",
      "campaignName": "Holiday Gift Campaign",
      "giftDetails": {
        "giftId": "gift-123",
        "name": "Luxury Gift Hamper",
        "price": 150,
        "currency": "USD",
        "selectedAt": "2024-01-01T10:00:00Z"
      },
      "selectedGift": {
        "giftId": "gift_123",
        "name": "Amazon Gift Card",
        "price": 50,
        "currency": "USD",
        "description": "Digital gift card for Amazon",
        "imageUrl": "https://cdn.delightloop.ai/gifts/gift-preview-123.jpg",
        "selectedAt": "2023-12-01T10:00:00Z",
        "trackingLink": "https://tracking.fedex.com/123"
      },
      "urls": {
        "landingPage": "https://campaigns.delightloop.ai/lg/landing_123",
        "claimPage": "https://campaigns.delightloop.ai/cl/claim_123"
      },
      "personalization": {
        "giftCard": {}
      },
      "emails": {
        "addressConfirmation": {
          "active": true,
          "scheduledTime": "0",
          "sent": false,
          "sentAt": "2023-12-01T10:00:00Z",
          "html": "<html>Email content</html>",
          "subject": "Email Subject"
        },
        "reminder1": {
          "active": true,
          "scheduledTime": "0",
          "sent": false,
          "sentAt": "2023-12-01T10:00:00Z",
          "html": "<html>Email content</html>",
          "subject": "Email Subject"
        },
        "reminder2": {
          "active": true,
          "scheduledTime": "0",
          "sent": false,
          "sentAt": "2023-12-01T10:00:00Z",
          "html": "<html>Email content</html>",
          "subject": "Email Subject"
        },
        "postDelivery": {
          "active": true,
          "scheduledTime": "0",
          "sent": false,
          "sentAt": "2023-12-01T10:00:00Z",
          "html": "<html>Email content</html>",
          "subject": "Email Subject"
        },
        "postAcknowledgement": {
          "active": true,
          "scheduledTime": "0",
          "sent": false,
          "sentAt": "2023-12-01T10:00:00Z",
          "html": "<html>Email content</html>",
          "subject": "Email Subject"
        }
      },
      "feedback": {
        "rating": {
          "value": "like",
          "submittedAt": "2023-12-01T10:00:00Z"
        },
        "message": [
          {
            "type": "text",
            "submittedAt": "2023-12-01T10:00:00Z",
            "url": "https://cdn.delightloop.ai/media/personal-message-456.mp4",
            "text": "Thank you for the amazing gift!"
          }
        ]
      },
      "shipmentInfo": {},
      "assignedUsers": [
        {
          "userId": "user-123",
          "userName": "John Doe"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "hasNext": true,
    "hasPrev": true
  },
  "campaignId": "campaign_123",
  "organizationId": "org_123",
  "statusCounts": {
    "invite_sent": 15,
    "address_confirmed": 8,
    "processing": 3,
    "shipped": 2,
    "delivered": 1
  },
  "totalRecipientsInCampaign": 29,
  "filters": {
    "status": "invite_sent"
  }
}

Path Parameters

​
campaignId
string
required

Campaign ID to filter recipients

Example:

"campaign_123"

Query Parameters

​
page
number
default:1

Page number for pagination

Required range: x >= 1
Example:

1

​
limit
number
default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100
Example:

10

​
status
enum<string>

Filter by recipient status. Can be comma-separated for multiple statuses

Available options:
invite_sent,
address_confirmed,
processing,
shipped,
in_transit,
delivered,
acknowledged
Example:

"invite_sent,address_confirmed"

Response

Express-send recipients for campaign retrieved successfully

​
recipients
object[]
​
pagination
object
​
campaignId
string
Example:

"campaign_123"

​
organizationId
string
Example:

"org_123"

​
statusCounts
object

Count of recipients by status

Example:
{
  "invite_sent": 15,
  "address_confirmed": 8,
  "processing": 3,
  "shipped": 2,
  "delivered": 1
}
​
totalRecipientsInCampaign
number

Total number of recipients in campaign across all statuses

Example:

29

​
filters
object

Applied filters

Example:
{ "status": "invite_sent" }