> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.ordergroove.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.ordergroove.com/_mcp/server.

# List offer profiles

GET https://restapi.ordergroove.com/offer_profiles/

Returns offer profiles — the configurations that pair a set of `offers` with the `initial_coupon` and `recurring_coupon` carrying their discounts.

This endpoint accepts the Application API Scope only. Storefront API Scope signatures are rejected.

Reference: https://developer.ordergroove.com/reference/rest-rpc-api/offer-profiles/offer-profile-list

## Authentication

- `x-api-key` header (required) — Application API Scope — server-to-server, sent in the `x-api-key` header. See [Authentication](/api-reference/authentication).

## Request

### Query parameters

- `live` (boolean, optional) — Filter by whether the offer profile is live. Use `true` to return only live profiles.
- `offer_profile_category` (enum, optional) — Which offer profiles to return, and whether to include their conditional incentives. `all` (the default) returns every profile without them. `all_with_standard_flex_incentives` returns every profile and adds `standard_flex_incentives` to each coupon. `only_with_standard_flex_incentives` returns only profiles that have conditional incentives, with them included.
  - Allowed values: `all`, `all_with_standard_flex_incentives`, `only_with_standard_flex_incentives`
- `status` (enum, optional, default: available) — Filter by archive status. Defaults to `available`, which excludes archived profiles.
  - Allowed values: `available`, `archived`, `all`
- `page` (integer, optional, default: 1) — Page number to return.
- `page_size` (integer, optional, default: 10) — Number of offer profiles per page. Default value is 10, maximum allowed is 100.

## Response

### 200

200

- `count` (integer, optional, default: 0)
- `next` (string, optional, nullable)
- `previous` (string, optional, nullable)
- `results` (list of OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItems, optional)

## Errors

### 403 Forbidden Error

403

- `detail` (string, optional)

## Types

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItems

- `public_id` (string, optional)
- `name` (string, optional)
- `live` (boolean, optional) — Whether this is a live offer profile.
- `status` (enum, optional)
  - Allowed values: `available`, `archived`
- `weight` (integer, optional, default: 0)
- `offers` (list of string, optional)
- `recurring_coupon` (OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCoupon, optional)
- `initial_coupon` (OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCoupon, optional)
- `merchant` (string, optional) — Merchant public ID
- `is_standardized` (boolean, optional) — `true` when the offer profile was built in Incentives Builder. For a Shopify merchant, the selling plans then carry no price adjustment and the initial order discount is applied by a Shopify discount function.

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCoupon

- `public_id` (string, optional)
- `name` (string, optional)
- `code` (string, optional)
- `discounts` (list of OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCouponDiscountsItems, optional) — Every discount on the coupon, including conditional ones.
- `has_conditions` (boolean, optional) — Whether any incentive on the coupon has conditions.
- `standard_flex_incentives` (list of OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCouponStandardFlexIncentivesItems, optional) — Each conditional incentive on the coupon, with its criteria. Only included when `offer_profile_category` is `all_with_standard_flex_incentives` or `only_with_standard_flex_incentives`.

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCoupon

- `public_id` (string, optional)
- `name` (string, optional)
- `code` (string, optional)
- `discounts` (list of OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCouponDiscountsItems, optional) — Every discount on the coupon, including conditional ones.
- `has_conditions` (boolean, optional) — Whether any incentive on the coupon has conditions.
- `standard_flex_incentives` (list of OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCouponStandardFlexIncentivesItems, optional) — Each conditional incentive on the coupon, with its criteria. Only included when `offer_profile_category` is `all_with_standard_flex_incentives` or `only_with_standard_flex_incentives`.

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCouponDiscountsItems

- `public_id` (string, optional)
- `name` (string, optional)
- `object` (integer, optional, default: 0) — What the discount applies to: `1` for the order, `2` for an item.
- `field` (integer, optional, default: 0) — The amount the discount is taken from: `1` for the item total price, `2` for the order shipping total, `3` for the order subtotal.
- `type` (enum, optional)
  - Allowed values: `discount_percent`, `discount_amount`
- `value` (string, optional) — Discount amount or percentage, as a decimal string.
- `threshold_field` (integer, optional, default: 0) — The amount compared with `threshold_value`, using the same codes as `field`. `null` when the discount has no threshold.
- `threshold_value` (string, optional)
- `has_conditions` (boolean, optional) — `false` when the discount applies program-wide; `true` when it belongs to a conditional incentive.

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCouponStandardFlexIncentivesItems

