v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
audiences

fetch list of active campaigns for a given audience

get/api/servicepool/audiences/{identifier}/activeCampaigns

Path parameters

identifierstring uuid required

audience unique identifier

Response

list of active campaigns for a given audience

Example response

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "companyUuid": "123e4567-e89b-12d3-a456-426614174000",
      "audienceUuid": "123e4567-e89b-12d3-a456-426614174000",
      "linkedOpeningUuid": "123e4567-e89b-12d3-a456-426614174000",
      "campaignType": "email",
      "status": "active",
      "outboundMessages": [
        {
          "day": 1,
          "communicateCampaignUuid": "123e4567-e89b-12d3-a456-426614174000",
          "hour": "12",
          "minute": "00",
          "timezone": "America/New_York",
          "stats": {
            "total": 100,
            "sent": 100,
            "failed": 100,
            "delivered": 100,
            "clicked": 100,
            "opened": 100,
            "unsubscribed": 5
          },
          "calculatedStats": {
            "deliveryRate": 100,
            "openRate": 100,
            "clickRate": 100,
            "bounceRate": 100,
            "unsubscribeRate": 5
          }
        }
      ],
      "name": "Campaign 1",
      "from": "noreply@fountain.com",
      "category": "application",
      "mode": "dynamic",
      "activatedAt": "2025-05-22T14:15:00.000+00:00",
      "deactivateAt": "2025-05-22T14:15:00.000+00:00",
      "talentCount": 100,
      "recipients": 100,
      "audienceName": "High Priority Candidates",
      "audienceFilterValues": "0%255B0%255D%255Bid%255D%3DprimaryCustomValues",
      "timezone": "America/Mexico_City",
      "messageSendSetting": "None",
      "stats": {
        "total": 100,
        "sent": 100,
        "failed": 100,
        "delivered": 100,
        "clicked": 100,
        "opened": 100,
        "unsubscribed": 5
      },
      "calculatedStats": {
        "deliveryRate": 100,
        "openRate": 100,
        "clickRate": 100,
        "bounceRate": 100,
        "unsubscribeRate": 5
      },
      "createdAt": "2025-05-22T14:15:00.000Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2025-05-22T14:15:00.000Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "deletedAt": "2025-05-22T14:15:00.000+00:00",
      "deletedBy": "123e4567-e89b-12d3-a456-426614174000",
      "archivedAt": "2025-05-22T14:15:00.000+00:00",
      "archivedBy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}