List changes
GET
/api/projects/{projectId}/changesSigned-in memberRead-only
Open /changes to browse a Project's inbox, or call GET /api/projects/{projectId}/changes. Both accept category (a category code such as feature or security, in any case), status (needs-review, classified for changes settled by rules without a person, reviewed), and context=insufficient (see Review signals). A value that is not a code or status returns 400 invalid_change_filter, and another Organization's Project returns 404 project_not_found. Each change returns its category code with its categoryName and categoryGroup, as recorded when it was classified.
Path parameters
| Name | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Required |
Query parameters
| Name | Type | Required | Notes |
|---|---|---|---|
category | string | Optional | |
status | string | Optional | |
context | string | Optional | |
release | string | Optional |
Response
Success: 200
An array of ChangeView, each with:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Optional | |
pullRequestNumber | integer | Optional | |
title | string | Optional | |
description | string | Optional | |
authorLogin | string | Optional | |
labels | array of string | Optional | |
targetBranch | string | Optional | |
mergeCommitSha | string | Optional | |
mergedAt | string (date-time) | Optional | |
url | string | Optional | |
category | string | Optional | |
categoryName | string | Optional | |
categoryGroup | enum CategoryGroup | Optional | FEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER |
breaking | boolean | Optional | |
security | boolean | Optional | |
needsReview | boolean | Optional | |
reasons | array of string | Optional | |
classificationSource | enum ClassificationSource | Optional | RULESAISUGGESTIONHUMAN |
aiStatus | enum AiStatus | Optional | NOT_REQUESTEDSUCCEEDEDFAILED |
aiModel | string | Optional | |
aiFailure | string | Optional | |
aiEligible | boolean | Optional | |
reviewedBy | string (uuid) | Optional | |
reviewerName | string | Optional | |
reviewedAt | string (date-time) | Optional | |
processingStatus | enum ProcessingStatus | Optional | PROCESSINGCOMPLETED |
changedFileStatus | enum ChangedFileStatus | Optional | COLLECTEDUNAVAILABLENOT_SUPPORTED |
linkedContextStatus | enum LinkedContextStatus | Optional | NOT_SUPPORTEDNOT_CONFIGUREDNOT_FOUNDPARTIALUNAVAILABLECOLLECTED |
linkedIssues | array of LinkedIssue | Optional | |
linkedIssues[].key | string | Optional | |
linkedIssues[].title | string | Optional | |
linkedIssues[].description | string | Optional | |
linkedIssues[].type | string | Optional | |
linkedIssues[].status | string | Optional | |
linkedIssues[].url | string | Optional | |
linkedIssues[].tracker | string | Optional | |
linkedIssues[].statusCategory | string | Optional | |
changedFiles | array of ChangedFile | Optional | |
changedFiles[].path | string | Optional | |
changedFiles[].previousPath | string | Optional | |
changedFiles[].kind | enum ChangedFileKind | Optional | ADDEDMODIFIEDREMOVEDRENAMEDOTHER |
reviewTriggers | array of ReviewTrigger | Optional | |
reviewTriggers[].type | enum ReviewTriggerType | Optional | SENSITIVE_PATHCHANGED_FILES_UNAVAILABLESENSITIVE_KEYWORDCLASSIFIER_FALLBACKCATEGORY_SUGGESTION_PENDINGCONTEXT_INSUFFICIENTLINKED_CONTEXT_UNAVAILABLEDUPLICATE_CANDIDATEMIGRATION_KIND_MISMATCH |
reviewTriggers[].detail | string | Optional | |
neutralSummary | NeutralSummary | Optional | |
neutralSummary.whatChanged | string | Optional | |
neutralSummary.whyChanged | string | Optional | |
neutralSummary.technicalDetail | string | Optional | |
neutralSummary.migrationStep | string | Optional | |
neutralSummary.migrationKind | enum MigrationKind | Optional | NONEREQUIREDCONDITIONALRECOMMENDEDUNSPECIFIED |
neutralSummary.limitations | string | Optional | |
contentLanguage | string | Optional | |
aiProvider | enum AiProvider | Optional | OPENAIANTHROPICDEEPSEEK |
audienceNarrativeDetails | map of AudienceNarrative | Optional | |
summaryEditorName | string | Optional | |
summaryEditedAt | string (date-time) | Optional | |
context | ContextAssessment | Optional | |
context.score | integer | Optional | |
context.status | enum ContextStatus | Optional | SUFFICIENTINSUFFICIENT |
context.reasons | array of string | Optional | |
sourceId | string (uuid) | Optional | |
origin | enum ChangeOrigin | Optional | WEBHOOKIMPORT |
sourceType | enum SourceType | Optional | GITHUBGITLABLINEARJIRA |
exclusion | ChangeExclusion | Optional | |
exclusion.excludedBy | string (uuid) | Optional | |
exclusion.excluderName | string | Optional | |
exclusion.excludedAt | string (date-time) | Optional | |
exclusion.reason | string | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | validation_faileda field is missing or out of range | Any endpoint |
400 | invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUID | Any endpoint |
401 | authentication_requiredno session | Any endpoint |
404 | not_foundno such address | Any endpoint |
405 | method_not_allowedthe address does not take that method | Any endpoint |
415 | unsupported_media_typethe address does not read a body of that type | Any endpoint |
500 | internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind it | Any endpoint |
400 | invalid_change_filter | Changes area |
400 | invalid_change_review | Changes area |
400 | invalid_sensitive_paths | Changes area |
404 | change_not_found | Changes area |
404 | duplicate_candidate_not_found | Changes area |
409 | change_processing | Changes area |
409 | change_not_eligible_for_ai | Changes area |
409 | duplicate_candidate_decided | Changes area |
409 | change_excluded | Changes area |
409 | change_in_release | Changes area |
502 | ai_classification_failed | Changes area |
503 | ai_classification_unavailable | Changes area |
404 | category_not_found | Categories area |
404 | category_suggestion_not_found | Categories area |
409 | category_code_taken | Categories area |
409 | category_system | Categories area |
409 | category_suggestion_decided | Categories area |
Request
bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
curl "http://localhost:8080/api/projects/$PROJECT_ID/changes" \
-b cookies.txt -c cookies.txt
Response
200Example
[
{
"id": "<uuid>",
"pullRequestNumber": 0,
"title": "<string>",
"description": "<string>",
"authorLogin": "<string>",
"labels": [
"<string>"
],
"targetBranch": "<string>",
"mergeCommitSha": "<string>",
"mergedAt": "<date-time>",
"url": "<string>",
"category": "<string>",
"categoryName": "<string>",
"categoryGroup": "FEATURE",
"breaking": false,
"security": false,
"needsReview": false,
"reasons": [
"<string>"
],
"classificationSource": "RULES",
"aiStatus": "NOT_REQUESTED",
"aiModel": "<string>",
"aiFailure": "<string>",
"aiEligible": false,
"reviewedBy": "<uuid>",
"reviewerName": "<string>",
"reviewedAt": "<date-time>",
"processingStatus": "PROCESSING",
"changedFileStatus": "COLLECTED",
"linkedContextStatus": "NOT_SUPPORTED",
"linkedIssues": [
{
"key": "<string>",
"title": "<string>",
"description": "<string>",
"type": "<string>",
"status": "<string>",
"url": "<string>",
"tracker": "<string>",
"statusCategory": "<string>"
}
],
"changedFiles": [
{
"path": "<string>",
"previousPath": "<string>",
"kind": "ADDED"
}
],
"reviewTriggers": [
{
"type": "SENSITIVE_PATH",
"detail": "<string>"
}
],
"neutralSummary": {
"whatChanged": "<string>",
"whyChanged": "<string>",
"technicalDetail": "<string>",
"migrationStep": "<string>",
"migrationKind": "NONE",
"limitations": "<string>"
},
"contentLanguage": "<string>",
"aiProvider": "OPENAI",
"audienceNarrativeDetails": {
"<key>": {
"relevance": "NONE",
"headline": "<string>",
"body": "<string>"
}
},
"summaryEditorName": "<string>",
"summaryEditedAt": "<date-time>",
"context": {
"score": 0,
"status": "SUFFICIENT",
"reasons": [
"<string>"
]
},
"sourceId": "<uuid>",
"origin": "WEBHOOK",
"sourceType": "GITHUB",
"exclusion": {
"excludedBy": "<uuid>",
"excluderName": "<string>",
"excludedAt": "<date-time>",
"reason": "<string>"
}
}
]