For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inTry it free
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
  • REST API overview
    • Access Tokens
    • Account Members
    • Account Usage Beta
    • AI Configs
    • Announcements
    • Applications Beta
    • Approvals
    • Approvals Beta
    • Audit Log
    • Code References
    • Contexts
    • Context Settings
    • Custom Roles
    • Data Export Destinations
    • Environments
    • Experiments
    • Feature Flags
    • Feature Flags Beta
    • Flag Import Configurations Beta
    • Flag Links Beta
    • Flag Triggers
    • Follow Flags
    • Holdouts Beta
      • POSTCreate holdout
      • GETGet all holdouts
      • GETGet holdout
      • GETGet Holdout by Id
      • PATCHPatch holdout
    • Insights Charts Beta
    • Insights Deployments Beta
    • Insights Flag Events Beta
    • Insights Pull Requests Beta
    • Insights Repositories Beta
    • Insights Scores Beta
    • Integration Audit Log Subscriptions
    • Integration Delivery Configurations Beta
    • Integrations Beta
    • Layers
    • Metrics
    • Metrics Beta
    • OAuth2 Clients
    • Persistent Store Integrations Beta
    • Projects
    • Relay Proxy Configurations
    • Release Pipelines Beta
    • Releases Beta
    • Scheduled Changes
    • Segments
    • Tags
    • Teams
    • Teams Beta
    • Users
    • Users Beta
    • User Settings
    • Views Beta
    • Webhooks
    • Workflows
    • Workflow Templates
    • Other
Sign inTry it free
LogoLogo
REST API overviewHoldouts Beta

Get all holdouts

GET
/api/v2/projects/:projectKey/environments/:environmentKey/holdouts
GET
/api/v2/projects/:projectKey/environments/:environmentKey/holdouts
$curl https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/holdouts \
> -H "Authorization: <apiKey>"
1{
2 "items": [
3 {
4 "_id": "string",
5 "key": "string",
6 "name": "string",
7 "status": "string",
8 "createdAt": 1,
9 "updatedAt": 1,
10 "experiments": [
11 {
12 "key": "string",
13 "name": "string",
14 "environment": "string"
15 }
16 ]
17 }
18 ],
19 "_links": {
20 "self": {
21 "href": "/api/v2/my-project/environments/my-environment/holdouts?limit=20",
22 "type": "application/json"
23 }
24 },
25 "total_count": 1
26}
Was this page helpful?
Previous

Get holdout

Next
Built with

Authentication

Authorizationstring
API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"
The project key
environmentKeystringRequiredformat: "string"
The environment key

Query parameters

limitlongOptional
The number of holdouts to return in the response. Defaults to 20
offsetlongOptional

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Response

All Holdouts response
itemslist of objects
_linksmap from strings to objects
The location and content type of related resources
total_countinteger
The total number of holdouts in this project and environment.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error