Templates

List campaign templates

Paginated list of the user's reusable campaign templates. Requires scope campaigns:read.

get/api/v1/templates

Request

Base URL: https://getscaleforge.com
URL: https://getscaleforge.com/api/v1/templates
Auth: HTTP bearer

Query parameters

pageinteger

per_pageinteger

Response

Success

Example response

{
  "data": [
    {
      "id": 12,
      "name": "US-Desktop-Purchase",
      "product": "SweepstakesOffer",
      "objective": "OUTCOME_SALES",
      "status": "ACTIVE",
      "daily_budget": 100,
      "audience_name": "US 18-55 Interests",
      "age_min": 18,
      "age_max": 55,
      "genders": "all",
      "bid_strategy": "LOWEST_COST_WITH_BID_CAP",
      "start_bid": 4.4,
      "bid_step": 0.05,
      "bid_count": 5,
      "cta": "LEARN_MORE",
      "conversion_event": "Purchase",
      "geo_locations": [
        "US",
        "CA"
      ],
      "budget_optimization": "CBO",
      "naming_template": "{product}_{geo}_{bid}",
      "times_used": 3
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 137,
    "total_pages": 6
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.