Get Applications

List Applications

GET/v1/applications

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Applications action (under management).
Fill in the fields below, then reference the result from later steps as {{getApplications.response.data}}.

Request

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

Response

Returns 200 with an object. Read it in later steps with {{getApplications.response.data.<field>}}.

totalResultSizeinteger (int64)

dataarray<object>

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

modifiedstring (date-time)required

The time this entity was last modified.

accountIdinteger (int64)required

The ID of the account that owns this entity.

namestringrequired

The name of this application.

descriptionstring

A longer description of the application.

timezonestringrequired

A string containing an IANA timezone descriptor.

currencystringrequired

The default currency for new customer sessions.

caseSensitivitystring

The case sensitivity behavior to check coupon codes in the campaigns of this Application.

One ofsensitiveinsensitive-uppercaseinsensitive-lowercase

attributesobject

Arbitrary properties associated with this campaign.

limitsarray<object>4 fields

Default limits for campaigns created in this application.

defaultDiscountScopestring

The default scope to apply `setDiscount` effects on if no scope was provided with the effect.

One ofsessionTotalcartItemsadditionalCosts

enableCascadingDiscountsboolean

Indicates if discounts should cascade for this Application.

enableFlattenedCartItemsboolean

Indicates if cart items of quantity larger than one should be separated into different items of quantity one.

attributesSettingsobject1 fields

Arbitrary settings associated with attributes.

sandboxboolean

Indicates if this is a live or sandbox Application.

enablePartialDiscountsboolean

Indicates if this Application supports partial discounts.

defaultDiscountAdditionalCostPerItemScopestring

The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect.

One ofpriceitemTotaladditionalCosts

defaultEvaluationGroupIdinteger (int64)

The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign.

defaultCartItemFilterIdinteger (int64)

The ID of the default Cart-Item-Filter for this application.

enableCampaignStateManagementboolean

Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled.

loyaltyProgramsarray<object>required26 fields

An array containing all the loyalty programs to which this application is subscribed.

json

{
  "totalResultSize": 1,
  "data": [
    {
      "enableFlattenedCartItems": true,
      "created": {},
      "timezone": "Europe/Berlin",
      "defaultCartItemFilterId": 3,
      "enableCampaignStateManagement": false,
      "sandbox": true,
      "description": "A test Application",
      "attributesSettings": {
        "mandatory": {
          "campaigns": [
            "campaigns",
            "campaigns"
          ],
          "coupons": [
            "coupons",
            "coupons"
          ]
        }
      },
      "caseSensitivity": "sensitive",
      "accountId": 3886,
      "defaultEvaluationGroupId": 3,
      "enableCascadingDiscounts": true,
      "loyaltyPrograms": [
        {
          "cardBased": true,
          "tiers": [
            {
              "name": "Gold",
              "minPoints": 300,
              "id": 3,
              "created": {},
              "programID": 139
            },
            {
              "name": "Silver",
              "minPoints": 200,
              "id": 2,
              "created": {},
              "programID": 139
            },
            {
              "name": "Bronze",
              "minPoints": 100,
              "id": 1,
              "created": {},
              "programID": 139
            }
          ],
          "canUpdateTiers": true,
          "usersPerCardLimit": 111,
          "tierCycleStartDate": {},
          "timezone": "Europe/Berlin",
          "description": "Customers collect 10 points per 1$ spent",
          "title": "Point collection",
          "canUpdateSubledgers": true,
          "programJoinPolicy": "not_join",
          "accountID": 1,
          "defaultPending": "immediate",
          "tiersDowngradePolicy": "one_down",
          "cardCodeSettings": {
            "couponPattern": "SUMMER-####-####",
            "validCharacters": [
              "A",
              "B",
              "C",
              "D",
              "E",
              "F",
              "G",
              "H",
              "I",
              "J",
              "K",
              "L",
              "M",
              "N",
              "O",
              "P",
              "Q",
              "R",
              "S",
              "T",
              "U",
              "V",
              "W",
              "X",
              "Y",
              "Z",
              "0",
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8",
              "9"
            ]
          },
          "id": 139,
          "canUpgradeToAdvancedTiers": true,
          "created": {},
          "sandbox": true,
          "returnPolicy": "only_pending",
          "subscribedApplications": [
            132,
            97
          ],
          "tiersExpirationPolicy": "tier_start_date",
          "defaultValidity": "2W_U",
          "canUpdateTierExpirationPolicy": true,
          "allowSubledger": false,
          "tiersExpireIn": "27W_U",
          "name": "my_program"
        },
        {
          "cardBased": true,
          "tiers": [
            {
              "name": "Gold",
              "minPoints": 300,
              "id": 3,
              "created": {},
              "programID": 139
            },
            {
              "name": "Silver",
              "minPoints": 200,
              "id": 2,
              "created": {},
              "programID": 139
            },
            {
              "name": "Bronze",
              "minPoints": 100,
              "id": 1,
              "created": {},
              "programID": 139
            }
          ],
          "canUpdateTiers": true,
          "usersPerCardLimit": 111,
          "tierCycleStartDate": {},
          "timezone": "Europe/Berlin",
          "description": "Customers collect 10 points per 1$ spent",
          "title": "Point collection",
          "canUpdateSubledgers": true,
          "programJoinPolicy": "not_join",
          "accountID": 1,
          "defaultPending": "immediate",
          "tiersDowngradePolicy": "one_down",
          "cardCodeSettings": {
            "couponPattern": "SUMMER-####-####",
            "validCharacters": [
              "A",
              "B",
              "C",
              "D",
              "E",
              "F",
              "G",
              "H",
              "I",
              "J",
              "K",
              "L",
              "M",
              "N",
              "O",
              "P",
              "Q",
              "R",
              "S",
              "T",
              "U",
              "V",
              "W",
              "X",
              "Y",
              "Z",
              "0",
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8",
              "9"
            ]
          },
          "id": 139,
          "canUpgradeToAdvancedTiers": true,
          "created": {},
          "sandbox": true,
          "returnPolicy": "only_pending",
          "subscribedApplications": [
            132,
            97
          ],
          "tiersExpirationPolicy": "tier_start_date",
          "defaultValidity": "2W_U",
          "canUpdateTierExpirationPolicy": true,
          "allowSubledger": false,
          "tiersExpireIn": "27W_U",
          "name": "my_program"
        }
      ],
      "name": "My Application",
      "modified": {},
      "defaultDiscountScope": "sessionTotal",
      "currency": "EUR",
      "attributes": "{}",
      "defaultDiscountAdditionalCostPerItemScope": "price",
      "id": 6,
      "limits": [
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        },
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        }
      ],
      "enablePartialDiscounts": false
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?