This tutorial demonstrates on how to get the task types via RESTful API.
The steps include:
Get the task type_id from the list of task types
Getting the task type by 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. Get the Task Type ID from the list of Task Types
To get the task type ID, you can follow the steps here: Get Task Types
2. Get a Specific Task Type
This request can be found in the API Documentation under Tasks marked 'Get a task type by type_id'.
Once you have the value for task_type_id, it should be included as query parameters.
It also should have a get_attributes parameter with true/false value.
Sample Request
curl --location 'http://localhost:8080/api/v1/tasks/getTaskType?task_type_id={task-type-id-here}&get_attributes=true' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \Below is a sample response when getting the task types. Click 
in the line below to see the code.
Sample Response
{
"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
}