---
title: "List campaign templates"
method: GET
path: "/v1/campaign_templates"
tags: ["Campaign templates"]
---

# List campaign templates

`GET /v1/campaign_templates`

## Request

- Base URL: `https://yourbaseurl.talon.one`
- URL: `https://yourbaseurl.talon.one/v1/campaign_templates`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/talon/apis/management-api/docs/v1/campaign_templates/get.ts> (a function with typed inputs; its response is checked against the schema)

> [!note] Management API endpoints are **not** meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Retrieve a list of campaign templates.

## Query parameters

- `pageSize` integer
- `skip` integer
- `sort` string
- `state` 'draft' | 'enabled' | 'disabled'
- `name` string
- `tags` string
- `userId` integer

## Response `200`

OK

- object
  - `hasMore` boolean, required
  - `data` CampaignTemplate[], required
    - `id` integer, required: The internal ID of this entity.
    - `created` string, date-time, required: The time this entity was created.
    - `accountId` integer, required: The ID of the account that owns this entity.
    - `userId` integer, required: The ID of the user associated with this entity.
    - `name` string, required: The campaign template name.
    - `description` string, required: Customer-facing text that explains the objective of the template.
    - `instructions` string, required: Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign.
    - `campaignAttributes` object: The campaign attributes that campaigns created from this template will have by default.
    - `couponAttributes` object: The campaign attributes that coupons created from this template will have by default.
    - `state` 'draft' | 'enabled' | 'disabled', required: Only campaign templates in 'available' state may be used to create campaigns.
    - `activeRulesetId` integer: The ID of the ruleset this campaign template will use.
    - `tags` string[]: A list of tags for the campaign template.
    - `reevaluateOnReturn` boolean, required: Indicates whether campaigns created from this template should be reevaluated when a customer returns an item.
    - `features` string[]: A list of features for the campaign template.
    - `couponSettings` CodeGeneratorSettings
      - `validCharacters` string[], required: List of characters used to generate the random parts of a code.
      - `couponPattern` string, required: The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set.
    - `couponReservationSettings` CampaignTemplateCouponReservationSettings
      - `reservationLimit` integer: The number of reservations that can be made with this coupon code.
      - `isReservationMandatory` boolean: An indication of whether the code can be redeemed only if it has been reserved first.
    - `referralSettings` CodeGeneratorSettings
      - `validCharacters` string[], required: List of characters used to generate the random parts of a code.
      - `couponPattern` string, required: The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set.
    - `limits` TemplateLimitConfig[]: The set of limits that operate for this campaign template.
      - `action` string, required: The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon`
      - `limit` number, required: The value to set for the limit.
      - `period` 'daily' | 'weekly' | 'monthly' | 'yearly': The period on which the budget limit recurs.
      - `entities` string[], required: The entity that this limit applies to.
    - `templateParams` CampaignTemplateParams[]: Fields which can be used to replace values in a rule.
      - `name` string, required: Name of the campaign template parameter.
      - `type` 'string' | 'number' | 'boolean' | 'percent' | '(list string)' | '(list number)' | 'time', required: Defines the type of parameter value.
      - `description` string, required: Explains the meaning of this template parameter and the placeholder value that will define it. It is used on campaign creation from this template.
      - `attributeId` integer: ID of the corresponding attribute.
    - `applicationsIds` integer[], required: A list of IDs of the Applications that are subscribed to this campaign template.
    - `campaignCollections` CampaignTemplateCollection[]: The campaign collections from the blueprint campaign for the template.
      - `name` string, required: The name of this collection.
      - `description` string: A short description of the purpose of this collection.
    - `defaultCampaignGroupId` integer: The default campaign group ID.
    - `campaignType` 'cartItem' | 'advanced', required: The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items.
    - `campaignsCount` integer: The number of Campaigns created from this template.
    - `updated` string, date-time: Timestamp of the most recent update to the campaign template or any of its elements.
    - `updatedBy` string: Name of the user who last updated this campaign template, if available.
    - `validApplicationIds` integer[], required: The IDs of the Applications that are related to this entity.
    - `isUserFavorite` boolean: A flag indicating whether the user marked the template as a favorite.

---

[API](https://skmtc.dev/talon/apis/management-api.md) - [All operations](https://skmtc.dev/talon/apis/management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/talon/apis/management-api/revisions/7ef1b9504c3a?raw)