Get Application

GET/v1/applications/{applicationId}

Use it in a workflow

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

Request

Path parameters

applicationIdinteger (int64)required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Response

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

idinteger (int64)

The internal ID of this entity.

createdstring (date-time)

The time this entity was created.

modifiedstring (date-time)

The time this entity was last modified.

accountIdinteger (int64)

The ID of the account that owns this entity.

namestring

The name of this application.

descriptionstring

A longer description of the application.

timezonestring

A string containing an IANA timezone descriptor.

currencystring

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>

Default limits for campaigns created in this application.

actionstringrequired

The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon`

limitnumberrequired

The value to set for the limit.

periodstring

The period on which the budget limit recurs.

One ofdailyweeklymonthlyyearly

entitiesarray<string>required

The entity that this limit applies to.

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.

attributesSettingsobject

Arbitrary settings associated with attributes.

mandatoryobject2 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>

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

idinteger (int64)required

The ID of loyalty program.

createdstring (date-time)required

The time this entity was created.

titlestringrequired

The display title for the Loyalty Program.

descriptionstringrequired

Description of our Loyalty Program.

subscribedApplicationsarray<integer (int64)>required

A list containing the IDs of all applications that are subscribed to this Loyalty Program.

defaultValiditystringrequired

The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month.

defaultPendingstringrequired

The default duration of the pending time after which points should be valid. Accepted values: 'immediate', 'on_action' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month.

allowSubledgerbooleanrequired

Indicates if this program supports subledgers inside the program.

usersPerCardLimitinteger (int64)

The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`.

sandboxbooleanrequired

Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.

programJoinPolicystring

The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.

One ofnot_joinpoints_activatedpoints_earned

tiersExpirationPolicystring

The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined. - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier. - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program. - `customer_attribute`: The tier expiration is determined by a custom customer attribute. - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`.

One oftier_start_dateprogram_join_datecustomer_attributeabsolute_expiration

tierCycleStartDatestring (date-time)

Timestamp at which the tier cycle starts for all customers in the loyalty program. **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`.

tiersExpireInstring

The amount of time after which the tier expires and is reevaluated. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.

tiersDowngradePolicystring

The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment.

One ofone_downbalance_based

cardCodeSettingsobject2 fields

returnPolicystring

The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. - `unlimited`: Allows negative balance without any limit.

One ofonly_pendingwithin_balanceunlimited

accountIDinteger (int64)required

The ID of the Talon.One account that owns this program.

namestringrequired

The internal name for the Loyalty Program. This is an immutable value.

tiersarray<object>7 fields

The tiers in this loyalty program.

timezonestringrequired

A string containing an IANA timezone descriptor.

cardBasedbooleanrequired

Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based.

Default false

canUpdateTiersboolean

`True` if the tier definitions can be updated.

Default false

canUpdateTierExpirationPolicyboolean

`True` if the tier expiration policy can be updated.

canUpgradeToAdvancedTiersboolean

`True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties.

Default false

canUpdateSubledgersboolean

`True` if the `allowSubledger` property can be updated in the loyalty program.

Default false

json

{
  "id": 6,
  "created": {},
  "modified": {},
  "accountId": 3886,
  "name": "My Application",
  "timezone": "Europe/Berlin",
  "currency": "EUR",
  "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"
    }
  ],
  "description": "A test Application",
  "caseSensitivity": "sensitive",
  "attributes": {},
  "limits": [
    {
      "period": "yearly",
      "entities": [
        "Coupon"
      ],
      "limit": 1000,
      "action": "createCoupon"
    }
  ]
}

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

Was this page helpful?