We recommend using Personal Access Tokens (PATs) for authentication.
PATs provide stronger security, easier token management, and better compatibility with modern systems.
Now that you have the PAT from this step: Create a Personal Access Token (PAT) for an App
You can easily access the API by adding it as a Bearer token in the Authorization header of your API request. This allows you to securely access the API without using a username or password.
Below is an example:
Sample Request
curl --location 'http://synergy.myserver.com/api/v1/jobs/?name=test&page=1&page_size=20' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' 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
}
}
]
}This request can also be seen here: Find job by name