> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/feature-management-experimentation/split-api-reference/change-requests.md).

# Change Requests

## List Change Requests

> Retrieves change requests. GET endpoints like List Change Requests do not accept a JSON body—all inputs are provided using query parameters.

```json
{"openapi":"3.1.0","info":{"title":"Harness FME Admin API","version":"2"},"tags":[{"name":"Change Requests"}],"servers":[{"url":"https://api.split.io/internal/api/v2"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Admin API Key, sent as `Authorization: Bearer <ADMIN_API_KEY>`"}}},"paths":{"/changeRequests":{"get":{"summary":"List Change Requests","description":"Retrieves change requests. GET endpoints like List Change Requests do not accept a JSON body—all inputs are provided using query parameters.","operationId":"list-change-requests","parameters":[{"name":"status","in":"query","description":"These are valid statuses: REQUESTED, SCHEDULE_REQUESTED, APPROVED, REJECTED, WITHDRAWN, PUBLISHED. By default, the API returns REQUESTED change requests.","schema":{"type":"string","default":"REQUESTED"}},{"name":"limit","in":"query","description":"1-100 are the potential values. The default limit is 20 per page.","schema":{"type":"string"}},{"name":"before","in":"query","description":"Value of \"previousMarker\" in response","schema":{"type":"string"}},{"name":"after","in":"query","description":"Value of \"nextMarker\" in response","schema":{"type":"string"}},{"name":"environmentId","in":"query","description":"Limits the change requests to those for a particular environment within the specified project (or workspace). \n\nOnly required if `workspaceId` is not set.","required":true,"schema":{"type":"string"}},{"name":"objectType","in":"query","schema":{"type":"string","default":"Split | Segment"}},{"in":"query","name":"workspaceId","schema":{"type":"string","default":""},"required":true,"description":"Limits the change requests to those for a particular project (or workspace).\n\nOnly required if `environmentId` is not set."}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"split":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"trafficType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"killed":{"type":"boolean","default":true},"treatments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"configurations":{"type":"string"}}}},"defaultTreatment":{"type":"string"},"baselineTreatment":{"type":"string"},"trafficAllocation":{"type":"integer","default":0},"rules":{"type":"array","items":{"type":"object","properties":{"buckets":{"type":"array","items":{"type":"object","properties":{"treatment":{"type":"string"},"size":{"type":"integer","default":0}}}},"condition":{"type":"object","properties":{"combiner":{"type":"string"},"matchers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"string":{"type":"string"}}}}}}}}},"defaultRule":{"type":"array","items":{"type":"object","properties":{"treatment":{"type":"string"},"size":{"type":"integer","default":0}}}},"openChangeRequestId":{"type":"string"}}},"segment":{},"id":{"type":"string"},"status":{"type":"string"},"title":{"type":"string"},"comment":{},"approvers":{"type":"array","items":{"type":"object","properties":{}}},"operationType":{"type":"string"},"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string"},"user":{"type":"string"},"role":{"type":"string"},"timestamp":{"type":"integer","default":0}}}},"rolloutStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"scheduledFor":{"type":"integer","description":"Unix epoch timestamp in milliseconds. Null when the change request is not scheduled."}}}}}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"deprecated":false,"tags":["Change Requests"]}}}}
```

## Get Change Request

> Retrieves an open change request given an ID. GET endpoints like Get Change Request do not accept a JSON body—all inputs are provided using query parameters.

```json
{"openapi":"3.1.0","info":{"title":"Harness FME Admin API","version":"2"},"tags":[{"name":"Change Requests"}],"servers":[{"url":"https://api.split.io/internal/api/v2"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Admin API Key, sent as `Authorization: Bearer <ADMIN_API_KEY>`"}}},"paths":{"/changeRequests/{change-request-id}":{"get":{"summary":"Get Change Request","description":"Retrieves an open change request given an ID. GET endpoints like Get Change Request do not accept a JSON body—all inputs are provided using query parameters.","operationId":"get-change-request","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"split":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"trafficType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"killed":{"type":"boolean","default":true},"treatments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"configurations":{"type":"string"}}}},"defaultTreatment":{"type":"string"},"baselineTreatment":{"type":"string"},"trafficAllocation":{"type":"integer","default":0},"rules":{"type":"array","items":{"type":"object","properties":{"buckets":{"type":"array","items":{"type":"object","properties":{"treatment":{"type":"string"},"size":{"type":"integer","default":0}}}},"condition":{"type":"object","properties":{"combiner":{"type":"string"},"matchers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"string":{"type":"string"}}}}}}}}},"defaultRule":{"type":"array","items":{"type":"object","properties":{"treatment":{"type":"string"},"size":{"type":"integer","default":0}}}},"openChangeRequestId":{"type":"string"}}},"segment":{},"id":{"type":"string"},"status":{"type":"string"},"title":{"type":"string"},"comment":{},"approvers":{"type":"array","items":{"type":"object","properties":{}}},"operationType":{"type":"string"},"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string"},"user":{"type":"string"},"role":{"type":"string"},"timestamp":{"type":"integer","default":0}}}},"rolloutStatus":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"scheduledFor":{"type":"integer","description":"Unix epoch timestamp in milliseconds. Null when the change request is not scheduled."}}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"deprecated":false,"parameters":[{"in":"path","name":"change-request-id","schema":{"type":"string"},"required":true}],"tags":["Change Requests"]}}}}
```