- `public_id` (string, optional)
- `offer_profile` (string, optional) — Offer profile public ID
- `coupon_type` (enum, optional)
  - Allowed values: `initial`, `recurring`
- `description` (string, optional, nullable)
- `criteria` (OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCouponStandardFlexIncentivesItemsCriteria, optional) — The eligibility criteria.
- `incentives` (list of OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCouponStandardFlexIncentivesItemsIncentivesItems, optional)

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCouponDiscountsItems

- `public_id` (string, optional)
- `name` (string, optional)
- `object` (integer, optional, default: 0) — What the discount applies to: `1` for the order, `2` for an item.
- `field` (integer, optional, default: 0) — The amount the discount is taken from: `1` for the item total price, `2` for the order shipping total, `3` for the order subtotal.
- `type` (enum, optional)
  - Allowed values: `discount_percent`, `discount_amount`
- `value` (string, optional) — Discount amount or percentage, as a decimal string.
- `threshold_field` (integer, optional, default: 0) — The amount compared with `threshold_value`, using the same codes as `field`. `null` when the discount has no threshold.
- `threshold_value` (string, optional)
- `has_conditions` (boolean, optional) — `false` when the discount applies program-wide; `true` when it belongs to a conditional incentive.

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCouponStandardFlexIncentivesItems

- `public_id` (string, optional)
- `offer_profile` (string, optional) — Offer profile public ID
- `coupon_type` (enum, optional)
  - Allowed values: `initial`, `recurring`
- `description` (string, optional, nullable)
- `criteria` (OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCouponStandardFlexIncentivesItemsCriteria, optional) — The eligibility criteria.
- `incentives` (list of OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCouponStandardFlexIncentivesItemsIncentivesItems, optional)

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCouponStandardFlexIncentivesItemsCriteria

The eligibility criteria.

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsRecurringCouponStandardFlexIncentivesItemsIncentivesItems

- `incentive_type` (enum, optional)
  - Allowed values: `discount_percent`, `discount_amount`, `gift`
- `incentive_value` (string, optional)
- `incentive_target` (enum, optional)
  - Allowed values: `item`, `order`, `shipping`
- `threshold_field` (enum, optional, nullable)
  - Allowed values: `order`, `item`
- `threshold_value` (string, optional, nullable)
- `name` (string, optional)

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCouponStandardFlexIncentivesItemsCriteria

The eligibility criteria.

### OfferProfilesGetResponsesContentApplicationJsonSchemaResultsItemsInitialCouponStandardFlexIncentivesItemsIncentivesItems

- `incentive_type` (enum, optional)
  - Allowed values: `discount_percent`, `discount_amount`, `gift`
- `incentive_value` (string, optional)
- `incentive_target` (enum, optional)
  - Allowed values: `item`, `order`, `shipping`
- `threshold_field` (enum, optional, nullable)
  - Allowed values: `order`, `item`
- `threshold_value` (string, optional, nullable)
- `name` (string, optional)

## Examples

**Response**

```json
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "public_id": "e3e9ac44a24f15e485b0bc764e107cf3",
      "name": "offer profile name",
      "live": true,
      "status": "available",
      "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": "discount_percent",
            "value": "100.00",
            "threshold_field": 3,
            "threshold_value": "50.00",
            "has_conditions": false
          }
        ],
        "has_conditions": false
      },
      "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": "discount_percent",
            "value": "100.00",
            "threshold_field": 3,
            "threshold_value": "50.00",
            "has_conditions": false
          }
        ],
        "has_conditions": false
      },
      "merchant": "0e5de2bedc5911e3a2a7bc764e106cf4",
      "is_standardized": false
    }
  ]
}
```

**SDK Code**

```python Result
import requests

url = "https://restapi.ordergroove.com/offer_profiles/"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Result
const url = 'https://restapi.ordergroove.com/offer_profiles/';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Result
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://restapi.ordergroove.com/offer_profiles/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Result
require 'uri'
require 'net/http'

url = URI("https://restapi.ordergroove.com/offer_profiles/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Result
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://restapi.ordergroove.com/offer_profiles/")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Result
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://restapi.ordergroove.com/offer_profiles/', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Result
using RestSharp;

var client = new RestClient("https://restapi.ordergroove.com/offer_profiles/");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Result
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://restapi.ordergroove.com/offer_profiles/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```