v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

List

Lists all offer profiles for an individual User.

get/offer_profiles/

Query parameters

offer_profile_category'all' | 'all_with_standard_flex_incentives' | 'only_with_standard_flex_incentives'

Controls inclusion/filtering of offer profiles with SFI.

status'available' | 'archived' | 'all'

Response

200

public_idstring

namestring

liveboolean

status'available' | 'archived'

weightinteger

offersstring[]

Example response

{
  "public_id": "e3e9ac44a24f15e485b0bc764e107cf3",
  "name": "offer profile name",
  "weight": 100,
  "offers": [
    "a748aa648ac811e8af3bbc764e106cf4"
  ],
  "recurring_coupon": {
    "public_id": "ff48e9fdc8eb4d79abd7c8c573523d25",
    "name": "Demo Store Incentives",
    "code": "demo_store",
    "discounts": [
      {
        "public_id": "c67dec11aedb4885aa9a58c3f89de746",
        "name": "Free shipping on orders over $50",
        "object": 1,
        "field": 2,
        "type": "Free discount_percent",
        "value": "100",
        "threshold_field": 3,
        "threshold_value": "50"
      }
    ]
  },
  "initial_coupon": {
    "public_id": "ff48e9fdc8eb4d79abd7c8c573523d25",
    "name": "Demo Store Incentives",
    "code": "demo_store",
    "discounts": [
      {
        "public_id": "c67dec11aedb4885aa9a58c3f89de746",
        "name": "Free shipping on orders over $50",
        "object": 1,
        "field": 2,
        "type": "Free discount_percent",
        "value": "100",
        "threshold_field": 3,
        "threshold_value": "50"
      }
    ]
  }
}