Version 4.43 or later needs to be installed to add the server automatically
Use cases
About
Tools for Teamwork.com products.
Attribute | Details |
---|---|
Docker Image | mcp/teamwork |
Author | Teamwork |
Repository | https://github.com/teamwork/mcp |
Docker Image built by|Docker Inc.
Docker Scout Health Score| Verify Signature|
COSIGN_REPOSITORY=mcp/signatures cosign verify mcp/teamwork --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub
Licence|MIT License
Tools provided by this Server | Short Description |
---|---|
twdesk-create_company | Create Company |
twdesk-create_customer | Create Customer |
twdesk-create_file | Create File |
twdesk-create_message | Create Message |
twdesk-create_priority | Create Priority |
twdesk-create_status | Create Status |
twdesk-create_tag | Create Tag |
twdesk-create_ticket | Create Ticket |
twdesk-create_type | Create Type |
twdesk-get_company | Get Company |
twdesk-get_customer | Get Customer |
twdesk-get_inbox | Get Inbox |
twdesk-get_priority | Get Priority |
twdesk-get_status | Get Status |
twdesk-get_tag | Get Tag |
twdesk-get_ticket | Get Ticket |
twdesk-get_type | Get Type |
twdesk-get_user | Get User |
twdesk-list_companies | List Companies |
twdesk-list_customers | List Customers |
twdesk-list_inboxes | List Inboxes |
twdesk-list_priorities | List Priorities |
twdesk-list_statuses | List Statuses |
twdesk-list_tags | List Tags |
twdesk-list_tickets | Search Tickets |
twdesk-list_types | List Types |
twdesk-list_users | List Users |
twdesk-update_company | Update Company |
twdesk-update_customer | Update Customer |
twdesk-update_priority | Update Priority |
twdesk-update_status | Update Status |
twdesk-update_tag | Update Tag |
twdesk-update_ticket | Update Ticket |
twdesk-update_type | Update Type |
twprojects-add_project_member | Add Project Member |
twprojects-complete_timer | Complete Timer |
twprojects-create_comment | Create Comment |
twprojects-create_company | Create Company |
twprojects-create_milestone | Create Milestone |
twprojects-create_notebook | Create Notebook |
twprojects-create_project | Create Project |
twprojects-create_tag | Create Tag |
twprojects-create_task | Create Task |
twprojects-create_tasklist | Create Tasklist |
twprojects-create_team | Create Team |
twprojects-create_timelog | Create Timelog |
twprojects-create_timer | Create Timer |
twprojects-create_user | Create User |
twprojects-get_comment | Get Comment |
twprojects-get_company | Get Company |
twprojects-get_milestone | Get Milestone |
twprojects-get_notebook | Get Notebook |
twprojects-get_project | Get Project |
twprojects-get_tag | Get Tag |
twprojects-get_task | Get Task |
twprojects-get_tasklist | Get Tasklist |
twprojects-get_team | Get Team |
twprojects-get_timelog | Get Timelog |
twprojects-get_timer | Get Timer |
twprojects-get_user | Get User |
twprojects-get_user_me | Get Logged User |
twprojects-list_activities | List Activities |
twprojects-list_activities_by_project | List Activities by Project |
twprojects-list_comments | List Comments |
twprojects-list_comments_by_file_version | List Comments by File Version |
twprojects-list_comments_by_milestone | List Comments by Milestone |
twprojects-list_comments_by_notebook | List Comments by Notebook |
twprojects-list_comments_by_task | List Comments by Task |
twprojects-list_companies | List Companies |
twprojects-list_industries | List Industries |
twprojects-list_milestones | List Milestones |
twprojects-list_milestones_by_project | List Milestones by Project |
twprojects-list_notebooks | List Notebooks |
twprojects-list_projects | List Projects |
twprojects-list_tags | List Tags |
twprojects-list_tasklists | List Tasklists |
twprojects-list_tasklists_by_project | List Tasklists By Project |
twprojects-list_tasks | List Tasks |
twprojects-list_tasks_by_project | List Tasks By Project |
twprojects-list_tasks_by_tasklist | List Tasks By Tasklist |
twprojects-list_teams | List Teams |
twprojects-list_teams_by_company | List Teams By Company |
twprojects-list_teams_by_project | List Teams By Project |
twprojects-list_timelogs | List Timelogs |
twprojects-list_timelogs_by_project | List Timelogs By Project |
twprojects-list_timelogs_by_task | List Timelogs By Task |
twprojects-list_timers | List Timers |
twprojects-list_users | List Users |
twprojects-list_users_by_project | List Users By Project |
twprojects-pause_timer | Pause Timer |
twprojects-resume_timer | Resume Timer |
twprojects-update_comment | Update Comment |
twprojects-update_company | Update Company |
twprojects-update_milestone | Update Milestone |
twprojects-update_notebook | Update Notebook |
twprojects-update_project | Update Project |
twprojects-update_tag | Update Tag |
twprojects-update_task | Update Task |
twprojects-update_tasklist | Update Tasklist |
twprojects-update_team | Update Team |
twprojects-update_timelog | Update Timelog |
twprojects-update_timer | Update Timer |
twprojects-update_user | Update User |
twprojects-users_workload | Get Users Workload |
twdesk-create_company
Create a new company in Teamwork Desk by specifying its name, domains, and other attributes. Useful for onboarding new organizations, customizing Desk for business relationships, or adapting support processes.
Parameters | Type | Description |
---|---|---|
name | string | The name of the company. |
description | string optional | The description of the company. |
details | string optional | The details of the company. |
domains | array optional | The domains for the company. |
industry | string optional | The industry of the company. |
kind | string optional | The kind of the company. |
note | string optional | The note for the company. |
permission | string optional | The permission level of the company. |
website | string optional | The website of the company. |
twdesk-create_customer
Create a new customer in Teamwork Desk by specifying their name, contact details, and other attributes. Useful for onboarding new clients, customizing Desk for business relationships, or adapting support processes.
Parameters | Type | Description |
---|---|---|
address | string optional | The address of the customer. |
email | string optional | The email of the customer. |
extraData | string optional | The extra data of the customer. |
facebookURL | string optional | The Facebook URL of the customer. |
firstName | string optional | The first name of the customer. |
jobTitle | string optional | The job title of the customer. |
lastName | string optional | The last name of the customer. |
linkedinURL | string optional | The LinkedIn URL of the customer. |
mobile | string optional | The mobile number of the customer. |
notes | string optional | The notes of the customer. |
organization | string optional | The organization of the customer. |
phone | string optional | The phone number of the customer. |
twitterHandle | string optional | The Twitter handle of the customer. |
twdesk-create_file
Upload a new file to Teamwork Desk, enabling attachment to tickets, articles, or other resources.
Parameters | Type | Description |
---|---|---|
data | string | The content of the file as a base64-encoded string. |
mimeType | string | The MIME type of the file. |
name | string | The name of the file. |
disposition | string optional | The disposition of the file. |
twdesk-create_message
Send a reply message to a ticket in Teamwork Desk by specifying the ticket ID and message body. Useful for automating ticket responses, integrating external communication systems, or customizing support workflows.
Parameters | Type | Description |
---|---|---|
body | string | The body of the message. |
ticketID | integer | The ID of the ticket that the message will be sent to. |
twdesk-create_priority
Create a new priority in Teamwork Desk by specifying its name and color. Useful for customizing ticket workflows, introducing new escalation levels, or adapting Desk to evolving support processes.
Parameters | Type | Description |
---|---|---|
name | string | The name of the priority. |
color | string optional | The color of the priority. |
twdesk-create_status
Create a new status in Teamwork Desk by specifying its name, color, and display order. Useful for customizing ticket workflows, introducing new resolution states, or adapting Desk to evolving support processes.
Parameters | Type | Description |
---|---|---|
name | string | The name of the status. |
color | string optional | The color of the status. |
displayOrder | integer optional | The display order of the status. |
twdesk-create_tag
Create a new tag in Teamwork Desk by specifying its name and color. Useful for customizing ticket workflows, introducing new categories, or adapting Desk to evolving support processes.
Parameters | Type | Description |
---|---|---|
name | string | The name of the tag. |
color | string optional | The color of the tag. |
twdesk-create_ticket
Create a new ticket in Teamwork Desk by specifying subject, description, priority, and status. "Useful for automating ticket creation, integrating external systems, or customizing support workflows.
Parameters | Type | Description |
---|---|---|
body | string | The body of the ticket. |
inboxId | integer |
The inbox ID of the ticket.
Use the 'twdesk-list_inboxes' tool to find valid IDs.
subject
|string
|The subject of the ticket.
agentId
|integer
optional|
The agent ID that the ticket should be assigned to.
Use the 'twdesk-list_agents' tool to find valid IDs.
bcc
|array
optional|An array of email addresses to BCC on ticket creation.
cc
|array
optional|An array of email addresses to CC on ticket creation.
customerEmail
|string
optional|
The email address of the customer.
This is used to identify the customer in the system.
Either the customerId or customerEmail is required to create a ticket.
If email is provided we will either find or create the customer.
customerId
|integer
optional|
The customer ID of the ticket.
Use the 'twdesk-list_customers' tool to find valid IDs.
files
|array
optional|
An array of file IDs to attach to the ticket.
Use the 'twdesk-create_file' tool to upload files.
notifyCustomer
|boolean
optional|Set to true if the the customer should be sent a copy of the ticket.
priorityId
|integer
optional|
The priority of the ticket.
Use the 'twdesk-list_priorities' tool to find valid IDs.
statusId
|integer
optional|
The status of the ticket.
Use the 'twdesk-list_statuses' tool to find valid IDs.
tags
|array
optional|
An array of tag IDs to associate with the ticket.
Tag IDs can be found by using the 'twdesk-list_tags' tool.
typeId
|integer
optional|
The type ID of the ticket.
Use the 'twdesk-list_types' tool to find valid IDs.
twdesk-create_type
Create a new ticket type in Teamwork Desk by specifying its name, display order, and future inbox settings. Useful for customizing ticket workflows, introducing new categories, or adapting Desk to evolving support processes.
Parameters | Type | Description |
---|---|---|
name | string | The name of the type. |
displayOrder | integer optional | The display order of the type. |
enabledForFutureInboxes | boolean optional | Whether the type is enabled for future inboxes. |
twdesk-get_company
Retrieve detailed information about a specific company in Teamwork Desk by its ID. Useful for auditing company records, troubleshooting ticket associations, or integrating Desk company data into automation workflows.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the company to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-get_customer
Retrieve detailed information about a specific customer in Teamwork Desk by their ID. Useful for auditing customer records, troubleshooting ticket associations, or integrating Desk customer data into automation workflows.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the customer to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-get_inbox
Retrieve detailed information about a specific inbox in Teamwork Desk by its ID
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the inbox to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-get_priority
Retrieve detailed information about a specific priority in Teamwork Desk by its ID. Useful for inspecting priority attributes, troubleshooting ticket routing, or integrating Desk priority data into automation workflows.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the priority to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-get_status
Retrieve detailed information about a specific status in Teamwork Desk by its ID. Useful for auditing status usage, troubleshooting ticket workflows, or integrating Desk status data into automation workflows.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the status to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-get_tag
Retrieve detailed information about a specific tag in Teamwork Desk by its ID. Useful for auditing tag usage, troubleshooting ticket categorization, or integrating Desk tag data into automation workflows.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the tag to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-get_ticket
Retrieve detailed information about a specific ticket in Teamwork Desk by its ID. Useful for auditing ticket records, troubleshooting support workflows, or integrating Desk ticket data into automation and reporting systems.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the ticket to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-get_type
Retrieve detailed information about a specific ticket type in Teamwork Desk by its ID. Useful for auditing type usage, troubleshooting ticket categorization, or integrating Desk type data into automation workflows.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the type to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-get_user
Retrieve detailed information about a specific user in Teamwork Desk by their ID. Useful for auditing user records, troubleshooting ticket assignments, or integrating Desk user data into automation workflows.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the user to retrieve. |
This tool is read-only. It does not modify its environment.
twdesk-list_companies
List all companies in Teamwork Desk, with optional filters for name, domains, and kind. Enables users to audit, analyze, or synchronize company configurations for ticket management, reporting, or integration scenarios.
Parameters | Type | Description |
---|---|---|
domains | array optional | The domains of the company to filter by. |
kind | string optional | The kind of the company to filter by. |
name | string optional | The name of the company to filter by. |
orderBy | string optional | The field to order the results by. |
orderDirection | string optional | The direction to order the results by (asc, desc). |
page | integer optional | The page number to retrieve. |
pageSize | integer optional | The number of results to retrieve per page. |
This tool is read-only. It does not modify its environment.
twdesk-list_customers
List all customers in Teamwork Desk, with optional filters for company, email, and other attributes. Enables users to audit, analyze, or synchronize customer configurations for ticket management, reporting, or integration scenarios.
Parameters | Type | Description |
---|---|---|
companyIDs | array optional | The IDs of the companies to filter by. |
companyNames | array optional | The names of the companies to filter by. |
emails | array optional | The emails of the customers to filter by. |
orderBy | string optional | The field to order the results by. |
orderDirection | string optional | The direction to order the results by (asc, desc). |
page | integer optional | The page number to retrieve. |
pageSize | integer optional | The number of results to retrieve per page. |
This tool is read-only. It does not modify its environment.
twdesk-list_inboxes
List all inboxes in Teamwork Desk, with optional filters for name and email.
Parameters | Type | Description |
---|---|---|
email | array optional | The email of the inbox to filter by. |
name | array optional | The name of the inbox to filter by. |
orderBy | string optional | The field to order the results by. |
orderDirection | string optional | The direction to order the results by (asc, desc). |
page | integer optional | The page number to retrieve. |
pageSize | integer optional | The number of results to retrieve per page. |
This tool is read-only. It does not modify its environment.
twdesk-list_priorities
List all available priorities in Teamwork Desk, with optional filters for name and color. Enables users to audit, analyze, or synchronize priority configurations for ticket management, reporting, or integration scenarios.
Parameters | Type | Description |
---|---|---|
color | array optional | The color of the priority to filter by. |
name | array optional | The name of the priority to filter by. |
orderBy | string optional | The field to order the results by. |
orderDirection | string optional | The direction to order the results by (asc, desc). |
page | integer optional | The page number to retrieve. |
pageSize | integer optional | The number of results to retrieve per page. |
This tool is read-only. It does not modify its environment.
twdesk-list_statuses
List all statuses in Teamwork Desk, with optional filters for name, color, and code. Enables users to audit, analyze, or synchronize status configurations for ticket management, reporting, or integration scenarios.
Parameters | Type | Description |
---|---|---|
code | array optional | The code of the status to filter by. |
color | array optional | The color of the status to filter by. |
name | array optional | The name of the status to filter by. |
orderBy | string optional | The field to order the results by. |
orderDirection | string optional | The direction to order the results by (asc, desc). |
page | integer optional | The page number to retrieve. |
pageSize | integer optional | The number of results to retrieve per page. |
This tool is read-only. It does not modify its environment.
twdesk-list_tags
List all tags in Teamwork Desk, with optional filters for name, color, and inbox association. Enables users to audit, analyze, or synchronize tag configurations for ticket management, reporting, or integration scenarios.
Parameters | Type | Description |
---|---|---|
color | string optional | The color of the tag to filter by. |
inboxIDs | array optional | The IDs of the inboxes to filter by. |
name | string optional | The name of the tag to filter by. |
orderBy | string optional | The field to order the results by. |
orderDirection | string optional | The direction to order the results by (asc, desc). |
page | integer optional | The page number to retrieve. |
pageSize | integer optional | The number of results to retrieve per page. |
This tool is read-only. It does not modify its environment.
twdesk-list_tickets
Search tickets in Teamwork Desk using various filters including inbox, customer, company, tag, status, priority, SLA, user, and more. This tool enables users to perform targeted searches for tickets, facilitating efficient support management, reporting, and integration with other systems.
Parameters | Type | Description |
---|---|---|
search | string |
The search term to use for finding tickets.
This can be part of the subject, body, or other ticket fields.
companyIDs
|array
optional|
The IDs of the companies to filter by.
Company IDs can be found by using the 'twdesk-list_companies' tool.
customerIDs
|array
optional|
The IDs of the customers to filter by.
Customer IDs can be found by using the 'twdesk-list_customers' tool.
inboxIDs
|array
optional|
The IDs of the inboxes to filter by.
Inbox IDs can be found by using the 'twdesk-list_inboxes' tool.
orderBy
|string
optional|The field to order the results by.
orderDirection
|string
optional|The direction to order the results by (asc, desc).
page
|integer
optional|The page number to retrieve.
pageSize
|integer
optional|The number of results to retrieve per page.
priorityIDs
|array
optional|
The IDs of the priorities to filter by.
Priority IDs can be found by using the 'twdesk-list_priorities' tool.
shared
|boolean
optional|
Find tickets shared with me outside of inboxes I have access to
slaBreached
|boolean
optional|
Find tickets where the SLA has been breached
statusIDs
|array
optional|
The IDs of the statuses to filter by.
Status IDs can be found by using the 'twdesk-list_statuses' tool.
tagIDs
|array
optional|
The IDs of the tags to filter by.
Tag IDs can be found by using the 'twdesk-list_tags' tool.
userIDs
|array
optional|
The IDs of the users to filter by.
User IDs can be found by using the 'twdesk-list_users' tool.
This tool is read-only. It does not modify its environment.
twdesk-list_types
List all ticket types in Teamwork Desk, with optional filters for name and inbox association. Enables users to audit, analyze, or synchronize type configurations for ticket management, reporting, or integration scenarios.
Parameters | Type | Description |
---|---|---|
inboxIDs | array optional | The inbox IDs of the type to filter by. |
name | array optional | The name of the type to filter by. |
orderBy | string optional | The field to order the results by. |
orderDirection | string optional | The direction to order the results by (asc, desc). |
page | integer optional | The page number to retrieve. |
pageSize | integer optional | The number of results to retrieve per page. |
This tool is read-only. It does not modify its environment.
twdesk-list_users
List all users in Teamwork Desk, with optional filters for name, email, inbox, and part-time status. Enables users to audit, analyze, or synchronize user configurations for support management, reporting, or integration scenarios.
Parameters | Type | Description |
---|---|---|
email | array optional | The email addresses of the users to filter by. |
firstName | array optional | The first names of the users to filter by. |
inboxIDs | array optional | The IDs of the inboxes to filter by. |
isPartTime | boolean optional | Whether to include part-time users in the results. |
lastName | array optional | The last names of the users to filter by. |
orderBy | string optional | The field to order the results by. |
orderDirection | string optional | The direction to order the results by (asc, desc). |
page | integer optional | The page number to retrieve. |
pageSize | integer optional | The number of results to retrieve per page. |
This tool is read-only. It does not modify its environment.
twdesk-update_company
Update an existing company in Teamwork Desk by ID, allowing changes to its name, domains, and other attributes. Supports evolving business relationships, rebranding, or correcting company records for improved ticket handling.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the company to update. |
description | string optional | The new description of the company. |
details | string optional | The new details of the company. |
domains | array optional | The new domains for the company. |
industry | string optional | The new industry of the company. |
kind | string optional | The new kind of the company. |
name | string optional | The new name of the company. |
note | string optional | The new note for the company. |
permission | string optional | The new permission level of the company. |
website | string optional | The new website of the company. |
twdesk-update_customer
Update an existing customer in Teamwork Desk by ID, allowing changes to their name, contact details, and other attributes. Supports evolving business relationships, correcting customer records, or improving ticket handling.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the customer to update. |
address | string optional | The new address of the customer. |
email | string optional | The new email of the customer. |
extraData | string optional | The new extra data of the customer. |
facebookURL | string optional | The new Facebook URL of the customer. |
firstName | string optional | The new first name of the customer. |
jobTitle | string optional | The new job title of the customer. |
lastName | string optional | The new last name of the customer. |
linkedinURL | string optional | The new LinkedIn URL of the customer. |
mobile | string optional | The new mobile number of the customer. |
notes | string optional | The new notes of the customer. |
organization | string optional | The new organization of the customer. |
phone | string optional | The new phone number of the customer. |
twitterHandle | string optional | The new Twitter handle of the customer. |
twdesk-update_priority
Update an existing priority in Teamwork Desk by ID, allowing changes to its name and color. Supports evolving support policies, rebranding, or correcting priority attributes for improved ticket handling.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the priority to update. |
color | string optional | The color of the priority. |
name | string optional | The new name of the priority. |
twdesk-update_status
Update an existing status in Teamwork Desk by ID, allowing changes to its name, color, and display order. Supports evolving support policies, rebranding, or correcting status attributes for improved ticket handling.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the status to update. |
color | string optional | The color of the status. |
displayOrder | integer optional | The display order of the status. |
name | string optional | The new name of the status. |
twdesk-update_tag
Update an existing tag in Teamwork Desk by ID, allowing changes to its name and color. Supports evolving support policies, rebranding, or correcting tag attributes for improved ticket handling.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the tag to update. |
color | string optional | The color of the tag. |
name | string optional | The new name of the tag. |
twdesk-update_ticket
Update an existing ticket in Teamwork Desk by ID, allowing changes to its attributes. Supports evolving support processes, correcting ticket records, or integrating with automation systems for improved ticket handling.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the ticket to update. |
agentId | integer optional |
The agent ID that the ticket should be assigned to.
Use the 'twdesk-list_agents' tool to find valid IDs.
body
|string
optional|The body of the ticket.
priorityId
|integer
optional|
The priority of the ticket.
Use the 'twdesk-list_priorities' tool to find valid IDs.
statusId
|integer
optional|
The status of the ticket.
Use the 'twdesk-list_statuses' tool to find valid IDs.
subject
|string
optional|The subject of the ticket.
typeId
|integer
optional|
The type ID of the ticket.
Use the 'twdesk-list_types' tool to find valid IDs.
twdesk-update_type
Update an existing ticket type in Teamwork Desk by ID, allowing changes to its name, display order, and future inbox settings. Supports evolving support policies, rebranding, or correcting type attributes for improved ticket handling.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the type to update. |
displayOrder | integer optional | The display order of the type. |
enabledForFutureInboxes | boolean optional | Whether the type is enabled for future inboxes. |
name | string optional | The new name of the type. |
twprojects-add_project_member
Add a user to a project in Teamwork.com. In the context of Teamwork.com, a project member is a user who is assigned to a specific project. Project members can have different roles and permissions within the project, allowing them to collaborate on tasks, view project details, and contribute to the project's success. Managing project members effectively is crucial for ensuring that the right people are involved in the right tasks, and it helps maintain accountability and clarity throughout the project's lifecycle.
Parameters | Type | Description |
---|---|---|
project_id | integer | The ID of the project to add the member to. |
user_ids | array optional | A list of user IDs to add to the project. |
twprojects-complete_timer
Complete an existing timer in Teamwork.com. Timer is a built-in tool that allows users to accurately track the time they spend working on specific tasks, projects, or client work. Instead of manually recording hours, users can start, pause, and stop timers directly within the platform or through the desktop and mobile apps, ensuring precise time logs without interrupting their workflow. Once recorded, these entries are automatically linked to the relevant task or project, making it easier to monitor productivity, manage billable hours, and generate detailed reports for both internal tracking and client invoicing.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the timer to complete. |
twprojects-create_comment
Create a new comment in Teamwork.com. In the Teamwork.com context, a comment is a way for users to communicate and collaborate directly within tasks, milestones, files, or other project items. Comments allow team members to provide updates, ask questions, give feedback, or share relevant information in a centralized and contextual manner. They support rich text formatting, file attachments, and @mentions to notify specific users or teams, helping keep discussions organized and easily accessible within the project. Comments are visible to all users with access to the item, promoting transparency and keeping everyone aligned.
Parameters | Type | Description |
---|---|---|
body | string | The content of the comment. The content can be added as text or HTML. |
object | object | The object to create the comment for. It can be a tasks, milestones, files or notebooks. |
content_type | string optional | The content type of the comment. It can be either 'TEXT' or 'HTML'. |
twprojects-create_company
Create a new company in Teamwork.com. In the context of Teamwork.com, a company represents an organization or business entity that can be associated with users, projects, and tasks within the platform, and it is often referred to as a “client.” It serves as a way to group related users and projects under a single organizational umbrella, making it easier to manage permissions, assign responsibilities, and organize work. Companies (or clients) are frequently used to distinguish between internal teams and external collaborators, enabling teams to work efficiently while maintaining clear boundaries around ownership, visibility, and access levels across different projects.
Parameters | Type | Description |
---|---|---|
name | string | The name of the company. |
address_one | string optional | The first line of the address of the company. |
address_two | string optional | The second line of the address of the company. |
city | string optional | The city of the company. |
country_code | string optional | The country code of the company, e.g., 'US' for the United States. |
email_one | string optional | The primary email address of the company. |
email_three | string optional | The tertiary email address of the company. |
email_two | string optional | The secondary email address of the company. |
fax | string optional | The fax number of the company. |
industry_id | integer optional | The ID of the industry the company belongs to. |
manager_id | integer optional | The ID of the user who manages the company. |
phone | string optional | The phone number of the company. |
profile | string optional | A profile description for the company. |
state | string optional | The state of the company. |
tag_ids | array optional | A list of tag IDs to associate with the company. |
website | string optional | The website of the company. |
zip | string optional | The ZIP or postal code of the company. |
twprojects-create_milestone
Create a new milestone in Teamwork.com. In the context of Teamwork.com, a milestone represents a significant point or goal within a project that marks the completion of a major phase or a key deliverable. It acts as a high-level indicator of progress, helping teams track whether work is advancing according to plan. Milestones are typically used to coordinate efforts across different tasks and task lists, providing a clear deadline or objective that multiple team members or departments can align around. They don't contain individual tasks themselves but serve as checkpoints to ensure the project is moving in the right direction.
Parameters | Type | Description |
---|---|---|
assignees | object | An object containing assignees for the milestone. MUST contain at least one of: user_ids, company_ids or team_ids with non-empty arrays. |
due_date | string | The due date of the milestone in the format YYYYMMDD. This date will be used in all tasks without a due date related to this milestone. |
name | string | The name of the milestone. |
project_id | integer | The ID of the project to create the milestone in. |
description | string optional | A description of the milestone. |
tag_ids | array optional | A list of tag IDs to associate with the milestone. |
tasklist_ids | array optional | A list of tasklist IDs to associate with the milestone. |
twprojects-create_notebook
Create a new notebook in Teamwork.com. Notebook is a space where teams can create, share, and organize written content in a structured way. It’s commonly used for documenting processes, storing meeting notes, capturing research, or drafting ideas that need to be revisited and refined over time. Unlike quick messages or task comments, notebooks provide a more permanent and organized format that can be easily searched and referenced, helping teams maintain a centralized source of knowledge and ensuring important information remains accessible to everyone who needs it.
Parameters | Type | Description |
---|---|---|
contents | string | The contents of the notebook. |
name | string | The name of the notebook. |
project_id | integer | The ID of the project to create the notebook in. |
type | string | The type of the notebook. Valid values are 'MARKDOWN' and 'HTML'. |
description | string optional | A description of the notebook. |
tag_ids | array optional | A list of tag IDs to associate with the notebook. |
twprojects-create_project
Create a new project in Teamwork.com. The project feature in Teamwork.com serves as the central workspace for organizing and managing a specific piece of work or initiative. Each project provides a dedicated area where teams can plan tasks, assign responsibilities, set deadlines, and track progress toward shared goals. Projects include tools for communication, file sharing, milestones, and time tracking, allowing teams to stay aligned and informed throughout the entire lifecycle of the work. Whether it's a product launch, client engagement, or internal initiative, projects in Teamwork.com help teams structure their efforts, collaborate more effectively, and deliver results with greater visibility and accountability.
Parameters | Type | Description |
---|---|---|
name | string | The name of the project. |
company_id | integer optional | The ID of the company associated with the project. |
description | string optional | The description of the project. |
end_at | string optional | The end date of the project in the format YYYYMMDD. |
owned_id | integer optional | The ID of the user who owns the project. |
start_at | string optional | The start date of the project in the format YYYYMMDD. |
tag_ids | array optional | A list of tag IDs to associate with the project. |
twprojects-create_tag
Create a new tag in Teamwork.com. In the context of Teamwork.com, a tag is a customizable label that can be applied to various items such as tasks, projects, milestones, messages, and more, to help categorize and organize work efficiently. Tags provide a flexible way to filter, search, and group related items across the platform, making it easier for teams to manage complex workflows, highlight priorities, or track themes and statuses. Since tags are user-defined, they adapt to each team’s specific needs and can be color-coded for better visual clarity.
Parameters | Type | Description |
---|---|---|
name | string | The name of the tag. It must have less than 50 characters. |
project_id | integer optional | The ID of the project to associate the tag with. This is for project-scoped tags. |
twprojects-create_task
Create a new task in Teamwork.com. In Teamwork.com, a task represents an individual unit of work assigned to one or more team members within a project. Each task can include details such as a title, description, priority, estimated time, assignees, and due date, along with the ability to attach files, leave comments, track time, and set dependencies on other tasks. Tasks are organized within task lists, helping structure and sequence work logically. They serve as the building blocks of project management in Teamwork, allowing teams to collaborate, monitor progress, and ensure accountability throughout the project's lifecycle.
Parameters | Type | Description |
---|---|---|
name | string | The name of the task. |
tasklist_id | integer | The ID of the tasklist. If you only have the project's name, use the twprojects-list_projects method with the search_term parameter to find the project ID, and then the twprojects-list_tasklists method with the project_id to choose the tasklist ID. If you know the tasklist's name, you may also use the search_term parameter with the twprojects-list_tasklists method to find the tasklist ID. |
assignees | object optional | An object containing assignees for the task. |
description | string optional | The description of the task. |
due_date | string optional | The due date of the task in ISO 8601 format (YYYY-MM-DD). When this is not provided, it will fallback to the milestone due date if a milestone is set. |
estimated_minutes | integer optional | The estimated time to complete the task in minutes. |
parent_task_id | integer optional | The ID of the parent task if creating a subtask. |
predecessors | array optional | List of task dependencies that must be completed before this task can start, defining its position in the project workflow and ensuring proper sequencing of work. |
priority | string optional | The priority of the task. Possible values are: low, medium, high. |
progress | integer optional | The progress of the task, as a percentage (0-100). Only whole numbers are allowed. |
start_date | string optional | The start date of the task in ISO 8601 format (YYYY-MM-DD). |
tag_ids | array optional | A list of tag IDs to assign to the task. |
twprojects-create_tasklist
Create a new tasklist in Teamwork.com. In the context of Teamwork.com, a task list is a way to group related tasks within a project, helping teams organize their work into meaningful sections such as phases, categories, or deliverables. Each task list belongs to a specific project and can include multiple tasks that are typically aligned with a common goal. Task lists can be associated with milestones, and they support privacy settings that control who can view or interact with the tasks they contain. This structure helps teams manage progress, assign responsibilities, and maintain clarity across complex projects.
Parameters | Type | Description |
---|---|---|
name | string | The name of the tasklist. |
project_id | integer | The ID of the project to create the tasklist in. |
description | string optional | The description of the tasklist. |
milestone_id | integer optional | The ID of the milestone to associate with the tasklist. |
twprojects-create_team
Create a new team in Teamwork.com. In the context of Teamwork.com, a team is a group of users who are organized together to collaborate more efficiently on projects and tasks. Teams help structure work by grouping individuals with similar roles, responsibilities, or departmental functions, making it easier to assign work, track progress, and manage communication. By using teams, organizations can streamline project planning and ensure the right people are involved in the right parts of a project, enhancing clarity and accountability across the platform.
Parameters | Type | Description |
---|---|---|
name | string | The name of the team. |
company_id | integer optional | The ID of the company. This is used to create a team scoped for a specific company. |
description | string optional | The description of the team. |
handle | string optional | The handle of the team. It is a unique identifier for the team. It must not have spaces or special characters. |
parent_team_id | integer optional | The ID of the parent team. This is used to create a hierarchy of teams. |
project_id | integer optional | The ID of the project. This is used to create a team scoped for a specific project. |
user_ids | array optional | A list of user IDs to add to the team. |
twprojects-create_timelog
Create a new timelog in Teamwork.com. Timelog refers to a recorded entry that tracks the amount of time a person has spent working on a specific task, project, or piece of work. These entries typically include details such as the duration of time worked, the date and time it was logged, who logged it, and any optional notes describing what was done during that period. Timelogs are essential for understanding how time is being allocated across projects, enabling teams to manage resources more effectively, invoice clients accurately, and assess productivity. They can be created manually or with timers, and are often used for reporting and billing purposes.
Parameters | Type | Description |
---|---|---|
date | string | The date of the timelog in the format YYYY-MM-DD. |
hours | integer | The number of hours spent on the timelog. Must be a positive integer. |
minutes | integer | The number of minutes spent on the timelog. Must be a positive integer less than 60, otherwise the hours attribute should be incremented. |
time | string | The time of the timelog in the format HH:MM:SS. |
billable | boolean optional | If true, the timelog is billable. Defaults to false. |
description | string optional | A description of the timelog. |
is_utc | boolean optional | If true, the time is in UTC. Defaults to false. |
project_id | integer optional | The ID of the project to associate the timelog with. Either project_id or task_id must be provided, but not both. |
tag_ids | array optional | A list of tag IDs to associate with the timelog. |
task_id | integer optional | The ID of the task to associate the timelog with. Either project_id or task_id must be provided, but not both. |
user_id | integer optional | The ID of the user to associate the timelog with. Defaults to the authenticated user if not provided. |
twprojects-create_timer
Create a new timer in Teamwork.com. Timer is a built-in tool that allows users to accurately track the time they spend working on specific tasks, projects, or client work. Instead of manually recording hours, users can start, pause, and stop timers directly within the platform or through the desktop and mobile apps, ensuring precise time logs without interrupting their workflow. Once recorded, these entries are automatically linked to the relevant task or project, making it easier to monitor productivity, manage billable hours, and generate detailed reports for both internal tracking and client invoicing.
Parameters | Type | Description |
---|---|---|
project_id | integer | The ID of the project to associate the timer with. |
billable | boolean optional | If true, the timer is billable. Defaults to false. |
description | string optional | A description of the timer. |
running | boolean optional | If true, the timer will start running immediately. |
seconds | integer optional | The number of seconds to set the timer for. |
stop_running_timers | boolean optional | If true, any other running timers will be stopped when this timer is created. |
task_id | integer optional | The ID of the task to associate the timer with. |
twprojects-create_user
Create a new user in Teamwork.com. A user is an individual who has access to one or more projects within a Teamwork site, typically as a team member, collaborator, or administrator. Users can be assigned tasks, participate in discussions, log time, share files, and interact with other members depending on their permission levels. Each user has a unique profile that defines their role, visibility, and access to features and project data. Users can belong to clients/companies or teams within the system, and their permissions can be customized to control what actions they can perform or what information they can see.
Parameters | Type | Description |
---|---|---|
email | string | The email address of the user. |
first_name | string | The first name of the user. |
last_name | string | The last name of the user. |
admin | boolean optional | Indicates whether the user is an administrator. |
company_id | integer optional | The ID of the client/company to which the user belongs. |
title | string optional | The job title of the user, such as 'Project Manager' or 'Senior Software Developer'. |
type | string optional | The type of user, such as 'account', 'collaborator', or 'contact'. |
twprojects-get_comment
Get an existing comment in Teamwork.com. In the Teamwork.com context, a comment is a way for users to communicate and collaborate directly within tasks, milestones, files, or other project items. Comments allow team members to provide updates, ask questions, give feedback, or share relevant information in a centralized and contextual manner. They support rich text formatting, file attachments, and @mentions to notify specific users or teams, helping keep discussions organized and easily accessible within the project. Comments are visible to all users with access to the item, promoting transparency and keeping everyone aligned.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the comment to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_company
Get an existing company in Teamwork.com. In the context of Teamwork.com, a company represents an organization or business entity that can be associated with users, projects, and tasks within the platform, and it is often referred to as a “client.” It serves as a way to group related users and projects under a single organizational umbrella, making it easier to manage permissions, assign responsibilities, and organize work. Companies (or clients) are frequently used to distinguish between internal teams and external collaborators, enabling teams to work efficiently while maintaining clear boundaries around ownership, visibility, and access levels across different projects.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the company to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_milestone
Get an existing milestone in Teamwork.com. In the context of Teamwork.com, a milestone represents a significant point or goal within a project that marks the completion of a major phase or a key deliverable. It acts as a high-level indicator of progress, helping teams track whether work is advancing according to plan. Milestones are typically used to coordinate efforts across different tasks and task lists, providing a clear deadline or objective that multiple team members or departments can align around. They don't contain individual tasks themselves but serve as checkpoints to ensure the project is moving in the right direction.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the milestone to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_notebook
Get an existing notebook in Teamwork.com. Notebook is a space where teams can create, share, and organize written content in a structured way. It’s commonly used for documenting processes, storing meeting notes, capturing research, or drafting ideas that need to be revisited and refined over time. Unlike quick messages or task comments, notebooks provide a more permanent and organized format that can be easily searched and referenced, helping teams maintain a centralized source of knowledge and ensuring important information remains accessible to everyone who needs it.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the notebook to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_project
Get an existing project in Teamwork.com. The project feature in Teamwork.com serves as the central workspace for organizing and managing a specific piece of work or initiative. Each project provides a dedicated area where teams can plan tasks, assign responsibilities, set deadlines, and track progress toward shared goals. Projects include tools for communication, file sharing, milestones, and time tracking, allowing teams to stay aligned and informed throughout the entire lifecycle of the work. Whether it's a product launch, client engagement, or internal initiative, projects in Teamwork.com help teams structure their efforts, collaborate more effectively, and deliver results with greater visibility and accountability.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the project to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_tag
Get an existing tag in Teamwork.com. In the context of Teamwork.com, a tag is a customizable label that can be applied to various items such as tasks, projects, milestones, messages, and more, to help categorize and organize work efficiently. Tags provide a flexible way to filter, search, and group related items across the platform, making it easier for teams to manage complex workflows, highlight priorities, or track themes and statuses. Since tags are user-defined, they adapt to each team’s specific needs and can be color-coded for better visual clarity.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the tag to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_task
Get an existing task in Teamwork.com. In Teamwork.com, a task represents an individual unit of work assigned to one or more team members within a project. Each task can include details such as a title, description, priority, estimated time, assignees, and due date, along with the ability to attach files, leave comments, track time, and set dependencies on other tasks. Tasks are organized within task lists, helping structure and sequence work logically. They serve as the building blocks of project management in Teamwork, allowing teams to collaborate, monitor progress, and ensure accountability throughout the project's lifecycle.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the task to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_tasklist
Get an existing tasklist in Teamwork.com. In the context of Teamwork.com, a task list is a way to group related tasks within a project, helping teams organize their work into meaningful sections such as phases, categories, or deliverables. Each task list belongs to a specific project and can include multiple tasks that are typically aligned with a common goal. Task lists can be associated with milestones, and they support privacy settings that control who can view or interact with the tasks they contain. This structure helps teams manage progress, assign responsibilities, and maintain clarity across complex projects.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the tasklist to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_team
Get an existing team in Teamwork.com. In the context of Teamwork.com, a team is a group of users who are organized together to collaborate more efficiently on projects and tasks. Teams help structure work by grouping individuals with similar roles, responsibilities, or departmental functions, making it easier to assign work, track progress, and manage communication. By using teams, organizations can streamline project planning and ensure the right people are involved in the right parts of a project, enhancing clarity and accountability across the platform.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the team to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_timelog
Get an existing timelog in Teamwork.com. Timelog refers to a recorded entry that tracks the amount of time a person has spent working on a specific task, project, or piece of work. These entries typically include details such as the duration of time worked, the date and time it was logged, who logged it, and any optional notes describing what was done during that period. Timelogs are essential for understanding how time is being allocated across projects, enabling teams to manage resources more effectively, invoice clients accurately, and assess productivity. They can be created manually or with timers, and are often used for reporting and billing purposes.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the timelog to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_timer
Get an existing timer in Teamwork.com. Timer is a built-in tool that allows users to accurately track the time they spend working on specific tasks, projects, or client work. Instead of manually recording hours, users can start, pause, and stop timers directly within the platform or through the desktop and mobile apps, ensuring precise time logs without interrupting their workflow. Once recorded, these entries are automatically linked to the relevant task or project, making it easier to monitor productivity, manage billable hours, and generate detailed reports for both internal tracking and client invoicing.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the timer to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_user
Get an existing user in Teamwork.com. A user is an individual who has access to one or more projects within a Teamwork site, typically as a team member, collaborator, or administrator. Users can be assigned tasks, participate in discussions, log time, share files, and interact with other members depending on their permission levels. Each user has a unique profile that defines their role, visibility, and access to features and project data. Users can belong to clients/companies or teams within the system, and their permissions can be customized to control what actions they can perform or what information they can see.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the user to get. |
This tool is read-only. It does not modify its environment.
twprojects-get_user_me
Get the logged user in Teamwork.com. A user is an individual who has access to one or more projects within a Teamwork site, typically as a team member, collaborator, or administrator. Users can be assigned tasks, participate in discussions, log time, share files, and interact with other members depending on their permission levels. Each user has a unique profile that defines their role, visibility, and access to features and project data. Users can belong to clients/companies or teams within the system, and their permissions can be customized to control what actions they can perform or what information they can see.
twprojects-list_activities
List activities in Teamwork.com. Activity is a record of actions and updates that occur across your projects, tasks, and communications, giving you a clear view of what’s happening within your workspace. Activities capture changes such as task completions, activities added, files uploaded, or milestones updated, and present them in a chronological feed so teams can stay aligned without needing to check each individual project or task. This stream of information helps improve transparency, ensures accountability, and keeps everyone aware of progress and decisions as they happen.
Parameters | Type | Description |
---|---|---|
end_date | string optional | End date to filter activities. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
log_item_types | array optional | Filter activities by item types. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
start_date | string optional | Start date to filter activities. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
This tool is read-only. It does not modify its environment.
twprojects-list_activities_by_project
List activities in Teamwork.com by project. Activity is a record of actions and updates that occur across your projects, tasks, and communications, giving you a clear view of what’s happening within your workspace. Activities capture changes such as task completions, activities added, files uploaded, or milestones updated, and present them in a chronological feed so teams can stay aligned without needing to check each individual project or task. This stream of information helps improve transparency, ensures accountability, and keeps everyone aware of progress and decisions as they happen.
Parameters | Type | Description |
---|---|---|
end_date | string optional | End date to filter activities. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
log_item_types | array optional | Filter activities by item types. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
project_id | integer optional | The ID of the project to retrieve activities from. |
start_date | string optional | Start date to filter activities. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
This tool is read-only. It does not modify its environment.
twprojects-list_comments
List comments in Teamwork.com. In the Teamwork.com context, a comment is a way for users to communicate and collaborate directly within tasks, milestones, files, or other project items. Comments allow team members to provide updates, ask questions, give feedback, or share relevant information in a centralized and contextual manner. They support rich text formatting, file attachments, and @mentions to notify specific users or teams, helping keep discussions organized and easily accessible within the project. Comments are visible to all users with access to the item, promoting transparency and keeping everyone aligned.
Parameters | Type | Description |
---|---|---|
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter comments by name. |
This tool is read-only. It does not modify its environment.
twprojects-list_comments_by_file_version
List comments in Teamwork.com by file version. In the Teamwork.com context, a comment is a way for users to communicate and collaborate directly within tasks, milestones, files, or other project items. Comments allow team members to provide updates, ask questions, give feedback, or share relevant information in a centralized and contextual manner. They support rich text formatting, file attachments, and @mentions to notify specific users or teams, helping keep discussions organized and easily accessible within the project. Comments are visible to all users with access to the item, promoting transparency and keeping everyone aligned.
Parameters | Type | Description |
---|---|---|
file_version_id | integer | The ID of the file version to retrieve comments for. Each file can have multiple versions, and comments can be associated with specific versions. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter comments by name. |
This tool is read-only. It does not modify its environment.
twprojects-list_comments_by_milestone
List comments in Teamwork.com by milestone. In the Teamwork.com context, a comment is a way for users to communicate and collaborate directly within tasks, milestones, files, or other project items. Comments allow team members to provide updates, ask questions, give feedback, or share relevant information in a centralized and contextual manner. They support rich text formatting, file attachments, and @mentions to notify specific users or teams, helping keep discussions organized and easily accessible within the project. Comments are visible to all users with access to the item, promoting transparency and keeping everyone aligned.
Parameters | Type | Description |
---|---|---|
milestone_id | integer | The ID of the milestone to retrieve comments for. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter comments by name. |
This tool is read-only. It does not modify its environment.
twprojects-list_comments_by_notebook
List comments in Teamwork.com by notebook. In the Teamwork.com context, a comment is a way for users to communicate and collaborate directly within tasks, milestones, files, or other project items. Comments allow team members to provide updates, ask questions, give feedback, or share relevant information in a centralized and contextual manner. They support rich text formatting, file attachments, and @mentions to notify specific users or teams, helping keep discussions organized and easily accessible within the project. Comments are visible to all users with access to the item, promoting transparency and keeping everyone aligned.
Parameters | Type | Description |
---|---|---|
notebook_id | integer | The ID of the notebook to retrieve comments for. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter comments by name. |
This tool is read-only. It does not modify its environment.
twprojects-list_comments_by_task
List comments in Teamwork.com by task. In the Teamwork.com context, a comment is a way for users to communicate and collaborate directly within tasks, milestones, files, or other project items. Comments allow team members to provide updates, ask questions, give feedback, or share relevant information in a centralized and contextual manner. They support rich text formatting, file attachments, and @mentions to notify specific users or teams, helping keep discussions organized and easily accessible within the project. Comments are visible to all users with access to the item, promoting transparency and keeping everyone aligned.
Parameters | Type | Description |
---|---|---|
task_id | integer | The ID of the task to retrieve comments for. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter comments by name. |
This tool is read-only. It does not modify its environment.
twprojects-list_companies
List companies in Teamwork.com. In the context of Teamwork.com, a company represents an organization or business entity that can be associated with users, projects, and tasks within the platform, and it is often referred to as a “client.” It serves as a way to group related users and projects under a single organizational umbrella, making it easier to manage permissions, assign responsibilities, and organize work. Companies (or clients) are frequently used to distinguish between internal teams and external collaborators, enabling teams to work efficiently while maintaining clear boundaries around ownership, visibility, and access levels across different projects.
Parameters | Type | Description |
---|---|---|
match_all_tags | boolean optional | If true, the search will match companies that have all the specified tags. If false, the search will match companies that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter companies by name. Each word from the search term is used to match against the company name. |
tag_ids | array optional | A list of tag IDs to filter companies by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_industries
List industries in Teamwork.com. Industry refers to the business sector or market category that a company belongs to, such as technology, healthcare, finance, or education. It helps provide context about the nature of a company's work and can be used to better organize and filter data across the platform. By associating companies and projects with specific industries, Teamwork.com allows teams to gain clearer insights, tailor communication, and segment information in ways that make it easier to manage relationships and understand the broader business landscape in which their clients and partners operate.
twprojects-list_milestones
List milestones in Teamwork.com. In the context of Teamwork.com, a milestone represents a significant point or goal within a project that marks the completion of a major phase or a key deliverable. It acts as a high-level indicator of progress, helping teams track whether work is advancing according to plan. Milestones are typically used to coordinate efforts across different tasks and task lists, providing a clear deadline or objective that multiple team members or departments can align around. They don't contain individual tasks themselves but serve as checkpoints to ensure the project is moving in the right direction.
Parameters | Type | Description |
---|---|---|
match_all_tags | boolean optional | If true, the search will match milestones that have all the specified tags. If false, the search will match milestones that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter milestones by name. Each word from the search term is used to match against the milestone name and description. The milestone will be selected if each word of the term matches the milestone name or description, not requiring that the word matches are in the same field. |
tag_ids | array optional | A list of tag IDs to filter milestones by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_milestones_by_project
List milestones in Teamwork.com by project. In the context of Teamwork.com, a milestone represents a significant point or goal within a project that marks the completion of a major phase or a key deliverable. It acts as a high-level indicator of progress, helping teams track whether work is advancing according to plan. Milestones are typically used to coordinate efforts across different tasks and task lists, providing a clear deadline or objective that multiple team members or departments can align around. They don't contain individual tasks themselves but serve as checkpoints to ensure the project is moving in the right direction.
Parameters | Type | Description |
---|---|---|
project_id | integer | The ID of the project from which to retrieve milestones. |
match_all_tags | boolean optional | If true, the search will match milestones that have all the specified tags. If false, the search will match milestones that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter milestones by name. Each word from the search term is used to match against the milestone name and description. The milestone will be selected if each word of the term matches the milestone name or description, not requiring that the word matches are in the same field. |
tag_ids | array optional | A list of tag IDs to filter milestones by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_notebooks
List notebooks in Teamwork.com. Notebook is a space where teams can create, share, and organize written content in a structured way. It’s commonly used for documenting processes, storing meeting notes, capturing research, or drafting ideas that need to be revisited and refined over time. Unlike quick messages or task comments, notebooks provide a more permanent and organized format that can be easily searched and referenced, helping teams maintain a centralized source of knowledge and ensuring important information remains accessible to everyone who needs it.
Parameters | Type | Description |
---|---|---|
include_contents | boolean optional | If true, the contents of the notebook will be included in the response. Defaults to true. |
match_all_tags | boolean optional | If true, the search will match notebooks that have all the specified tags. If false, the search will match notebooks that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
project_ids | array optional | A list of project IDs to filter notebooks by projects |
search_term | string optional | A search term to filter notebooks by name or description. The notebook will be selected if each word of the term matches the notebook name or description, not requiring that the word matches are in the same field. |
tag_ids | array optional | A list of tag IDs to filter notebooks by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_projects
List projects in Teamwork.com. The project feature in Teamwork.com serves as the central workspace for organizing and managing a specific piece of work or initiative. Each project provides a dedicated area where teams can plan tasks, assign responsibilities, set deadlines, and track progress toward shared goals. Projects include tools for communication, file sharing, milestones, and time tracking, allowing teams to stay aligned and informed throughout the entire lifecycle of the work. Whether it's a product launch, client engagement, or internal initiative, projects in Teamwork.com help teams structure their efforts, collaborate more effectively, and deliver results with greater visibility and accountability.
Parameters | Type | Description |
---|---|---|
match_all_tags | boolean optional | If true, the search will match projects that have all the specified tags. If false, the search will match projects that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter projects by name or description. |
tag_ids | array optional | A list of tag IDs to filter projects by tags. |
This tool is read-only. It does not modify its environment.
twprojects-list_tags
List tags in Teamwork.com. In the context of Teamwork.com, a tag is a customizable label that can be applied to various items such as tasks, projects, milestones, messages, and more, to help categorize and organize work efficiently. Tags provide a flexible way to filter, search, and group related items across the platform, making it easier for teams to manage complex workflows, highlight priorities, or track themes and statuses. Since tags are user-defined, they adapt to each team’s specific needs and can be color-coded for better visual clarity.
Parameters | Type | Description |
---|---|---|
item_type | string optional | The type of item to filter tags by. Valid values are 'project', 'task', 'tasklist', 'milestone', 'message', 'timelog', 'notebook', 'file', 'company' and 'link'. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
project_ids | array optional | A list of project IDs to filter tags by projects |
search_term | string optional | A search term to filter tags by name. Each word from the search term is used to match against the tag name. |
This tool is read-only. It does not modify its environment.
twprojects-list_tasklists
List tasklists in Teamwork.com. In the context of Teamwork.com, a task list is a way to group related tasks within a project, helping teams organize their work into meaningful sections such as phases, categories, or deliverables. Each task list belongs to a specific project and can include multiple tasks that are typically aligned with a common goal. Task lists can be associated with milestones, and they support privacy settings that control who can view or interact with the tasks they contain. This structure helps teams manage progress, assign responsibilities, and maintain clarity across complex projects.
Parameters | Type | Description |
---|---|---|
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter tasklists by name. |
This tool is read-only. It does not modify its environment.
twprojects-list_tasklists_by_project
List tasklists in Teamwork.com by project. In the context of Teamwork.com, a task list is a way to group related tasks within a project, helping teams organize their work into meaningful sections such as phases, categories, or deliverables. Each task list belongs to a specific project and can include multiple tasks that are typically aligned with a common goal. Task lists can be associated with milestones, and they support privacy settings that control who can view or interact with the tasks they contain. This structure helps teams manage progress, assign responsibilities, and maintain clarity across complex projects.
Parameters | Type | Description |
---|---|---|
project_id | integer | The ID of the project from which to retrieve tasklists. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter tasklists by name. |
This tool is read-only. It does not modify its environment.
twprojects-list_tasks
List tasks in Teamwork.com. In Teamwork.com, a task represents an individual unit of work assigned to one or more team members within a project. Each task can include details such as a title, description, priority, estimated time, assignees, and due date, along with the ability to attach files, leave comments, track time, and set dependencies on other tasks. Tasks are organized within task lists, helping structure and sequence work logically. They serve as the building blocks of project management in Teamwork, allowing teams to collaborate, monitor progress, and ensure accountability throughout the project's lifecycle.
Parameters | Type | Description |
---|---|---|
assignee_user_ids | array optional | A list of user IDs to filter tasks by assigned users |
match_all_tags | boolean optional | If true, the search will match tasks that have all the specified tags. If false, the search will match tasks that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter tasks by name. |
tag_ids | array optional | A list of tag IDs to filter tasks by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_tasks_by_project
List tasks in Teamwork.com by project. In Teamwork.com, a task represents an individual unit of work assigned to one or more team members within a project. Each task can include details such as a title, description, priority, estimated time, assignees, and due date, along with the ability to attach files, leave comments, track time, and set dependencies on other tasks. Tasks are organized within task lists, helping structure and sequence work logically. They serve as the building blocks of project management in Teamwork, allowing teams to collaborate, monitor progress, and ensure accountability throughout the project's lifecycle.
Parameters | Type | Description |
---|---|---|
project_id | integer | The ID of the project from which to retrieve tasks. |
assignee_user_ids | array optional | A list of user IDs to filter tasks by assigned users |
match_all_tags | boolean optional | If true, the search will match tasks that have all the specified tags. If false, the search will match tasks that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter tasks by name. |
tag_ids | array optional | A list of tag IDs to filter tasks by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_tasks_by_tasklist
List tasks in Teamwork.com by tasklist. In Teamwork.com, a task represents an individual unit of work assigned to one or more team members within a project. Each task can include details such as a title, description, priority, estimated time, assignees, and due date, along with the ability to attach files, leave comments, track time, and set dependencies on other tasks. Tasks are organized within task lists, helping structure and sequence work logically. They serve as the building blocks of project management in Teamwork, allowing teams to collaborate, monitor progress, and ensure accountability throughout the project's lifecycle.
Parameters | Type | Description |
---|---|---|
tasklist_id | integer | The ID of the tasklist from which to retrieve tasks. |
assignee_user_ids | array optional | A list of user IDs to filter tasks by assigned users |
match_all_tags | boolean optional | If true, the search will match tasks that have all the specified tags. If false, the search will match tasks that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter tasks by name. |
tag_ids | array optional | A list of tag IDs to filter tasks by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_teams
List teams in Teamwork.com. In the context of Teamwork.com, a team is a group of users who are organized together to collaborate more efficiently on projects and tasks. Teams help structure work by grouping individuals with similar roles, responsibilities, or departmental functions, making it easier to assign work, track progress, and manage communication. By using teams, organizations can streamline project planning and ensure the right people are involved in the right parts of a project, enhancing clarity and accountability across the platform.
Parameters | Type | Description |
---|---|---|
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter teams by name or handle. |
This tool is read-only. It does not modify its environment.
twprojects-list_teams_by_company
List teams in Teamwork.com by client/company. In the context of Teamwork.com, a team is a group of users who are organized together to collaborate more efficiently on projects and tasks. Teams help structure work by grouping individuals with similar roles, responsibilities, or departmental functions, making it easier to assign work, track progress, and manage communication. By using teams, organizations can streamline project planning and ensure the right people are involved in the right parts of a project, enhancing clarity and accountability across the platform.
Parameters | Type | Description |
---|---|---|
company_id | integer | The ID of the company from which to retrieve teams. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter teams by name or handle. |
This tool is read-only. It does not modify its environment.
twprojects-list_teams_by_project
List teams in Teamwork.com by project. In the context of Teamwork.com, a team is a group of users who are organized together to collaborate more efficiently on projects and tasks. Teams help structure work by grouping individuals with similar roles, responsibilities, or departmental functions, making it easier to assign work, track progress, and manage communication. By using teams, organizations can streamline project planning and ensure the right people are involved in the right parts of a project, enhancing clarity and accountability across the platform.
Parameters | Type | Description |
---|---|---|
project_id | integer | The ID of the project from which to retrieve teams. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter teams by name or handle. |
This tool is read-only. It does not modify its environment.
twprojects-list_timelogs
List timelogs in Teamwork.com. Timelog refers to a recorded entry that tracks the amount of time a person has spent working on a specific task, project, or piece of work. These entries typically include details such as the duration of time worked, the date and time it was logged, who logged it, and any optional notes describing what was done during that period. Timelogs are essential for understanding how time is being allocated across projects, enabling teams to manage resources more effectively, invoice clients accurately, and assess productivity. They can be created manually or with timers, and are often used for reporting and billing purposes.
Parameters | Type | Description |
---|---|---|
assigned_company_ids | array optional | A list of company IDs to filter timelogs by assigned companies |
assigned_team_ids | array optional | A list of team IDs to filter timelogs by assigned teams |
assigned_user_ids | array optional | A list of user IDs to filter timelogs by assigned users |
end_date | string optional | End date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
match_all_tags | boolean optional | If true, the search will match timelogs that have all the specified tags. If false, the search will match timelogs that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
start_date | string optional | Start date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
tag_ids | array optional | A list of tag IDs to filter timelogs by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_timelogs_by_project
List timelogs in Teamwork.com by project. Timelog refers to a recorded entry that tracks the amount of time a person has spent working on a specific task, project, or piece of work. These entries typically include details such as the duration of time worked, the date and time it was logged, who logged it, and any optional notes describing what was done during that period. Timelogs are essential for understanding how time is being allocated across projects, enabling teams to manage resources more effectively, invoice clients accurately, and assess productivity. They can be created manually or with timers, and are often used for reporting and billing purposes.
Parameters | Type | Description |
---|---|---|
project_id | integer | The ID of the project from which to retrieve timelogs. |
assigned_company_ids | array optional | A list of company IDs to filter timelogs by assigned companies |
assigned_team_ids | array optional | A list of team IDs to filter timelogs by assigned teams |
assigned_user_ids | array optional | A list of user IDs to filter timelogs by assigned users |
end_date | string optional | End date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
match_all_tags | boolean optional | If true, the search will match timelogs that have all the specified tags. If false, the search will match timelogs that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
start_date | string optional | Start date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
tag_ids | array optional | A list of tag IDs to filter timelogs by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_timelogs_by_task
List timelogs in Teamwork.com by task. Timelog refers to a recorded entry that tracks the amount of time a person has spent working on a specific task, project, or piece of work. These entries typically include details such as the duration of time worked, the date and time it was logged, who logged it, and any optional notes describing what was done during that period. Timelogs are essential for understanding how time is being allocated across projects, enabling teams to manage resources more effectively, invoice clients accurately, and assess productivity. They can be created manually or with timers, and are often used for reporting and billing purposes.
Parameters | Type | Description |
---|---|---|
task_id | integer | The ID of the task from which to retrieve timelogs. |
assigned_company_ids | array optional | A list of company IDs to filter timelogs by assigned companies |
assigned_team_ids | array optional | A list of team IDs to filter timelogs by assigned teams |
assigned_user_ids | array optional | A list of user IDs to filter timelogs by assigned users |
end_date | string optional | End date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
match_all_tags | boolean optional | If true, the search will match timelogs that have all the specified tags. If false, the search will match timelogs that have any of the specified tags. Defaults to false. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
start_date | string optional | Start date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. |
tag_ids | array optional | A list of tag IDs to filter timelogs by tags |
This tool is read-only. It does not modify its environment.
twprojects-list_timers
List timers in Teamwork.com. Timer is a built-in tool that allows users to accurately track the time they spend working on specific tasks, projects, or client work. Instead of manually recording hours, users can start, pause, and stop timers directly within the platform or through the desktop and mobile apps, ensuring precise time logs without interrupting their workflow. Once recorded, these entries are automatically linked to the relevant task or project, making it easier to monitor productivity, manage billable hours, and generate detailed reports for both internal tracking and client invoicing.
Parameters | Type | Description |
---|---|---|
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
project_id | integer optional | The ID of the project to filter timers by. Only timers associated with this project will be returned. |
running_timers_only | boolean optional | If true, only running timers will be returned. Defaults to false, which returns all timers. |
task_id | integer optional | The ID of the task to filter timers by. Only timers associated with this task will be returned. |
user_id | integer optional | The ID of the user to filter timers by. Only timers associated with this user will be returned. |
This tool is read-only. It does not modify its environment.
twprojects-list_users
List users in Teamwork.com. A user is an individual who has access to one or more projects within a Teamwork site, typically as a team member, collaborator, or administrator. Users can be assigned tasks, participate in discussions, log time, share files, and interact with other members depending on their permission levels. Each user has a unique profile that defines their role, visibility, and access to features and project data. Users can belong to clients/companies or teams within the system, and their permissions can be customized to control what actions they can perform or what information they can see.
Parameters | Type | Description |
---|---|---|
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter users by first or last names, or e-mail. The user will be selected if each word of the term matches the first or last name, or e-mail, not requiring that the word matches are in the same field. |
type | integer optional | Type of user to filter by. The available options are account, collaborator or contact. |
This tool is read-only. It does not modify its environment.
twprojects-list_users_by_project
List users in Teamwork.com by project. A user is an individual who has access to one or more projects within a Teamwork site, typically as a team member, collaborator, or administrator. Users can be assigned tasks, participate in discussions, log time, share files, and interact with other members depending on their permission levels. Each user has a unique profile that defines their role, visibility, and access to features and project data. Users can belong to clients/companies or teams within the system, and their permissions can be customized to control what actions they can perform or what information they can see.
Parameters | Type | Description |
---|---|---|
project_id | integer | The ID of the project from which to retrieve users. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
search_term | string optional | A search term to filter users by first or last names, or e-mail. The user will be selected if each word of the term matches the first or last name, or e-mail, not requiring that the word matches are in the same field. |
type | integer optional | Type of user to filter by. The available options are account, collaborator or contact. |
This tool is read-only. It does not modify its environment.
twprojects-pause_timer
Pause an existing timer in Teamwork.com. Timer is a built-in tool that allows users to accurately track the time they spend working on specific tasks, projects, or client work. Instead of manually recording hours, users can start, pause, and stop timers directly within the platform or through the desktop and mobile apps, ensuring precise time logs without interrupting their workflow. Once recorded, these entries are automatically linked to the relevant task or project, making it easier to monitor productivity, manage billable hours, and generate detailed reports for both internal tracking and client invoicing.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the timer to pause. |
twprojects-resume_timer
Resume an existing timer in Teamwork.com. Timer is a built-in tool that allows users to accurately track the time they spend working on specific tasks, projects, or client work. Instead of manually recording hours, users can start, pause, and stop timers directly within the platform or through the desktop and mobile apps, ensuring precise time logs without interrupting their workflow. Once recorded, these entries are automatically linked to the relevant task or project, making it easier to monitor productivity, manage billable hours, and generate detailed reports for both internal tracking and client invoicing.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the timer to resume. |
twprojects-update_comment
Update an existing comment in Teamwork.com. In the Teamwork.com context, a comment is a way for users to communicate and collaborate directly within tasks, milestones, files, or other project items. Comments allow team members to provide updates, ask questions, give feedback, or share relevant information in a centralized and contextual manner. They support rich text formatting, file attachments, and @mentions to notify specific users or teams, helping keep discussions organized and easily accessible within the project. Comments are visible to all users with access to the item, promoting transparency and keeping everyone aligned.
Parameters | Type | Description |
---|---|---|
body | string | The content of the comment. The content can be added as text or HTML. |
id | integer | The ID of the comment to update. |
content_type | string optional | The content type of the comment. It can be either 'TEXT' or 'HTML'. |
twprojects-update_company
Update an existing company in Teamwork.com. In the context of Teamwork.com, a company represents an organization or business entity that can be associated with users, projects, and tasks within the platform, and it is often referred to as a “client.” It serves as a way to group related users and projects under a single organizational umbrella, making it easier to manage permissions, assign responsibilities, and organize work. Companies (or clients) are frequently used to distinguish between internal teams and external collaborators, enabling teams to work efficiently while maintaining clear boundaries around ownership, visibility, and access levels across different projects.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the company to update. |
address_one | string optional | The first line of the address of the company. |
address_two | string optional | The second line of the address of the company. |
city | string optional | The city of the company. |
country_code | string optional | The country code of the company, e.g., 'US' for the United States. |
email_one | string optional | The primary email address of the company. |
email_three | string optional | The tertiary email address of the company. |
email_two | string optional | The secondary email address of the company. |
fax | string optional | The fax number of the company. |
industry_id | integer optional | The ID of the industry the company belongs to. |
manager_id | integer optional | The ID of the user who manages the company. |
name | string optional | The name of the company. |
phone | string optional | The phone number of the company. |
profile | string optional | A profile description for the company. |
state | string optional | The state of the company. |
tag_ids | array optional | A list of tag IDs to associate with the company. |
website | string optional | The website of the company. |
zip | string optional | The ZIP or postal code of the company. |
twprojects-update_milestone
Update an existing milestone in Teamwork.com. In the context of Teamwork.com, a milestone represents a significant point or goal within a project that marks the completion of a major phase or a key deliverable. It acts as a high-level indicator of progress, helping teams track whether work is advancing according to plan. Milestones are typically used to coordinate efforts across different tasks and task lists, providing a clear deadline or objective that multiple team members or departments can align around. They don't contain individual tasks themselves but serve as checkpoints to ensure the project is moving in the right direction.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the milestone to update. |
assignees | object optional | An object containing assignees for the milestone. |
description | string optional | A description of the milestone. |
due_date | string optional | The due date of the milestone in the format YYYYMMDD. This date will be used in all tasks without a due date related to this milestone. |
name | string optional | The name of the milestone. |
tag_ids | array optional | A list of tag IDs to associate with the milestone. |
tasklist_ids | array optional | A list of tasklist IDs to associate with the milestone. |
twprojects-update_notebook
Update an existing notebook in Teamwork.com. Notebook is a space where teams can create, share, and organize written content in a structured way. It’s commonly used for documenting processes, storing meeting notes, capturing research, or drafting ideas that need to be revisited and refined over time. Unlike quick messages or task comments, notebooks provide a more permanent and organized format that can be easily searched and referenced, helping teams maintain a centralized source of knowledge and ensuring important information remains accessible to everyone who needs it.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the notebook to update. |
contents | string optional | The contents of the notebook. |
description | string optional | A description of the notebook. |
name | string optional | The name of the notebook. |
tag_ids | array optional | A list of tag IDs to associate with the notebook. |
type | string optional | The type of the notebook. Valid values are 'MARKDOWN' and 'HTML'. |
twprojects-update_project
Update an existing project in Teamwork.com. The project feature in Teamwork.com serves as the central workspace for organizing and managing a specific piece of work or initiative. Each project provides a dedicated area where teams can plan tasks, assign responsibilities, set deadlines, and track progress toward shared goals. Projects include tools for communication, file sharing, milestones, and time tracking, allowing teams to stay aligned and informed throughout the entire lifecycle of the work. Whether it's a product launch, client engagement, or internal initiative, projects in Teamwork.com help teams structure their efforts, collaborate more effectively, and deliver results with greater visibility and accountability.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the project to update. |
company_id | integer optional | The ID of the company associated with the project. |
description | string optional | The description of the project. |
end_at | string optional | The end date of the project in the format YYYYMMDD. |
name | string optional | The name of the project. |
owned_id | integer optional | The ID of the user who owns the project. |
start_at | string optional | The start date of the project in the format YYYYMMDD. |
tag_ids | array optional | A list of tag IDs to associate with the project. |
twprojects-update_tag
Update an existing tag in Teamwork.com. In the context of Teamwork.com, a tag is a customizable label that can be applied to various items such as tasks, projects, milestones, messages, and more, to help categorize and organize work efficiently. Tags provide a flexible way to filter, search, and group related items across the platform, making it easier for teams to manage complex workflows, highlight priorities, or track themes and statuses. Since tags are user-defined, they adapt to each team’s specific needs and can be color-coded for better visual clarity.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the tag to update. |
name | string optional | The name of the tag. It must have less than 50 characters. |
project_id | integer optional | The ID of the project to associate the tag with. This is for project-scoped tags. |
twprojects-update_task
Update an existing task in Teamwork.com. In Teamwork.com, a task represents an individual unit of work assigned to one or more team members within a project. Each task can include details such as a title, description, priority, estimated time, assignees, and due date, along with the ability to attach files, leave comments, track time, and set dependencies on other tasks. Tasks are organized within task lists, helping structure and sequence work logically. They serve as the building blocks of project management in Teamwork, allowing teams to collaborate, monitor progress, and ensure accountability throughout the project's lifecycle.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the task to update. |
assignees | object optional | An object containing assignees for the task. |
description | string optional | The description of the task. |
due_date | string optional | The due date of the task in ISO 8601 format (YYYY-MM-DD). When this is not provided, it will fallback to the milestone due date if a milestone is set. |
estimated_minutes | integer optional | The estimated time to complete the task in minutes. |
parent_task_id | integer optional | The ID of the parent task if creating a subtask. |
predecessors | array optional | List of task dependencies that must be completed before this task can start, defining its position in the project workflow and ensuring proper sequencing of work. |
priority | string optional | The priority of the task. Possible values are: low, medium, high. |
progress | integer optional | The progress of the task, as a percentage (0-100). Only whole numbers are allowed. |
start_date | string optional | The start date of the task in ISO 8601 format (YYYY-MM-DD). |
tag_ids | array optional | A list of tag IDs to assign to the task. |
tasklist_id | integer optional | The ID of the tasklist. |
twprojects-update_tasklist
Update an existing tasklist in Teamwork.com. In the context of Teamwork.com, a task list is a way to group related tasks within a project, helping teams organize their work into meaningful sections such as phases, categories, or deliverables. Each task list belongs to a specific project and can include multiple tasks that are typically aligned with a common goal. Task lists can be associated with milestones, and they support privacy settings that control who can view or interact with the tasks they contain. This structure helps teams manage progress, assign responsibilities, and maintain clarity across complex projects.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the tasklist to update. |
description | string optional | The description of the tasklist. |
milestone_id | integer optional | The ID of the milestone to associate with the tasklist. |
name | string optional | The name of the tasklist. |
twprojects-update_team
Update an existing team in Teamwork.com. In the context of Teamwork.com, a team is a group of users who are organized together to collaborate more efficiently on projects and tasks. Teams help structure work by grouping individuals with similar roles, responsibilities, or departmental functions, making it easier to assign work, track progress, and manage communication. By using teams, organizations can streamline project planning and ensure the right people are involved in the right parts of a project, enhancing clarity and accountability across the platform.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the team to update. |
company_id | integer optional | The ID of the company. This is used to create a team scoped for a specific company. |
description | string optional | The description of the team. |
handle | string optional | The handle of the team. It is a unique identifier for the team. It must not have spaces or special characters. |
name | string optional | The name of the team. |
parent_team_id | integer optional | The ID of the parent team. This is used to create a hierarchy of teams. |
project_id | integer optional | The ID of the project. This is used to create a team scoped for a specific project. |
user_ids | array optional | A list of user IDs to add to the team. |
twprojects-update_timelog
Update an existing timelog in Teamwork.com. Timelog refers to a recorded entry that tracks the amount of time a person has spent working on a specific task, project, or piece of work. These entries typically include details such as the duration of time worked, the date and time it was logged, who logged it, and any optional notes describing what was done during that period. Timelogs are essential for understanding how time is being allocated across projects, enabling teams to manage resources more effectively, invoice clients accurately, and assess productivity. They can be created manually or with timers, and are often used for reporting and billing purposes.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the timelog to update. |
billable | boolean optional | If true, the timelog is billable. Defaults to false. |
date | string optional | The date of the timelog in the format YYYY-MM-DD. |
description | string optional | A description of the timelog. |
hours | integer optional | The number of hours spent on the timelog. Must be a positive integer. |
is_utc | boolean optional | If true, the time is in UTC. Defaults to false. |
minutes | integer optional | The number of minutes spent on the timelog. Must be a positive integer less than 60, otherwise the hours attribute should be incremented. |
project_id | integer optional | The ID of the project to associate the timelog with. Either project_id or task_id must be provided, but not both. |
tag_ids | array optional | A list of tag IDs to associate with the timelog. |
task_id | integer optional | The ID of the task to associate the timelog with. Either project_id or task_id must be provided, but not both. |
time | string optional | The time of the timelog in the format HH:MM:SS. |
user_id | integer optional | The ID of the user to associate the timelog with. Defaults to the authenticated user if not provided. |
twprojects-update_timer
Update an existing timer in Teamwork.com. Timer is a built-in tool that allows users to accurately track the time they spend working on specific tasks, projects, or client work. Instead of manually recording hours, users can start, pause, and stop timers directly within the platform or through the desktop and mobile apps, ensuring precise time logs without interrupting their workflow. Once recorded, these entries are automatically linked to the relevant task or project, making it easier to monitor productivity, manage billable hours, and generate detailed reports for both internal tracking and client invoicing.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the timer to update. |
billable | boolean optional | If true, the timer is billable. |
description | string optional | A description of the timer. |
project_id | integer optional | The ID of the project to associate the timer with. |
running | boolean optional | If true, the timer will start running immediately. |
task_id | integer optional | The ID of the task to associate the timer with. |
twprojects-update_user
Update an existing user in Teamwork.com. A user is an individual who has access to one or more projects within a Teamwork site, typically as a team member, collaborator, or administrator. Users can be assigned tasks, participate in discussions, log time, share files, and interact with other members depending on their permission levels. Each user has a unique profile that defines their role, visibility, and access to features and project data. Users can belong to clients/companies or teams within the system, and their permissions can be customized to control what actions they can perform or what information they can see.
Parameters | Type | Description |
---|---|---|
id | integer | The ID of the user to update. |
admin | boolean optional | Indicates whether the user is an administrator. |
company_id | integer optional | The ID of the client/company to which the user belongs. |
email | string optional | The email address of the user. |
first_name | string optional | The first name of the user. |
last_name | string optional | The last name of the user. |
title | string optional | The job title of the user, such as 'Project Manager' or 'Senior Software Developer'. |
type | string optional | The type of user, such as 'account', 'collaborator', or 'contact'. |
twprojects-users_workload
Get the workload of users in Teamwork.com. Workload is a visual representation of how tasks are distributed across team members, helping you understand who is overloaded, who has capacity, and how work is balanced within a project or across multiple projects. It takes into account assigned tasks, due dates, estimated time, and working hours to give managers and teams a clear picture of availability and resource allocation. By providing this insight, workload makes it easier to plan effectively, prevent burnout, and ensure that deadlines are met without placing too much pressure on any single person.
Parameters | Type | Description |
---|---|---|
end_date | string | The end date of the workload period. The date must be in the format YYYY-MM-DD. |
start_date | string | The start date of the workload period. The date must be in the format YYYY-MM-DD. |
page | integer optional | Page number for pagination of results. |
page_size | integer optional | Number of results per page for pagination. |
project_ids | array optional | List of project IDs to filter the workload by. |
user_company_ids | array optional | List of users' client/company IDs to filter the workload by. |
user_ids | array optional | List of user IDs to filter the workload by. |
user_team_ids | array optional | List of users' team IDs to filter the workload by. |
This tool is read-only. It does not modify its environment.
{
"mcpServers": {
"teamwork": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"TW_MCP_BEARER_TOKEN",
"mcp/teamwork"
],
"env": {
"TW_MCP_BEARER_TOKEN": "<TW_MCP_BEARER_TOKEN>"
}
}
}
}
Manual installation
You can install the MCP server using:
Installation for