This tutorial demonstrates how to get issue comments by ID via the RESTful API.
The commands are provided in curl and can be run from the command prompt when the 12d 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. Getting 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. Getting the Issue Comments
This request is in the API Documentation under Issue Tracking, marked ‘Get an Issue’.
Sample Request
POST curl --location 'http://localhost:8080/api/v1/issue-tracking/issue/get-comments?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
[
{
"Id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"IssueTicketID": {
"_id": 10007,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "10007_1"
},
"ContactID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"StatusID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"CreatedBy": {
"is_user": false,
"companies": null,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "1_1"
},
"first_name": "Drei",
"last_name": "Valencia",
"email": "test@test.com",
"active": true,
"create_date": "2024-09-16T23:42:30.1133333",
"attributes": null,
"image_modified_date_time": "2024-09-16T23:42:33.4866667"
},
"Status": {
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "1_1"
},
"Name": "Not Started",
"IssueTicketType": {
"_id": 1,
"_server_id": 1,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "1_1"
},
"WorkflowState": null,
"IsClosureState": false,
"ColorHex": "#FFA500",
"SortOrder": 1,
"Attributes": null
},
"CreatedOn": "2025-07-22T23:36:42.507",
"Comment": "test comment"
}
]