List experiments
Lists the project's experiments in use, or the archived ones with isArchived=true, optionally only those with a status.
Guide: Feature flags and A/B tests
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
Query parameters
Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.
How many items to return, from 1 to 100. Defaults to 50.
1 <= value <= 100Only experiments with this status: draft, running, paused or concluded.
Value in
- "draft"
- "running"
- "paused"
- "concluded"
true for only archived experiments; otherwise, the default, only the ones not archived.
Value in
- "true"
- "false"
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/experiments?status=running" \ -H "Authorization: Bearer vh_sk_..."{ "data": [ { "id": "exp_c6v8b3n5q0w2e7h7d2k9m4x1", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Onboarding paywall pricing", "description": "The monthly-first paywall against the annual-first one after onboarding.", "hypothesis": "Leading with the annual plan brings more new subscriptions.", "status": "running", "primaryMetricEventName": "$subscription.created", "secondaryMetricEventNames": [], "paywallLocationIds": [ "pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9" ], "winningVariantId": null, "featureFlagId": "ff_k9m4x1c6v8b3n5q0w2e7h7d2", "isArchived": false, "startedAt": "2026-03-02T09:00:00.000Z", "endedAt": null, "createdAt": "2026-02-27T15:20:00.000Z", "updatedAt": "2026-03-02T09:00:00.000Z" } ], "pageInfo": { "endCursor": null, "hasNextPage": false }}{ "error": { "type": "invalid_request", "code": "invalid_query", "message": "The request query is invalid: Expected a finite number\n at [\"limit\"]" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Experiments
- Create an experiment
POST - Retrieve an experiment
GET - Update an experiment
PATCH - Archive an experiment
POST - Unarchive an experiment
POST - Start an experiment
POST - Pause an experiment
POST - Conclude an experiment
POST - List an experiment's arms
GET - Replace an experiment's arms
PUT - Retrieve an experiment's results
GET
Something wrong or missing on this page? Tell us by email or on Discord.