This tutorial demonstrates how to get a task via RESTful API.
The steps include:
Getting a specific task with a task 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. Getting the Task ID
Getting the Task ID can be found by following the instructions here: Search Task or Get Task for a Job.
After getting the task ID, it can now be input into the API request.
1.3. Get a Specific Task
This request can be found in the API Documentation under Tasks marked 'Get a task item'.
This request requires the parameters:
task_id - value from Step 2
get_children - true/false value
get_history - true/false value
get_reminders - true/false value
get_cc - true/false value
Sample Request
curl --location 'http://localhost:8080/api/v1/tasks/getTask?task_id=3_1&get_children=true&get_history=true&get_reminders=true&get_cc=true' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \
Below is a sample response when getting a task_id with a value of 3_1. Click 
in the line below to see the code.
Sample Response
{
"due_date_mode": 0,
"start_date_mode": 0,
"id": {
"_id": 3,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "3_1"
},
"item_id": {
"_id": 3,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "3_1"
},
"project_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"parent_item_id": null,
"name": "Enquiry - Follow Up",
"description": "",
"progress": 0,
"AllProgress": 0,
"priority": 0,
"task_state": {
"is_closure": 0,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"name": "Not Started",
"sort_order": 1,
"attributes": [],
"completion_percentage": null
},
"task_state_name": "Not Started",
"is_closed": false,
"assigned_entity": null,
"assigned_by": null,
"item_owner": {
"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@test.com",
"active": true,
"create_date": "2024-12-10T01:48:00.25",
"attributes": [],
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"history": [
{
"contact_info": {
"is_user": true,
"companies": null,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"first_name": "test",
"last_name": "test",
"email": "test.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"
},
"change_description": "Item created",
"change_date": "2025-06-17T04:54:36.517"
}
],
"due_date_utc": null,
"relative_due_date_days": 0,
"start_date_utc": null,
"relative_start_date_days": 0,
"children": [],
"user_task_id": null,
"depends_on_ids": [],
"version": 1,
"attributes": [],
"task_type_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"task_type": {
"task_type_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"name": "Generic",
"colour": "#000000",
"description": "The generic task type",
"created_by_id": null,
"create_date_utc": "2024-12-10T01:48:00.287",
"dependent_task_action": null,
"start_task_action": null,
"workflow_id": null,
"id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"attributes": [],
"Type": 56
},
"task_path": "Test//Enquiry - Follow Up",
"project_path": "Test",
"dependent_task_action": null,
"start_task_action": null,
"order": 0,
"colour": "#000000",
"AssociatedEntities": null,
"workflow_capture_data": null,
"DueDays": "Not set",
"StartDays": "Not set",
"AssignedContacts": [],
"Dependencies": [],
"Reminders": [],
"CCs": [],
"Type": 18,
"change_message": null
}