Get a change request | Unleash Documentation

import requests
url = "https://app.unleash-instance.example.com/api/admin/projects/projectId/change-requests/id"
headers = {"Authorization": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": 3,
  "title": "Increasing gradual rollout",
  "environment": "development",
  "minApprovals": 2,
  "project": "unleash-project",
  "features": [
    {
      "name": "my-feature",
      "conflict": "Feature has been archived",
      "changes": [
        {
          "id": 33,
          "action": "updateStrategy",
          "conflict": "Strategy has been deleted",
          "payload": {},
          "createdBy": {
            "username": "string",
            "imageUrl": "string"
          },
          "createdAt": "2023-07-31T13:22:03+02:00",
          "scheduleConflicts": {
            "changeRequests": [
              {
                "id": 1.1,
                "title": "string"
              }
            ]
          }
        }
      ],
      "defaultChange": {
        "action": "addStrategy",
        "payload": {
          "name": "flexibleRollout",
          "title": "",
          "disabled": false,
          "segments": [],
          "parameters": {
            "groupId": "my-feature",
            "rollout": "100",
            "stickiness": "default"
          },
          "constraints": [
            {
              "values": [
                "ux"
              ],
              "inverted": false,
              "operator": "STR_CONTAINS",
              "contextName": "userId",
              "caseInsensitive": false
            }
          ]
        }
      }
    }
  ],
  "segments": [
    {
      "id": 33,
      "action": "updateStrategy",
      "conflict": "Strategy has been deleted",
      "payload": {},
      "createdBy": {
        "username": "string",
        "imageUrl": "string"
      },
      "createdAt": "2023-07-31T13:22:03+02:00",
      "scheduleConflicts": {
        "changeRequests": [
          {
            "id": 1.1,
            "title": "string"
          }
        ]
      },
      "name": "beta-users"
    }
  ],
  "approvals": [
    {
      "createdBy": {
        "id": 33,
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "rejections": [
    {
      "createdBy": {
        "id": 33,
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "comments": [
    {
      "id": 33,
      "text": "This is a comment",
      "createdBy": {
        "username": "unleash-user",
        "imageUrl": "string"
      },
      "createdAt": "2022-12-12T12:13:24.218Z"
    }
  ],
  "createdBy": {
    "username": "Hunter",
    "imageUrl": "string"
  },
  "createdAt": "2023-07-31T13:33:02Z",
  "stateTimestamps": {
    "Draft": "2023-07-31T13:33:02Z",
    "In review": "2023-08-01T10:15:30Z",
    "Approved": "2023-08-02T09:01:00Z"
  },
  "state": "Draft"
}

Enterprise feature

This endpoint will retrieve one change request if it matches the provided id.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectIdstringRequired

idstringRequired

Response

changeRequestSchema

ChangeRequestSchema0object

ChangeRequestSchema1object

Authentication

Path parameters

Response

Errors