This tutorial demonstrates how to get issue details via RESTful API.
The steps include:
Get the issue ID from another api call
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 issue ID
To get the issue ID, you can follow the steps here: Get issued file-set for display
1.3. Get the issue details
This request can be found in the API Documentation under Issued Files marked 'Get issue details'.
Sample Request
curl --location 'http://localhost:8080/api/v1/issued-files/getIssueDetails/{issue-id-here}' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \Below is a sample response when checking if the issue has a transmittal file. Click 
in the line below to see the code.
Sample Response
{
"IssueID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"IssueSetID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"Details": {
"Issued by": "test",
"Issued on": "2025-04-14T02:13:39.183",
"Issue method": "Email (Server)"
},
"Files": [
{
"VersionSet": 1,
"file_name": "random file.txt",
"file_id": {
"_id": 170158,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "170158_1"
},
"version": 13,
"attributes": [
{
"auto_increment_start": 1,
"description": "",
"enum_items": null,
"input_mask": "",
"is_auto_increment": false,
"is_visible": true,
"optional": false,
"order": 0,
"read_only": false,
"reprompt_on_change": false,
"type": 3,
"value": {
"_value": "2025-04-11T01:19:40",
"enum_id": null,
"value_id": {
"_id": 180054,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "180054_1"
}
},
"visibility_constraint": null,
"workflow_id": null,
"attribute_id": {
"_id": 5,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "5_1"
},
"name": "Sent Date",
"display_name": "Sent Date",
"id": {
"_id": 5,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "5_1"
}
}
]
}
],
"Notes": "",
"To": [
{
"contact": {
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"is_user": true,
"companies": null,
"first_name": "test",
"last_name": "test",
"email": "test@test.com",
"active": true,
"create_date": "2024-12-10T01:48:00.25",
"attributes": [],
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"send_mode": 0,
"link": null,
"num_downloads": 0
}
],
"Cc": [],
"HasPublish": false,
"HasTransmittalFile": true,
"TransmittalFileName": null
}