This tutorial demonstrates how to search a task via RESTful API.
The steps include:
Getting the Job ID
Searching for a task using Job 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 Job ID
Refer to Search Jobs to get the required job ID.
After getting the Job ID, it can now be input into the API request.
1.3. Search for a Task
This request can be found in the API Documentation under Tasks marked 'Searches tasks'.
Sample Request
curl --location 'http://localhost:8080/api/v1/tasks/search' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \
--data '{
"JobId": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"IncludeClosedTasks": true
}'Below is a sample response for the tasks of a particular job with the ID of 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.com",
"active": true,
"create_date": "2024-12-10T01:48:00.25",
"attributes": [],
"image_modified_date_time": "2025-04-07T01:05:35.743"
},
"history": null,
"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": null,
"Reminders": null,
"CCs": null,
"Type": 18,
"change_message": null
}
]