This tutorial demonstrates how to get an issued file-set via RESTful API.
The steps include:
Get the set 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
2. Get the job ID from the list of jobs
To get the set ID, you can follow the steps here: Get issued file-set types by job and type
4. Get the issued file-sets
This request can be found in the API Documentation under Issued Files marked 'Get issued file-set for display'.
Once you have the value for set_id, it should be included in the URL.
There is also a get_issues parameter with true/false value required.
Sample Request
curl --location 'http://localhost:8080/api/v1/issued-files/getIssuedFileSetForDisplay/{set-id-here}?get_issues=true' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \Below is a sample response when getting the file-set types by job ID and type ID. Click 
in the line below to see the code.
Sample Response
{
"add_all_referenced_files": false,
"versions": [
{
"added_dates": {
"170158 [Server: 1] ": "2025-04-14T02:11:23.1"
},
"files": [
{
"file_name": "random file.txt",
"version": 13,
"last_user_name": null,
"last_user_id": null,
"last_change_time": "0001-01-01T00:00:00",
"last_change_type": 2,
"file_id": {
"_id": 170158,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "170158_1"
},
"folder_id": {
"_id": 60008,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "60008_1"
},
"active_check_out": null,
"active_folder_check_out": null,
"change_attribs": null,
"file_size": 0,
"has_file_access": false,
"file_access": 0,
"flattened_parent_attributes": null,
"path": "Synergy/Folder 1/random file.txt",
"has_references": false,
"has_folder_references": false,
"latest_version": 0,
"file_type": 0,
"link_source_id": null,
"link_path": "",
"preview_state": 0,
"is_link_source": false,
"file_modified_utc": "2024-10-15T04:36:56.023",
"file_created_utc": "0001-01-01T00:00:00",
"display_name": "",
"workflows": null,
"file_lock": null,
"is_referenced": false,
"file_store": null,
"has_layouts": false,
"extension_data": null,
"Microsoft365Session": null,
"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"
}
}
]
}
],
"issues": [
{
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"issued_by": {
"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": null,
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"attributes": [],
"issue_date": "2025-04-14T02:13:39.183",
"issued_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
}
],
"issue_set_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"issue_action": 1,
"additional_note": "",
"set_version": 1,
"transmittal_file_name": null
},
{
"id": {
"_id": 2,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "2_1"
},
"issued_by": {
"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": null,
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"attributes": [],
"issue_date": "2025-04-14T02:22:43.63",
"issued_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
}
],
"issue_set_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"issue_action": 1,
"additional_note": "",
"set_version": 1,
"transmittal_file_name": null
},
{
"id": {
"_id": 3,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "3_1"
},
"issued_by": {
"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": null,
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"attributes": [],
"issue_date": "2025-04-14T02:24:08.497",
"issued_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
}
],
"issue_set_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"issue_action": 0,
"additional_note": "",
"set_version": 1,
"transmittal_file_name": null
},
{
"id": {
"_id": 4,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "4_1"
},
"issued_by": {
"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": null,
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"attributes": [],
"issue_date": "2025-04-14T02:24:51.063",
"issued_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
}
],
"issue_set_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"issue_action": 0,
"additional_note": "",
"set_version": 1,
"transmittal_file_name": null
}
],
"version": 1
}
],
"project_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"name": "Set 1",
"description": "<HTML><HEAD>\r\n<META name=GENERATOR content=\"MSHTML 11.00.10570.1001\"></HEAD>\r\n<BODY>issue set 1</BODY></HTML>",
"created_by": {
"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": null,
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"created_date_utc": "2025-04-14T02:11:23.087",
"structure_root": null,
"has_issues": true,
"type_id": {
"_id": 4,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "4_1"
},
"set_version": 1,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"Type": 36
}