This tutorial demonstrates how to search jobs via the RESTful API.
The steps include:
Searching for a job using the job name
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. Search for a job using the job name
Below is a sample for searching jobs with the name “test“.
Parameters
Name — Using this field, it matches any part of the string regardless of the position.
Page — Using this field, it specifies the page number of results to return when performing pagination.
PageSize — Using this field, it defines the number of results per page to be returned.
Attributes (optional) — If you analyze this field, it has a filter to restrict jobs to the top level. It is set to false in the Value field.
Sample Request
curl --location 'http://synergy.myserver.com/api/v1/jobs/api/v1/jobs/?name=test&page=1&page_size=20' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' Below is a sample response for a job with the name “user”. Click 
in the line below to see the code.
Sample Response
{
"PageNumber": 1,
"PageSize": 20,
"TotalRows": 1,
"TotalPages": 1,
"Result": [
{
"ID": {
"_id": 40009,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "40009_1"
},
"Name": "Test",
"Description": "",
"JobCreatorName": "",
"CreatedDate": "2025-06-23T13:00:30.42",
"NoOfChildren": 0,
"NoOfFolders": 3,
"NoOfTDJobs": 0,
"InheritPermissions": true,
"InheritFileNamingRules": false,
"AlwaysDisplayParent": false,
"DeleteLocked": false,
"Type": "Normal",
"CreatorID": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"ParentJobID": null,
"Attributes": [],
"JobItems": null,
"NoOfNotes": 0,
"Path": "Test",
"EntityObject": {
"parent_project_id": null,
"creator_name": "",
"num_children": 0,
"num_folders": 3,
"num_td_projects": 0,
"inherit_permissions": true,
"always_display_parent": false,
"rule_set": null,
"inherits_file_naming_rules": false,
"inherits_triggers_from_parent": false,
"delete_locked": false,
"cad_publish_output_path": null,
"customisation_info": null,
"form_attachments": null,
"id": {
"_id": 40009,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "40009_1"
},
"name": "Test",
"create_date": "2025-06-23T13:00:30.42",
"creator_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "1_1"
},
"attributes": [],
"description": "<HTML><HEAD>\r\n<META name=GENERATOR content=\"MSHTML 11.00.10570.1001\"></HEAD>\r\n<BODY></BODY></HTML>",
"type": 0
}
}
]
}