This tutorial demonstrates how to create a task via RESTful API.
The steps include:
Get the job ID from searching jobs
Get the user permission using the 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. Get the job ID from the list of jobs
Refer to Search Jobs to get the required job ID.
1.3. Get the task type ID
To get the task type ID, you can follow the steps here: Get Task Types
1.4. Get the Task state ID
To get the task state ID, you can follow the steps here: Get Task states of task type
Once you gather the information above, you can create a task.
1.5. Create a Task
This request can be found in the API Documentation under Tasks marked 'Create or Update Task'.
Include the job ID, task state ID, task type ID in the request body as shown below.
Click in the line below to see the code.
Sample Request 1
curl --location 'http://localhost:8080/api/v1/tasks' \
--header 'Authorization: Bearer <your-token-here>' \
--header 'Content-Type: application/json' \
--data '{
"description": "Just a test",
"name": "Testing Task 1",
"project_id": {
"_id": 1,
"_server_id": 1,
"_server_guid": "7341E777-CD38-4BF7-9EA6-7FD912E6B11E",
"IDString": "1_1"
},
"task_state": {
"id": {
"IDString": "1_1",
"_id": 1,
"_server_guid": "7341E777-CD38-4BF7-9EA6-7FD912E6B11E",
"_server_id": 1
},
"name": "Not Started"
},
"task_type_id": {
"IDString": "1_1",
"_id": 1,
"_server_guid": "7341E777-CD38-4BF7-9EA6-7FD912E6B11E",
"_server_id": 1
}
}'
The request body above is the simplest way to create a task without any dependencies. If the task is going to be more specific, you will need to populate more fields. You can refer to the Create or Update Task and look at the example body, which is also shown below.
Click in the line below to see the code.
Sample Request 2
{
"due_date_mode": 0,
"start_date_mode": 0,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"item_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"project_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"parent_item_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"description": "string",
"progress": 0,
"AllProgress": 0,
"priority": 0,
"task_state": {
"is_closure": 0,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"sort_order": 0,
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"completion_percentage": 0
},
"task_state_name": "string",
"is_closed": true,
"assigned_entity": {
"Type": 0,
"ID": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"DisplayName": "string",
"AssignedEntity": {},
"EntityType": "string"
},
"assigned_by": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"item_owner": {
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"is_user": true,
"companies": {},
"first_name": "string",
"last_name": "string",
"email": "string",
"active": true,
"create_date": "2025-06-17T22:12:40.992Z",
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"image_modified_date_time": "2025-06-17T22:12:40.992Z"
},
"history": [
{
"contact_info": {
"is_user": true,
"companies": [
{
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"created_by": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"create_date": "2025-06-17T22:12:40.992Z",
"updated_date": "2025-06-17T22:12:40.992Z",
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"active": true
}
],
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string",
"active": true,
"create_date": "2025-06-17T22:12:40.992Z",
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"image_modified_date_time": "2025-06-17T22:12:40.993Z"
},
"change_description": "string",
"change_date": "2025-06-17T22:12:40.993Z"
}
],
"due_date_utc": "2025-06-17T22:12:40.993Z",
"relative_due_date_days": 0,
"start_date_utc": "2025-06-17T22:12:40.993Z",
"relative_start_date_days": 0,
"children": [
{}
],
"user_task_id": "string",
"depends_on_ids": [
{
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
],
"version": 0,
"attributes": [
{
"type": 0,
"optional": true,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"value": {},
"description": "string",
"read_only": true,
"input_mask": "string",
"is_auto_increment": true,
"auto_increment_start": 0,
"order": 0,
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"is_visible": true,
"reprompt_on_change": true,
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string"
}
],
"task_type_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"task_type": {
"task_type_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"colour": "string",
"description": "string",
"created_by_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"create_date_utc": "2025-06-17T22:12:40.993Z",
"dependent_task_action": {
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"action_mode": 0,
"action_data_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"start_task_action": {
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"action_mode": 0,
"action_data_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"Type": 0
},
"task_path": "string",
"project_path": "string",
"dependent_task_action": {
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"action_mode": 0,
"action_data_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"start_task_action": {
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"action_mode": 0,
"action_data_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"order": 0,
"colour": "string",
"AssociatedEntities": [
{
"associated_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"associated_type": 0,
"assoc_entity": {},
"path": "string",
"description": "string",
"association_date_utc": "2025-06-17T22:12:40.993Z",
"created_by": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"has_access": true
}
],
"FormDefinitions": [
{
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"Name": "string",
"Description": "string",
"CreatedBy": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"CreatedOn": "2025-06-17T22:12:40.993Z",
"FormJson": "string",
"SourceEntity": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"SourceEntityType": 0,
"IsAvailableAll": true,
"IsHidden": true,
"CreatedByUser": {
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"contact_info": {
"is_user": true,
"companies": [
{
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"created_by": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"create_date": "2025-06-17T22:12:40.993Z",
"updated_date": "2025-06-17T22:12:40.993Z",
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"active": true
}
],
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string",
"active": true,
"create_date": "2025-06-17T22:12:40.993Z",
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"image_modified_date_time": "2025-06-17T22:12:40.993Z"
},
"is_contact_company_creator": true,
"is_custom_login": true,
"is_job_creator": true,
"is_locked": true,
"is_sys_admin": true,
"multi_factor_auth_mode": 0,
"personal_project_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"sso_config": {
"cosmetic_name": "string",
"creation_date": "2025-06-17T22:12:40.993Z",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"email_digest_mode": true,
"last_checkout_reminder_date": "2025-06-17T22:12:40.993Z",
"last_initial_reminder_date": "2025-06-17T22:12:40.993Z",
"windows_identity": "string",
"timezone": "string",
"LoginType": 0
},
"LatestFormHistoryID": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"CanAllUsersAccess": true,
"CanAllCollaboratorsAccess": true,
"FormDefinitionAttachments": [
{
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"FormDefinitionID": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"EntityID": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"EntityType": 0,
"FormDefinition": {}
}
],
"AttachmentMode": 0,
"SourceFormDefinition": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"workflow_capture_data": [
{}
],
"DueDays": {},
"StartDays": {},
"AssignedContacts": [
{
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"is_user": true,
"companies": {},
"first_name": "string",
"last_name": "string",
"email": "string",
"active": true,
"create_date": "2025-06-17T22:12:40.993Z",
"attributes": [
{
"auto_increment_start": 0,
"enum_items": [
{
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value": "string",
"display_name": "string",
"hidden": true,
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"input_mask": "string",
"is_auto_increment": true,
"is_visible": true,
"optional": true,
"order": 0,
"read_only": true,
"reprompt_on_change": true,
"value": {
"_value": {},
"enum_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"value_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
},
"visibility_constraint": {
"constraint": "string",
"id": 0,
"name": "string"
},
"workflow_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"description": "string",
"type": 0,
"attribute_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"name": "string",
"display_name": "string",
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
}
}
],
"image_modified_date_time": "2025-06-17T22:12:40.993Z"
}
],
"Dependencies": [
{
"ID": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"Name": "string"
}
],
"Reminders": [
{
"id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"task_id": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"reminder_type": 0,
"remind_delta_days": 0,
"remind_who": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"remind_who_type": 0,
"is_deleted": true,
"is_recurring": true,
"times_sent": 0,
"last_sent_timestamp": "2025-06-17T22:12:40.993Z",
"remind_even_after_started": true,
"remind_even_after_finished": true,
"description": "string"
}
],
"CCs": [
{
"ID": {
"_id": 0,
"_server_id": 0,
"_server_guid": "00000000-0000-0000-0000-000000000000",
"IDString": "string"
},
"Name": "string",
"Type": 0
}
],
"Type": 0,
"change_message": "string"
}
Below is a sample response after a successful creation of a task.
Sample Response
{
"_id": 10017,
"_server_id": 1,
"_server_guid": "b993c729-bf98-490c-989d-5621e3b48139",
"IDString": "10017_1"
}