## Update Change Request Status

> Update the status of an open change request given an ID.

```json
{"openapi":"3.1.0","info":{"title":"Harness FME Admin API","version":"2"},"tags":[{"name":"Change Requests"}],"servers":[{"url":"https://api.split.io/internal/api/v2"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Admin API Key, sent as `Authorization: Bearer <ADMIN_API_KEY>`"}}},"paths":{"/changeRequests/{change-request-id}":{"put":{"summary":"Update Change Request Status","description":"Update the status of an open change request given an ID.","operationId":"withdraw-change-request-1","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Admin API keys can only set REJECTED and APPROVED for change requests where the key being used was set as an approver. A key can only withdraw a change request that was submitted by itself.","default":"REJECTED | WITHDRAWN | APPROVED"},"comment":{"type":"string","description":"a comment to describe the choice to withdraw, approve or reject"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"split":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"trafficType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"killed":{"type":"boolean","default":true},"treatments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"configurations":{"type":"string"}}}},"defaultTreatment":{"type":"string"},"baselineTreatment":{"type":"string"},"trafficAllocation":{"type":"integer","default":0},"rules":{"type":"array","items":{"type":"object","properties":{"buckets":{"type":"array","items":{"type":"object","properties":{"treatment":{"type":"string"},"size":{"type":"integer","default":0}}}},"condition":{"type":"object","properties":{"combiner":{"type":"string"},"matchers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"string":{"type":"string"}}}}}}}}},"defaultRule":{"type":"array","items":{"type":"object","properties":{"treatment":{"type":"string"},"size":{"type":"integer","default":0}}}},"openChangeRequestId":{"type":"string"}}},"segment":{},"id":{"type":"string"},"status":{"type":"string"},"title":{"type":"string"},"comment":{},"approvers":{"type":"array","items":{"type":"object","properties":{}}},"operationType":{"type":"string"},"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string"},"user":{"type":"string"},"role":{"type":"string"},"timestamp":{"type":"integer","default":0}}}}}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"deprecated":false,"parameters":[{"in":"path","name":"change-request-id","schema":{"type":"string"},"required":true}],"tags":["Change Requests"]}}}}
```

## Submit Change Request

> Submit a change to a feature flag or segment for approval. No query parameters are required.

```json
{"openapi":"3.1.0","info":{"title":"Harness FME Admin API","version":"2"},"tags":[{"name":"Change Requests"}],"servers":[{"url":"https://api.split.io/internal/api/v2"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Admin API Key, sent as `Authorization: Bearer <ADMIN_API_KEY>`"}}},"paths":{"/changeRequests/ws/{workspace-id}/environments/{environment-id}":{"post":{"summary":"Submit Change Request","description":"Submit a change to a feature flag or segment for approval. No query parameters are required.","operationId":"create-change-request","parameters":[{"in":"path","name":"workspace-id","schema":{"type":"string"},"required":true,"description":"The ID of the project (previously called workspace) you would like to submit a change request in. After migration to Harness, get this value using the [Get Projects (Workspaces)](https://docs.split.io/reference/get-workspaces#/) endpoint and the Harness project name."},{"in":"path","name":"environment-id","schema":{"type":"string"},"required":true,"description":"The ID of the environment you would like to submit a change request in."}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"split":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"trafficType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"killed":{"type":"boolean","default":true},"treatments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"configurations":{"type":"string"}}}},"defaultTreatment":{"type":"string"},"baselineTreatment":{"type":"string"},"trafficAllocation":{"type":"integer","default":0},"rules":{"type":"array","items":{"type":"object","properties":{"buckets":{"type":"array","items":{"type":"object","properties":{"treatment":{"type":"string"},"size":{"type":"integer","default":0}}}},"condition":{"type":"object","properties":{"combiner":{"type":"string"},"matchers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"string":{"type":"string"}}}}}}}}},"defaultRule":{"type":"array","items":{"type":"object","properties":{"treatment":{"type":"string"},"size":{"type":"integer","default":0}}}},"openChangeRequestId":{"type":"string"}}},"segment":{},"id":{"type":"string"},"status":{"type":"string","default":"SCHEDULE_REQUESTED"},"title":{"type":"string"},"comment":{},"approvers":{"type":"array","items":{"type":"object","properties":{}}},"operationType":{"type":"string"},"comments":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string"},"user":{"type":"string"},"role":{"type":"string"},"timestamp":{"type":"integer","default":0}}}},"rolloutStatus":{"type":"object","properties":{"id":{"type":"string"}}},"scheduledFor":{"type":"integer"},"scheduledForTimezone":{"type":"string","default":"America/Los_Angeles"}}}}}},"400":{"description":"400","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"scheduledFor":{"type":"integer","description":"Optional. Unix timestamp in milliseconds marking the exact date and time the approved change request executes. This is an absolute point in time and does not change based on `scheduledForTimezone`."},"scheduledForTimezone":{"type":"string","description":"Optional. IANA time zone for `scheduledFor`, such as `America/Los_Angeles`, used only to display the scheduled time in the UI. It does not affect when the change request executes. Defaults to `UTC` if omitted. Invalid time zones are rejected."}}}}}},"tags":["Change Requests"]}}}}
```
