GET
/
businesses
/
{id}
/
campaigns
List all campaigns
curl --request GET \
  --url https://api.pocketflows.com/businesses/{id}/campaigns \
  --header 'Authorization: Basic <encoded-value>'
{
  "campaigns": [
    {
      "id": "<string>",
      "name": "<string>",
      "enrolled_customers": [
        "<string>"
      ],
      "segment": "<string>",
      "steps": [
        {
          "type": "email",
          "custom_step_id": "<string>",
          "email_template_id": "<string>"
        }
      ],
      "email_address": "<string>",
      "phone_number": "<string>",
      "status": "draft",
      "scheduled_at": "<string>",
      "statistics": {
        "total_customers_enrolled": 123,
        "total_customers_started": 123,
        "total_customers_finished": 123
      },
      "consumed_message_segments": {
        "sms": 123,
        "mms": 123,
        "email": 123
      },
      "estimated_message_segments": {
        "sms": 123,
        "mms": 123,
        "email": 123
      },
      "attributed_revenue": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the business

Response

200 - application/json

A dictionary with a campaigns property which is an array of Campaign objects

The response is of type object.