Skip to main content
GET
/
api
/
projects
/
{projectId}
/
change-requests
List change requests
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/change-requests \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "publish_document",
      "status": "pending",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "description": "<string>",
      "document": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "key": "<string>"
      },
      "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "release": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "version": "<string>"
      },
      "releaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "branch": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "commit": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "message": "<string>"
      },
      "createdBy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "firstName": "<string>",
        "lastName": "<string>"
      }
    }
  ],
  "paginate": {
    "current": 123,
    "from": 123,
    "to": 123,
    "total": 123,
    "pageSize": 123
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

Project unique identifier

Query Parameters

page
number
default:1

Current page

perPage
number
default:10

Number of items per page

documentId
string<uuid> | null

Filter by document ID

releaseId
string<uuid> | null

Filter by release ID

type

Filter by change request type(s)

Available options:
decisions,
deployments,
publish_document,
unpublish_document,
deploy_environment,
undeploy_environment
status
enum<string> | null

Filter by status (pending or closed)

Available options:
pending,
closed,

Response

200 - application/json

Paginated list of change requests

Paginated list of change requests

results
object[]
required

List of change requests

paginate
object
required

Pagination metadata