Connectors Reference
Keep all your team's tasks in one place. Collaborate and work in real time for real results. Teamwork Projects is a powerful and simple way to collaborate with your team.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Delete webhook |
|
|
List projects |
|
|
Create project |
|
|
Get project |
|
|
List tasks |
|
|
CreateTask (string projectId, string taskListId, CreateTask_Request body) |
Create task |
|
Get task |
|
|
Update task |
|
|
Delete task |
|
|
List users |
|
|
Create user |
|
|
Get user |
|
|
Get task lists |
|
|
List companies |
|
|
List project categories |
|
|
|
|
Name |
Summary |
|
When a project is created |
|
|
When a task is created |
|
|
When a user is created |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Delete webhook
Description: Delete a webhook.
Syntax:
TeamworkProjects.DeleteHook (string hookId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
hookId |
string
|
|
True |
Returns:
Summary: List projects
Description: This operation returns a list of all projects associated with your account.
Syntax:
TeamworkProjects.ListProjects ()
Returns:
Summary: Create project
Description: This operation is used to create a new Teamwork project.
Syntax:
TeamworkProjects.CreateProject (CreateProject_Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Get project
Description: This operation returns all properties asosciated with a specific project, given its id.
Syntax:
TeamworkProjects.GetProject (string projectId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
string (Project Id) |
Unique id of the project. |
True |
Returns:
Type:GetProject_Response
Summary: List tasks
Description: This operation is used to return a list of tasks for a given project.
Syntax:
TeamworkProjects.ListTasks (string projectId, string taskListId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
string (Project Id) |
Pick a project. |
True |
|
|
taskListId |
string (Task list Id) |
Pick a task list. |
True |
Returns:
Type:ListTasks_Response
Summary: Create task
Description: This operation is used to create a new task.
Syntax:
TeamworkProjects.CreateTask (string projectId, string taskListId, CreateTask_Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
string (Project Id) |
Pick a project. |
True |
|
|
taskListId |
string (Task list Id) |
Pick a task list. |
True |
|
|
body |
|
|
True |
Returns:
Type:UpsertTask_Response
Summary: Get task
Description: This operation returns all properties asosciated with a specific task, given its id.
Syntax:
TeamworkProjects.GetTask (string taskId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
taskId |
string (Task Id) |
Unique id of the task. |
True |
Returns:
Type:GetTask_Response
Description: Details associated with a specific task.
Summary: Update task
Description: This operation is used to update the properties of a specific task.
Syntax:
TeamworkProjects.UpdateTask (string taskId, UpdateTask_Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
taskId |
string (Task Id) |
Unique id of the task. |
True |
|
|
body |
|
|
True |
Returns:
Type:UpsertTask_Response
Summary: Delete task
Description: This operation is used to delete a task.
Syntax:
TeamworkProjects.DeleteTask (string taskId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
taskId |
string (Task Id) |
Unique id of the task. |
True |
Returns:
Type:DeleteTask_Response
Summary: List users
Description: This operation returns a list of all users asosciated with a specific project.
Syntax:
TeamworkProjects.ListUsers (string projectId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
string (Project Id) |
Pick a project. |
True |
Returns:
Type:ListUsers_Response
Summary: Create user
Description: This operation is used to create a new user.
Syntax:
TeamworkProjects.CreateUser (CreateUser_Request body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:CreateUser_Response
Summary: Get user
Description: This operation is used to get all details of a user.
Syntax:
TeamworkProjects.GetUser (string personId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
personId |
string (Person Id) |
Unique id of the person. |
True |
Returns:
Type:GetUser_Response
Summary: Get task lists
Description: This operation returns a list of all task lists.
Syntax:
TeamworkProjects.ListTaskLists (string projectId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
projectId |
string (Project Id) |
Pick a project. |
True |
Returns:
Summary: List companies
Description: List companies
Syntax:
TeamworkProjects.ListCompanies ()
Returns:
Summary: List project categories
Description: List project categories
Syntax:
TeamworkProjects.ListProjectCategories ()
Returns:
Type:ListProjectCategories_Response
Summary:
Description:
Syntax:
TeamworkProjects.WebhookResponse ()
Returns:
Summary: When a project is created
Description: This operation triggers when a new project is created.
Syntax:
TeamworkProjects.WebhookCreateProject (WebhookCreateProjectRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:string
Summary: When a task is created
Description: This operation triggers when a new task is created.
Syntax:
TeamworkProjects.WebhookCreateTask (WebhookCreateTaskRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:string
Summary: When a user is created
Description: This operation triggers when a new user is created.
Syntax:
TeamworkProjects.WebhookCreateUser (WebhookCreateUserRequest body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:string
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
project |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Name |
Project name. |
|
description |
string Description |
More details about the project. |
|
category-id |
string Category Id |
Pick a category |
|
companyId |
string Company Id |
Pick an existing company. |
|
newCompany |
string New Company |
Enter the name of a new external company. |
|
startDate |
string Start Date |
yyyy-MM-dd |
|
endDate |
string End Date |
yyyy-MM-dd |
|
tags |
string Tags |
A comma separated list of tags for the project. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Project Id |
Unique id of the project. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
todo-item |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
content |
string Name |
Task title. |
|
description |
string Description |
Details of the task. |
|
progress |
string Progress |
Set the progress from 0 to 90. |
|
responsible-party-id |
string Assign To |
Pick a user. |
|
start-date |
string Start Date |
yyyy-MM-dd |
|
due-date |
string Due Date |
yyyy-MM-dd |
|
estimated-minutes |
string Estimated minutes |
For a task to complete. |
|
priority |
string Priority |
Pick a priority. Values: [not set, low, medium, high] |
|
notify |
boolean Notify People |
True to notify people assigned to this task by email. |
|
private |
boolean Is Private |
True to make task private. |
|
tags |
string Tags |
A comma separated list of tags for the task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
person |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
email-address |
string Email Address |
User's email. |
|
first-name |
string First Name |
User's first name. |
|
last-name |
string Last Name |
User's last name. |
|
company-id |
string Company Id |
User's company. |
|
title |
string Job Title |
User's title. |
|
phone-number-home |
string Home |
User's home phone. |
|
phone-number-mobile |
string Mobile |
User's mobile phone. |
|
phone-number-office |
string Office |
User's office phone. |
|
phone-number-office-ext |
string Office Extension |
User's office phone extension. |
|
phone-number-fax |
string Fax |
User's fax number. |
|
user-name |
string Username |
Display name of the user. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string User Id |
Unique identifier of the user. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
affectedTaskIds |
string Task Id |
Unique id of the task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
project |
|
|
Summary:
Description: Details associated with a specific task.
Properties:
|
Name |
Type |
Summary |
|
todo-item |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
person |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
companies |
array of (CompaniesItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
accounts |
string accounts |
accounts |
|
address_one |
string address_one |
address_one |
|
address_two |
string address_two |
address_two |
|
can_see_private |
boolean can_see_private |
can_see_private |
|
cid |
string cid |
cid |
|
city |
string city |
city |
|
company_name_url |
string company_name_url |
company_name_url |
|
contacts |
string contacts |
contacts |
|
country |
string country |
country |
|
countrycode |
string countrycode |
countrycode |
|
email_one |
string email_one |
email_one |
|
email_three |
string email_three |
email_three |
|
email_two |
string email_two |
email_two |
|
fax |
string fax |
fax |
|
id |
string id |
id |
|
industry |
string industry |
industry |
|
industryId |
string industryId |
industryId |
|
isowner |
string isowner |
isowner |
|
last-changed-on |
string last-changed-on |
last-changed-on |
|
logo-URL |
string logo-URL |
logo-URL |
|
name |
string name |
name |
|
phone |
string phone |
phone |
|
state |
string state |
state |
|
website |
string website |
website |
|
zip |
string zip |
zip |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
categories |
array of (CategoriesItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
color |
string color |
color |
|
count |
string count |
count |
|
elements-count |
string elements-count |
elements-count |
|
id |
string id |
id |
|
name |
string name |
name |
|
parent-id |
string parent-id |
parent-id |
|
type |
string type |
type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
projects |
array of (Project_Response) Projects List |
Array of all projects asosciated with your account. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
tasklists |
array of (TasklistsItem)
|
Array of task lists. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
complete |
boolean Complete |
True if the task is complete. |
|
description |
string Description |
Details about the task. |
|
DLM |
string DLM |
Date last modified. |
|
id |
string Tasklist Id |
Unique id of the tasklist. |
|
milestone-id |
string Milestone Id |
Unique id of the milestone. |
|
name |
string Tasklist Name |
Name of the tasklist. |
|
pinned |
boolean Pinned |
True if the task is pinned. |
|
projectId |
string Project Id |
Unique id of the project. |
|
projectName |
string Project Name |
Name of the project. |
|
status |
string Status |
New, reopened, completed or deleted. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
todo-items |
array of (Task_Response)
|
List of tasks along with their properties. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
people |
array of (User_Response) Users |
List of users. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
category |
Category |
|
|
company |
Company |
|
|
created-on |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
description |
string Description |
More details about the project. |
|
endDate |
string End Date-Time |
yyyy-MM-dd |
|
harvest-timers-enabled |
boolean Timer Enabled |
True if Harvest timer is enabled. |
|
id |
string Project Id |
Unique id of the project. |
|
last-changed-on |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
logo |
string Logo |
Project logo. |
|
name |
string Name |
Project name. |
|
overview-start-page |
string Overview Page |
Url of the overview-start-page. |
|
privacyEnabled |
boolean Privacy Enabled |
True if privacy is enabled. |
|
starred |
boolean Starred |
True if project is starred. |
|
startDate |
string Start Date-Time |
yyyy-MM-dd |
|
start-page |
string Start Page |
Url of the start-page. |
|
status |
string Status |
Status of the project. |
|
subStatus |
string Substatus |
Substatus of the project. |
|
tasks-start-page |
string Tasks Start Page |
Url of the tasks-start-page. |
|
type |
string Type |
Type of project. |
Summary: Category
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Unique id of the project category. |
|
name |
string Name |
Name of the project category. |
Summary: Company
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Unique id of the company. |
|
name |
string Name |
Name of the company. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
canComplete |
boolean Can Complete |
True if the task can be completed. |
|
canEdit |
boolean Can Edit |
True if the task can be edited. |
|
canLogTime |
boolean Can Log Time |
True if time can be logged to the task. |
|
company-id |
integer(int32) Company Id |
Unique id of the company. |
|
company-name |
string Company Name |
Name of the company. |
|
completed |
boolean Is completed |
True is the task is completed. |
|
content |
string Name |
Title of the task. |
|
created-on |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
creator-avatar-url |
string Creator Avatar URL |
Avatar URL of the task creator. |
|
creator-firstname |
string Creator First Name |
First name of the task creator. |
|
creator-id |
integer(int32) Creator Id |
Unique id of the creator. |
|
creator-lastname |
string Creator Last Name |
Last name of the task creator. |
|
description |
string Description |
Task description. |
|
due-date |
string Due Date |
yyyy-MM-dd |
|
estimated-minutes |
integer(int32) Estimated Minutes |
Time estimate for the task. |
|
harvest-enabled |
boolean Harvest Enabled. |
True if harvest is enabled. |
|
has-dependencies |
integer(int32) Dependency Count |
Number of dependencies the task has. |
|
has-predecessors |
integer(int32) Has Predecessors |
Number of predecessors the task has. |
|
has-reminders |
boolean Has Reminders |
True if reminders exist. |
|
hasTickets |
boolean Has Tickets |
True if tickets exist. |
|
has-unread-comments |
boolean has-unread-comments |
True if unread comments exist. |
|
id |
integer(int32) Task Id |
Unique id of the task. |
|
last-changed-on |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
lockdownId |
string Lock Down Id |
Unique Id of lock down. |
|
parentTaskId |
string Parent Task Id |
Unique Id of the parent task. |
|
priority |
string Priority |
Priority of the task. |
|
private |
integer(int32) Private |
1 if the task is private. |
|
progress |
integer(int32) Progress |
Integer between 0 and 90. |
|
project-id |
integer(int32) Project Id |
Unique Id of the project. |
|
project-name |
string Project Name |
Name of the project. |
|
start-date |
string Start Date |
yyyy-MM-dd |
|
status |
string Status |
Deleted, completed, reopened or new. |
|
todo-list-id |
integer(int32) Todo List Id |
Unique Id of the todo list. |
|
todo-list-name |
string Todo List Name |
Name of the todo list. |
|
userFollowingChanges |
boolean Following Changes |
True if user is following changes. |
|
userFollowingComments |
boolean Following Comments |
True if user is following comments. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
todo-item |
|
Details of the specific task. |
Summary:
Description: Details of the specific task.
Properties:
|
Name |
Type |
Summary |
|
content |
string Name |
Task name. |
|
description |
string Description |
Task description. |
|
progress |
string Progress |
Integer from 0 to 90. |
|
responsible-party-id |
string Assign to |
Pick a person. |
|
start-date |
string Start Date |
yyyy-MM-dd |
|
due-date |
string Due Date |
yyyy-MM-dd |
|
estimated-minutes |
string Estimated time |
Minutes to complete the task. |
|
priority |
string Priority |
Pick a priority. Values: [not set, low, medium, high] |
|
notify |
boolean Notify People |
True to notify people assigned to this task by email. |
|
private |
boolean Is Private |
True to make task private. |
|
tags |
string Tags |
A comma separated list of tags for the task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Task Id |
Unique id of the task. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
avatar-url |
string Avatar URL |
User's avatar url. |
|
company-id |
string Company Id |
Unique Id of the company. |
|
company-name |
string Company Name |
Name of the company. |
|
email-address |
string Email Address |
User's email. |
|
email-alt-1 |
string Email Alternate 1 |
User's alternate email. |
|
first-name |
string First Name |
User's first name. |
|
id |
string User Id |
Unique id of the user. |
|
last-name |
string Last Name |
User's last name, |
|
notes |
string Notes |
Notes about the user. |
|
openId |
string Open Id |
User's open id. |
|
phone-number-fax |
string Fax Number |
User's fax number. |
|
phone-number-home |
string Home |
User's home phone. |
|
phone-number-mobile |
string Mobile |
User's mobile number. |
|
phone-number-mobile-parts |
Mobile |
|
|
phone-number-office |
string Office |
User's office phone number. |
|
phone-number-office-ext |
string Office Extension |
User's office phone number. |
|
pid |
string Pid |
User's pid. |
|
title |
string Title |
User's title. |
|
|
string |
User's twitter handle. |
|
user-name |
string Username |
Display name of the user. |
|
user-type |
string Type |
User type. |
|
userUUID |
string UUID |
User's UUID. |
Summary: Mobile
Description:
Properties:
|
Name |
Type |
Summary |
|
countryCode |
string Country Code |
User's mobile number. |
|
phone |
string Phone |
User's mobile number. |
|
prefix |
string Prefix |
User's mobile number. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
STATUS |
string STATUS |
STATUS |
|
webhook |
|
webhook |
Summary:
Description: webhook
Properties:
|
Name |
Type |
Summary |
|
event |
string event |
event |
|
status |
string status |
status |
|
url |
string url |
url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
STATUS |
string STATUS |
STATUS |
|
webhook |
|
webhook |
Summary:
Description: webhook
Properties:
|
Name |
Type |
Summary |
|
event |
string event |
event |
|
status |
string status |
status |
|
url |
string url |
url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
STATUS |
string STATUS |
STATUS |
|
webhook |
|
webhook |
Summary:
Description: webhook
Properties:
|
Name |
Type |
Summary |
|
event |
string event |
event |
|
status |
string status |
status |
|
url |
string url |
url |