This tutorial demonstrates how to get issue changes via the RESTful API.
The steps include:
Get the issue changes by ID
The commands are provided in curl and can be run from the command prompt when the Synergy Server is running (or in a batch script).
Additional API documentation
To get a list of most of the API requests available, with the 12d Synergy server running, browse http://synergy.myserver.com/api-docs/ui/index.
(Replace synergy.myserver.com with the external server address and update the port numbers if necessary.)
1.1. Getting the Personal Access Token to access API
The tutorial for getting the PAT is here: Generate PAT in Web client.
1.2. Get the list of issues
Get the list of issues here: Get Issue Tracking
You can then select which issue ID you want to use on the request below.
1.3. Get the issue comments
This request can be found in the API Documentation under ‘Gets the issue changes in a structured format for the issue’.
Sample Request
POST curl --location 'http://localhost:8080/api/v1/issue-tracking/issue/get-changes?issue_id=10007_1' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \
Below is a sample response when getting an issue by ID. Click in the line below to see the code.
Sample Response
[
{
"ChangedValues": [],
"NewAttributes": [],
"IssueTicketChange": {
"Id": {
"_id": 2,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "2_1"
},
"IssueTicketID": {
"_id": 10007,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "10007_1"
},
"Version": 1,
"ChangeTime": "2025-06-23T13:08:58.8",
"ContactID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"CreatedByInfo": {
"is_user": true,
"companies": null,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"first_name": "Drei",
"last_name": "Valencia",
"email": "test@test.com",
"active": true,
"create_date": "2024-09-16T23:42:30.113",
"attributes": null,
"image_modified_date_time": "2024-09-16T23:42:33.487"
},
"Description": "Issue created"
}
}
]