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

# List Experiments

GET https://restapi.ordergroove.com/experiments/list-experiments/



Reference: https://ordergroove.ferndocs.com/reference/rest-rpc-api/experiments/list-experiments

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Query parameters

- `merchant_public_id` (string, required) — Merchant Public ID
- `experiment_type` (enum, optional) — Filters by experiment type
  - Allowed values: `"retry_flows"`, `"offer_incentives"`
- `status` (enum, optional) — Filters by status of experiment
  - Allowed values: `"created"`, `"running"`, `"aborted"`, `"finished"`

## Response

### 200

200

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

## Errors

### 400 Bad Request Error

400

## Types

### ExperimentsListExperimentsGetResponsesContentApplicationJsonSchemaResultsItems

- `public_id` (string, optional)
- `merchant` (string, optional)
- `name` (string, optional)
- `description` (string, optional)
- `hypothesis` (string, optional)
- `primary_metric` (string, optional)
- `guardrail_metric` (string, optional)
- `experiment_type` (string, optional)
- `scheduled_finish_time` (string, optional)
- `status` (string, optional)
- `started_at` (string, optional)
- `ended_at` (string, optional)
- `final_configuration` (ExperimentsListExperimentsGetResponsesContentApplicationJsonSchemaResultsItemsFinalConfiguration, optional)
- `created_at` (string, optional)
- `last_updated_at` (string, optional)
- `variants` (list of ExperimentsListExperimentsGetResponsesContentApplicationJsonSchemaResultsItemsVariantsItems, optional)

### ExperimentsListExperimentsGetResponsesContentApplicationJsonSchemaResultsItemsFinalConfiguration

- `winning_variant` (string, optional)
- `confidence_level` (double, optional, default: 0)
- `winning_offer_profile` (string, optional)

### ExperimentsListExperimentsGetResponsesContentApplicationJsonSchemaResultsItemsVariantsItems

- `experiment` (string, optional)
- `public_id` (string, optional)
- `name` (string, optional)
- `weight` (integer, optional, default: 0)
- `is_control` (boolean, optional, default: true)
- `created_at` (string, optional)
- `last_updated_at` (string, optional)
- `parameters` (ExperimentsListExperimentsGetResponsesContentApplicationJsonSchemaResultsItemsVariantsItemsParameters, optional)

### ExperimentsListExperimentsGetResponsesContentApplicationJsonSchemaResultsItemsVariantsItemsParameters

- `offer_profile_public_id` (string, optional)

## Examples

**Response**

```json
{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "public_id": "abc123def456ghi789jkl012mno345pqr678",
      "merchant": "merchant123def456ghi789jkl012mno345pqr678",
      "name": "Discount Strategy A/B Test Q4 2025",
      "description": "Testing different discount strategies to improve retention rates",
      "hypothesis": "20% discount every 5 orders will increase retention rate by 15%",
      "primary_metric": "recovery_rate",
      "guardrail_metric": "retry_efficiency",
      "experiment_type": "offer_incentives",
      "scheduled_finish_time": "2024-02-31T23:59:59Z",
      "status": "running",
      "started_at": "2024-01-15T10:30:00Z",
      "ended_at": "2024-02-15T10:30:00Z",
      "final_configuration": {
        "winning_variant": "variant_123",
        "confidence_level": 0.95,
        "winning_offer_profile": "offer_profile_public_id"
      },
      "created_at": "2024-01-01T10:00:00Z",
      "last_updated_at": "2024-01-15T10:30:00Z",
      "variants": [
        {
          "experiment": "ecb42bee71ff11efb72ef29e3ec3bb34",
          "public_id": "bf719da0720011ef819df29e3ec3bb34",
          "name": "Treatment variant",
          "weight": 50,
          "is_control": false,
          "created_at": "2024-09-13T13:48:20.928692",
          "last_updated_at": "2024-09-13T13:48:20.928723",
          "parameters": {
            "offer_profile_public_id": "43ad71484b7c11eb9afe36931c4b8b28"
          }
        },
        {
          "experiment": "ecb42bee71ff11efb72ef29e3ec3bb34",
          "public_id": "abc5d834720011ef9ac8e2793bd7407d",
          "name": "Control variant",
          "weight": 50,
          "is_control": true,
          "created_at": "2024-09-13T13:47:47.927550",
          "last_updated_at": "2024-09-13T13:47:47.927583",
          "parameters": {
            "offer_profile_public_id": "43ad71484b7c11eb9afe36931c4b8b28"
          }
        }
      ]
    }
  ]
}
```

**SDK Code**

```python Result
import requests

url = "https://restapi.ordergroove.com/experiments/list-experiments/"

querystring = {"merchant_public_id":"merchant_public_id"}

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

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

print(response.json())
```

```javascript Result
const url = 'https://restapi.ordergroove.com/experiments/list-experiments/?merchant_public_id=merchant_public_id';
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/experiments/list-experiments/?merchant_public_id=merchant_public_id"

	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/experiments/list-experiments/?merchant_public_id=merchant_public_id")

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/experiments/list-experiments/?merchant_public_id=merchant_public_id")
  .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/experiments/list-experiments/?merchant_public_id=merchant_public_id', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Result
using RestSharp;

var client = new RestClient("https://restapi.ordergroove.com/experiments/list-experiments/?merchant_public_id=merchant_public_id");
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/experiments/list-experiments/?merchant_public_id=merchant_public_id")! 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()
```