Skip to main content
GET
/
campaign_templates
Retrieve all campaign templates
curl --request GET \
  --url https://api.pocketflows.com/campaign_templates \
  --header 'Authorization: Basic <encoded-value>'
{
  "campaign_templates": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "campaign": {
        "id": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "business": "<string>",
        "name": "<string>",
        "segment": "<string>",
        "steps": [
          {
            "type": "email",
            "email_template_id": "<string>",
            "custom_step_id": "<string>"
          }
        ],
        "email_address": "<string>",
        "phone_number": "<string>",
        "status": "draft",
        "scheduled_at": "<string>",
        "scheduled_end_at": "<string>",
        "statistics": {
          "emails": {
            "sent": 123,
            "delivered": 123,
            "opened": 123,
            "soft_bounced": 123,
            "hard_bounced": 123,
            "clicked": 123
          },
          "custom_steps": [
            {
              "custom_step": "<string>",
              "sent": 123
            }
          ],
          "executions": {
            "total": 123,
            "pending": 123,
            "started": 123,
            "finished": 123,
            "errored": 123
          },
          "sms": {
            "sms_sent_count": 123,
            "sms_sent_segments_count": 123,
            "mms_sent_count": 123,
            "mms_sent_segments_count": 123
          },
          "total_customers_enrolled": 123,
          "total_customers_started": 123,
          "total_customers_finished": 123
        },
        "consumed_message_segments": {
          "sms": 123,
          "mms": 123,
          "email": 123
        },
        "attributed_revenue": "<string>",
        "metadata": {},
        "enrolled_customers": [
          "<string>"
        ],
        "estimated_message_segments": {
          "sms": 123,
          "mms": 123,
          "email": 123
        }
      },
      "enabled": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200 - application/json

A dictionary with a campaign_templates property that contains an array of CampaignTemplate objects

campaign_templates
The Campaign Template object · object[]
required

The campaign templates associated with this project