Server Details
The Teamwork.com official MCP server helps teams efficiently manage client projects with AI.
- Status
- Healthy
- Last Tested
- Transport
- Streamable HTTP
- URL
- Repository
- Teamwork/mcp
- GitHub Stars
- 17
- Server Listing
- Teamwork
See and control every tool call
Tool Definition Quality
Score is being calculated. Check back soon.
Available Tools
121 toolstwdesk-create_companyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | The kind of the company. | |
| name | Yes | The name of the company. | |
| note | No | The note for the company. | |
| details | No | The details of the company. | |
| domains | No | The domains for the company. | |
| website | No | The website of the company. | |
| industry | No | The industry of the company. | |
| permission | No | The permission level of the company. | |
| description | No | The description of the company. |
twdesk-create_customerInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| No | The email of the customer. | ||
| notes | No | The notes of the customer. | |
| phone | No | The phone number of the customer. | |
| mobile | No | The mobile number of the customer. | |
| address | No | The address of the customer. | |
| jobTitle | No | The job title of the customer. | |
| lastName | No | The last name of the customer. | |
| extraData | No | The extra data of the customer. | |
| firstName | No | The first name of the customer. | |
| facebookURL | No | The Facebook URL of the customer. | |
| linkedinURL | No | The LinkedIn URL of the customer. | |
| organization | No | The organization of the customer. | |
| twitterHandle | No | The Twitter handle of the customer. |
twdesk-create_fileInspect
Upload a new file to Teamwork Desk, enabling attachment to tickets, articles, or other resources.
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | The content of the file as a base64-encoded string. | |
| name | Yes | The name of the file. | |
| mimeType | Yes | The MIME type of the file. | |
| disposition | No | The disposition of the file. |
twdesk-create_messageInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| cc | No | An array of email addresses to CC on message reply. | |
| bcc | No | An array of email addresses to BCC on message reply. | |
| body | Yes | The body of the message. | |
| ticketID | Yes | The ID of the ticket that the message will be sent to. |
twdesk-create_priorityInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the priority. | |
| color | No | The color of the priority. |
twdesk-create_statusInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the status. | |
| color | No | The color of the status. | |
| displayOrder | No | The display order of the status. |
twdesk-create_tagInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the tag. | |
| color | No | The color of the tag. |
twdesk-create_ticketInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| cc | No | An array of email addresses to CC on ticket creation. | |
| bcc | No | An array of email addresses to BCC on ticket creation. | |
| body | Yes | The body of the ticket. | |
| tags | No | An array of tag IDs to associate with the ticket. Tag IDs can be found by using the 'twdesk-list_tags' tool. | |
| files | No | An array of file IDs to attach to the ticket. Use the 'twdesk-create_file' tool to upload files. | |
| typeId | No | The type ID of the ticket. Use the 'twdesk-list_types' tool to find valid IDs. | |
| agentId | No | The agent ID that the ticket should be assigned to. Use the 'twdesk-list_agents' tool to find valid IDs. | |
| inboxId | Yes | The inbox ID of the ticket. Use the 'twdesk-list_inboxes' tool to find valid IDs. | |
| subject | Yes | The subject of the ticket. | |
| statusId | No | The status of the ticket. Use the 'twdesk-list_statuses' tool to find valid IDs. | |
| customerId | No | The customer ID of the ticket. Use the 'twdesk-list_customers' tool to find valid IDs. | |
| priorityId | No | The priority of the ticket. Use the 'twdesk-list_priorities' tool to find valid IDs. | |
| customerEmail | No | 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. | |
| notifyCustomer | No | Set to true if the the customer should be sent a copy of the ticket. |
twdesk-create_typeInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the type. | |
| displayOrder | No | The display order of the type. | |
| enabledForFutureInboxes | No | Whether the type is enabled for future inboxes. |
twdesk-get_companyRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the company to retrieve. |
twdesk-get_customerRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the customer to retrieve. |
twdesk-get_inboxRead-onlyInspect
Retrieve detailed information about a specific inbox in Teamwork Desk by its ID
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the inbox to retrieve. |
twdesk-get_priorityRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the priority to retrieve. |
twdesk-get_statusRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the status to retrieve. |
twdesk-get_tagRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the tag to retrieve. |
twdesk-get_ticketRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the ticket to retrieve. |
twdesk-get_typeRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the type to retrieve. |
twdesk-get_userRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the user to retrieve. |
twdesk-list_companiesRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | The kind of the company to filter by. | |
| name | No | The name of the company to filter by. | |
| page | No | The page number to retrieve. | |
| domains | No | The domains of the company to filter by. | |
| orderBy | No | The field to order the results by. | |
| pageSize | No | The number of results to retrieve per page. | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-list_customersRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number to retrieve. | |
| emails | No | The emails of the customers to filter by. | |
| orderBy | No | The field to order the results by. | |
| pageSize | No | The number of results to retrieve per page. | |
| companyIDs | No | The IDs of the companies to filter by. | |
| companyNames | No | The names of the companies to filter by. | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-list_inboxesRead-onlyInspect
List all inboxes in Teamwork Desk, with optional filters for name and email.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The name of the inbox to filter by. | |
| page | No | The page number to retrieve. | |
| No | The email of the inbox to filter by. | ||
| orderBy | No | The field to order the results by. | |
| pageSize | No | The number of results to retrieve per page. | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-list_prioritiesRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The name of the priority to filter by. | |
| page | No | The page number to retrieve. | |
| color | No | The color of the priority to filter by. | |
| orderBy | No | The field to order the results by. | |
| pageSize | No | The number of results to retrieve per page. | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-list_statusesRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | The code of the status to filter by. | |
| name | No | The name of the status to filter by. | |
| page | No | The page number to retrieve. | |
| color | No | The color of the status to filter by. | |
| orderBy | No | The field to order the results by. | |
| pageSize | No | The number of results to retrieve per page. | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-list_tagsRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The name of the tag to filter by. | |
| page | No | The page number to retrieve. | |
| color | No | The color of the tag to filter by. | |
| orderBy | No | The field to order the results by. | |
| inboxIDs | No | The IDs of the inboxes to filter by. | |
| pageSize | No | The number of results to retrieve per page. | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-list_ticketsRead-onlyInspect
List all tickets in Teamwork Desk, with extensive filters for inbox, customer, company, tag, status, priority, SLA, user, and more. Enables users to audit, analyze, or synchronize ticket data for support management, reporting, or integration scenarios.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number to retrieve. | |
| shared | No | Find tickets shared with me outside of inboxes I have access to | |
| slaIDs | No | The IDs of the SLAs to filter by. SLA IDs can be found by using the 'twdesk-list_slas' tool. | |
| tagIDs | No | The IDs of the tags to filter by. Tag IDs can be found by using the 'twdesk-list_tags' tool. | |
| orderBy | No | The field to order the results by. | |
| taskIDs | No | The IDs of the tasks to filter by. Task IDs can be found by using the 'twprojects-list_tasks' tool. | |
| userIDs | No | The IDs of the users to filter by. User IDs can be found by using the 'twdesk-list_users' tool. | |
| inboxIDs | No | The IDs of the inboxes to filter by. Inbox IDs can be found by using the 'twdesk-list_inboxes' tool. | |
| pageSize | No | The number of results to retrieve per page. | |
| statusIDs | No | The IDs of the statuses to filter by. Status IDs can be found by using the 'twdesk-list_statuses' tool. | |
| companyIDs | No | The IDs of the companies to filter by. Company IDs can be found by using the 'twdesk-list_companies' tool. | |
| customerIDs | No | The IDs of the customers to filter by. Customer IDs can be found by using the 'twdesk-list_customers' tool. | |
| priorityIDs | No | The IDs of the priorities to filter by. Priority IDs can be found by using the 'twdesk-list_priorities' tool. | |
| projectsIDs | No | The IDs of the projects to filter by. Project IDs can be found by using the 'twprojects-list_projects' tool. | |
| slaBreached | No | Find tickets where the SLA has been breached | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-list_typesRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The name of the type to filter by. | |
| page | No | The page number to retrieve. | |
| orderBy | No | The field to order the results by. | |
| inboxIDs | No | The inbox IDs of the type to filter by. | |
| pageSize | No | The number of results to retrieve per page. | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-list_usersRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number to retrieve. | |
| No | The email addresses of the users to filter by. | ||
| orderBy | No | The field to order the results by. | |
| inboxIDs | No | The IDs of the inboxes to filter by. | |
| lastName | No | The last names of the users to filter by. | |
| pageSize | No | The number of results to retrieve per page. | |
| firstName | No | The first names of the users to filter by. | |
| isPartTime | No | Whether to include part-time users in the results. | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-search_ticketsRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | The page number to retrieve. | |
| search | Yes | The search term to use for finding tickets. This can be part of the subject, body, or other ticket fields. | |
| shared | No | Find tickets shared with me outside of inboxes I have access to | |
| tagIDs | No | The IDs of the tags to filter by. Tag IDs can be found by using the 'twdesk-list_tags' tool. | |
| orderBy | No | The field to order the results by. | |
| userIDs | No | The IDs of the users to filter by. User IDs can be found by using the 'twdesk-list_users' tool. | |
| inboxIDs | No | The IDs of the inboxes to filter by. Inbox IDs can be found by using the 'twdesk-list_inboxes' tool. | |
| pageSize | No | The number of results to retrieve per page. | |
| statusIDs | No | The IDs of the statuses to filter by. Status IDs can be found by using the 'twdesk-list_statuses' tool. | |
| companyIDs | No | The IDs of the companies to filter by. Company IDs can be found by using the 'twdesk-list_companies' tool. | |
| customerIDs | No | The IDs of the customers to filter by. Customer IDs can be found by using the 'twdesk-list_customers' tool. | |
| priorityIDs | No | The IDs of the priorities to filter by. Priority IDs can be found by using the 'twdesk-list_priorities' tool. | |
| slaBreached | No | Find tickets where the SLA has been breached | |
| orderDirection | No | The direction to order the results by (asc, desc). |
twdesk-update_companyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the company to update. | |
| kind | No | The new kind of the company. | |
| name | No | The new name of the company. | |
| note | No | The new note for the company. | |
| details | No | The new details of the company. | |
| domains | No | The new domains for the company. | |
| website | No | The new website of the company. | |
| industry | No | The new industry of the company. | |
| permission | No | The new permission level of the company. | |
| description | No | The new description of the company. |
twdesk-update_customerInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the customer to update. | |
| No | The new email of the customer. | ||
| notes | No | The new notes of the customer. | |
| phone | No | The new phone number of the customer. | |
| mobile | No | The new mobile number of the customer. | |
| address | No | The new address of the customer. | |
| jobTitle | No | The new job title of the customer. | |
| lastName | No | The new last name of the customer. | |
| extraData | No | The new extra data of the customer. | |
| firstName | No | The new first name of the customer. | |
| facebookURL | No | The new Facebook URL of the customer. | |
| linkedinURL | No | The new LinkedIn URL of the customer. | |
| organization | No | The new organization of the customer. | |
| twitterHandle | No | The new Twitter handle of the customer. |
twdesk-update_priorityInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the priority to update. | |
| name | No | The new name of the priority. | |
| color | No | The color of the priority. |
twdesk-update_statusInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the status to update. | |
| name | No | The new name of the status. | |
| color | No | The color of the status. | |
| displayOrder | No | The display order of the status. |
twdesk-update_tagInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the tag to update. | |
| name | No | The new name of the tag. | |
| color | No | The color of the tag. |
twdesk-update_ticketInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| cc | No | An array of email addresses to CC on ticket update. | |
| id | Yes | The ID of the ticket to update. | |
| bcc | No | An array of email addresses to BCC on ticket update. | |
| body | No | The body of the ticket. | |
| typeId | No | The type ID of the ticket. Use the 'twdesk-list_types' tool to find valid IDs. | |
| agentId | No | The agent ID that the ticket should be assigned to. Use the 'twdesk-list_agents' tool to find valid IDs. | |
| subject | No | The subject of the ticket. | |
| statusId | No | The status of the ticket. Use the 'twdesk-list_statuses' tool to find valid IDs. | |
| priorityId | No | The priority of the ticket. Use the 'twdesk-list_priorities' tool to find valid IDs. |
twdesk-update_typeInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the type to update. | |
| name | No | The new name of the type. | |
| displayOrder | No | The display order of the type. | |
| enabledForFutureInboxes | No | Whether the type is enabled for future inboxes. |
twprojects-add_project_memberInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| user_ids | No | A list of user IDs to add to the project. | |
| project_id | Yes | The ID of the project to add the member to. |
twprojects-complete_timerInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the timer to complete. |
twprojects-create_commentInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The content of the comment. The content can be added as text or HTML. | |
| object | Yes | The object to create the comment for. It can be a tasks, milestones, files or notebooks. | |
| content_type | No | The content type of the comment. It can be either 'TEXT' or 'HTML'. |
twprojects-create_companyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fax | No | The fax number of the company. | |
| zip | No | The ZIP or postal code of the company. | |
| city | No | The city of the company. | |
| name | Yes | The name of the company. | |
| phone | No | The phone number of the company. | |
| state | No | The state of the company. | |
| profile | No | A profile description for the company. | |
| tag_ids | No | A list of tag IDs to associate with the company. | |
| website | No | The website of the company. | |
| email_one | No | The primary email address of the company. | |
| email_two | No | The secondary email address of the company. | |
| manager_id | No | The ID of the user who manages the company. | |
| address_one | No | The first line of the address of the company. | |
| address_two | No | The second line of the address of the company. | |
| email_three | No | The tertiary email address of the company. | |
| industry_id | No | The ID of the industry the company belongs to. | |
| country_code | No | The country code of the company, e.g., 'US' for the United States. |
twprojects-create_jobroleInspect
Create a new job role in Teamwork.com. Job role defines a user's primary function or position within the organization, such as developer, designer, project manager, or account manager. It provides high-level context about what a person is generally responsible for, helping teams understand who does what across projects and departments. Job roles are commonly used in resource planning, capacity forecasting, and reporting, allowing managers to group work by role, plan future demand more accurately, and ensure the right mix of roles is available to deliver projects efficiently.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the job role. |
twprojects-create_milestoneInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the milestone. | |
| tag_ids | No | A list of tag IDs to associate with the milestone. | |
| due_date | Yes | 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. | |
| assignees | Yes | An object containing assignees for the milestone. MUST contain at least one of: user_ids, company_ids or team_ids with non-empty arrays. | |
| project_id | Yes | The ID of the project to create the milestone in. | |
| description | No | A description of the milestone. | |
| tasklist_ids | No | A list of tasklist IDs to associate with the milestone. |
twprojects-create_notebookInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the notebook. | |
| type | Yes | The type of the notebook. Valid values are 'MARKDOWN' and 'HTML'. | |
| tag_ids | No | A list of tag IDs to associate with the notebook. | |
| contents | Yes | The contents of the notebook. | |
| project_id | Yes | The ID of the project to create the notebook in. | |
| description | No | A description of the notebook. |
twprojects-create_projectInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the project. | |
| end_at | No | The end date of the project in the format YYYYMMDD. | |
| tag_ids | No | A list of tag IDs to associate with the project. | |
| owned_id | No | The ID of the user who owns the project. | |
| start_at | No | The start date of the project in the format YYYYMMDD. | |
| company_id | No | The ID of the company associated with the project. | |
| category_id | No | The ID of the category to which the project belongs. | |
| description | No | The description of the project. |
twprojects-create_project_categoryInspect
Create a new project category in Teamwork.com. The project category is a way to group and label related projects so teams can organize their work more clearly across the platform. By assigning a category, you create a higher-level structure that makes it easier to filter, report on, and navigate multiple projects, ensuring that departments, workflows, or strategic areas remain neatly aligned and easier to manage.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the project category. | |
| color | No | The color of the project category in hex format (e.g., #FF5733). | |
| parent_id | No | The ID of the parent project category, if any. This allows for nested categories. |
twprojects-create_project_templateInspect
Create a new project template in Teamwork.com. The project template is a reusable project structure designed to standardize workflows and streamline project setup. It typically includes predefined tasks, task lists, milestones, and timelines that reflect a repeatable process, allowing teams to quickly spin up new projects with consistent organization, clear responsibilities, and efficient execution from the start.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the project template. | |
| end_at | No | The end date of the project template in the format YYYYMMDD. | |
| tag_ids | No | A list of tag IDs to associate with the project template. | |
| owned_id | No | The ID of the user who owns the project template. | |
| start_at | No | The start date of the project template in the format YYYYMMDD. | |
| company_id | No | The ID of the company associated with the project template. | |
| category_id | No | The ID of the category to which the project template belongs. | |
| description | No | The description of the project template. |
twprojects-create_skillInspect
Create a new skill in Teamwork.com. Skill represents a specific capability, area of expertise, or proficiency that can be assigned to users to describe what they are good at or qualified to work on. Skills help teams understand the strengths available across the organization and make it easier to match the right skills to the right work when planning projects, assigning tasks, or managing resources. By associating skills with users and leveraging them in planning and reporting, Teamwork enables more effective workload distribution, better project outcomes, and clearer visibility into whether the team has the capabilities needed to deliver upcoming work.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the skill. | |
| user_ids | No | The user IDs associated with the skill. |
twprojects-create_tagInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the tag. It must have less than 50 characters. | |
| project_id | No | The ID of the project to associate the tag with. This is for project-scoped tags. |
twprojects-create_taskInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the task. | |
| tag_ids | No | A list of tag IDs to assign to the task. | |
| due_date | No | 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. | |
| priority | No | The priority of the task. Possible values are: low, medium, high. | |
| progress | No | The progress of the task, as a percentage (0-100). Only whole numbers are allowed. | |
| assignees | No | An object containing assignees for the task. | |
| start_date | No | The start date of the task in ISO 8601 format (YYYY-MM-DD). | |
| description | No | The description of the task. | |
| tasklist_id | Yes | 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. | |
| predecessors | No | 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. | |
| parent_task_id | No | The ID of the parent task if creating a subtask. | |
| estimated_minutes | No | The estimated time to complete the task in minutes. |
twprojects-create_tasklistInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the tasklist. | |
| project_id | Yes | The ID of the project to create the tasklist in. | |
| description | No | The description of the tasklist. | |
| milestone_id | No | The ID of the milestone to associate with the tasklist. |
twprojects-create_teamInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the team. | |
| handle | No | The handle of the team. It is a unique identifier for the team. It must not have spaces or special characters. | |
| user_ids | No | A list of user IDs to add to the team. | |
| company_id | No | The ID of the company. This is used to create a team scoped for a specific company. | |
| project_id | No | The ID of the project. This is used to create a team scoped for a specific project. | |
| description | No | The description of the team. | |
| parent_team_id | No | The ID of the parent team. This is used to create a hierarchy of teams. |
twprojects-create_timelogInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | The date of the timelog in the format YYYY-MM-DD. | |
| time | Yes | The time of the timelog in the format HH:MM:SS. | |
| hours | Yes | The number of hours spent on the timelog. Must be a positive integer. | |
| is_utc | No | If true, the time is in UTC. Defaults to false. | |
| minutes | Yes | The number of minutes spent on the timelog. Must be a positive integer less than 60, otherwise the hours attribute should be incremented. | |
| tag_ids | No | A list of tag IDs to associate with the timelog. | |
| task_id | No | The ID of the task to associate the timelog with. Either project_id or task_id must be provided, but not both. | |
| user_id | No | The ID of the user to associate the timelog with. Defaults to the authenticated user if not provided. | |
| billable | No | If true, the timelog is billable. Defaults to false. | |
| project_id | No | The ID of the project to associate the timelog with. Either project_id or task_id must be provided, but not both. | |
| description | No | A description of the timelog. |
twprojects-create_timerInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| running | No | If true, the timer will start running immediately. | |
| seconds | No | The number of seconds to set the timer for. | |
| task_id | No | The ID of the task to associate the timer with. | |
| billable | No | If true, the timer is billable. Defaults to false. | |
| project_id | Yes | The ID of the project to associate the timer with. | |
| description | No | A description of the timer. | |
| stop_running_timers | No | If true, any other running timers will be stopped when this timer is created. |
twprojects-create_userInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | The type of user, such as 'account', 'collaborator', or 'contact'. | |
| admin | No | Indicates whether the user is an administrator. | |
| Yes | The email address of the user. | ||
| title | No | The job title of the user, such as 'Project Manager' or 'Senior Software Developer'. | |
| last_name | Yes | The last name of the user. | |
| company_id | No | The ID of the client/company to which the user belongs. | |
| first_name | Yes | The first name of the user. |
twprojects-get_commentRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the comment to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| comments | Yes |
twprojects-get_companyRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the company to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| company | Yes |
twprojects-get_jobroleRead-onlyInspect
Get an existing job role in Teamwork.com. Job role defines a user's primary function or position within the organization, such as developer, designer, project manager, or account manager. It provides high-level context about what a person is generally responsible for, helping teams understand who does what across projects and departments. Job roles are commonly used in resource planning, capacity forecasting, and reporting, allowing managers to group work by role, plan future demand more accurately, and ensure the right mix of roles is available to deliver projects efficiently.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the job role to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| jobRole | Yes |
twprojects-get_milestoneRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the milestone to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| milestone | Yes |
twprojects-get_notebookRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the notebook to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| notebook | Yes |
twprojects-get_projectRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the project to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| project | Yes |
twprojects-get_project_categoryRead-onlyInspect
Get an existing project category in Teamwork.com. The project category is a way to group and label related projects so teams can organize their work more clearly across the platform. By assigning a category, you create a higher-level structure that makes it easier to filter, report on, and navigate multiple projects, ensuring that departments, workflows, or strategic areas remain neatly aligned and easier to manage.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the project category to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| projectCategory | Yes |
twprojects-get_skillRead-onlyInspect
Get an existing skill in Teamwork.com. Skill represents a specific capability, area of expertise, or proficiency that can be assigned to users to describe what they are good at or qualified to work on. Skills help teams understand the strengths available across the organization and make it easier to match the right skills to the right work when planning projects, assigning tasks, or managing resources. By associating skills with users and leveraging them in planning and reporting, Teamwork enables more effective workload distribution, better project outcomes, and clearer visibility into whether the team has the capabilities needed to deliver upcoming work.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the skill to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| skill | Yes |
twprojects-get_tagRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the tag to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| tag | Yes |
twprojects-get_taskRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the task to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| task | Yes |
twprojects-get_tasklistRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the tasklist to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| tasklist | Yes |
twprojects-get_teamRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the team to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| team | Yes |
twprojects-get_timelogRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the timelog to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| timelog | Yes |
twprojects-get_timerRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the timer to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| timer | Yes |
twprojects-get_userRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the user to get. |
Output Schema
| Name | Required | Description |
|---|---|---|
| person | Yes |
twprojects-get_user_meRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| person | Yes |
twprojects-list_activitiesRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| end_date | No | End date to filter activities. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| page_size | No | Number of results per page for pagination. | |
| start_date | No | Start date to filter activities. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| log_item_types | No | Filter activities by item types. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| activities | Yes |
twprojects-list_activities_by_projectRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| end_date | No | End date to filter activities. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| page_size | No | Number of results per page for pagination. | |
| project_id | No | The ID of the project to retrieve activities from. | |
| start_date | No | Start date to filter activities. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| log_item_types | No | Filter activities by item types. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| activities | Yes |
twprojects-list_commentsRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter comments by name. | |
| updated_after | No | Filter comments updated after this date and time. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. By default it will only return comments updated on the last 3 months. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| comments | Yes |
twprojects-list_comments_by_file_versionRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter comments by name. | |
| updated_after | No | Filter comments updated after this date and time. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. By default it will only return comments updated on the last 3 months. | |
| file_version_id | Yes | The ID of the file version to retrieve comments for. Each file can have multiple versions, and comments can be associated with specific versions. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| comments | Yes |
twprojects-list_comments_by_milestoneRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter comments by name. | |
| milestone_id | Yes | The ID of the milestone to retrieve comments for. | |
| updated_after | No | Filter comments updated after this date and time. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. By default it will only return comments updated on the last 3 months. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| comments | Yes |
twprojects-list_comments_by_notebookRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| notebook_id | Yes | The ID of the notebook to retrieve comments for. | |
| search_term | No | A search term to filter comments by name. | |
| updated_after | No | Filter comments updated after this date and time. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. By default it will only return comments updated on the last 3 months. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| comments | Yes |
twprojects-list_comments_by_taskRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| task_id | Yes | The ID of the task to retrieve comments for. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter comments by name. | |
| updated_after | No | Filter comments updated after this date and time. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. By default it will only return comments updated on the last 3 months. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| comments | Yes |
twprojects-list_companiesRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter companies by tags | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter companies by name. Each word from the search term is used to match against the company name. | |
| match_all_tags | No | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| companies | Yes |
twprojects-list_industriesRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| industries | Yes |
twprojects-list_jobrolesRead-onlyInspect
List job roles in Teamwork.com. Job role defines a user's primary function or position within the organization, such as developer, designer, project manager, or account manager. It provides high-level context about what a person is generally responsible for, helping teams understand who does what across projects and departments. Job roles are commonly used in resource planning, capacity forecasting, and reporting, allowing managers to group work by role, plan future demand more accurately, and ensure the right mix of roles is available to deliver projects efficiently.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter job roles by name, or assigned users. The job role will be selected if each word of the term matches the name, or assigned user first or last name, not requiring that the word matches are in the same field. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| jobRoles | Yes |
twprojects-list_milestonesRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter milestones by tags | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | 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. | |
| match_all_tags | No | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| milestones | Yes |
twprojects-list_milestones_by_projectRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter milestones by tags | |
| page_size | No | Number of results per page for pagination. | |
| project_id | Yes | The ID of the project from which to retrieve milestones. | |
| search_term | No | 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. | |
| match_all_tags | No | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| milestones | Yes |
twprojects-list_notebooksRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter notebooks by tags | |
| page_size | No | Number of results per page for pagination. | |
| project_ids | No | A list of project IDs to filter notebooks by projects | |
| search_term | No | 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. | |
| match_all_tags | No | 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. | |
| include_contents | No | If true, the contents of the notebook will be included in the response. Defaults to true. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| notebooks | Yes |
twprojects-list_project_budgetsRead-onlyInspect
List project budgets in Teamwork.com. In the context of Teamwork.com, a project budget defines the overall budget allocation for a project, including capacity and usage tracking over time. It can be scoped by status and project, enabling teams to monitor financial or effort limits, track consumption, and understand budget performance across active, upcoming, and completed budget periods.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of budgets to return. | |
| cursor | No | Cursor for fetching the next page of results. | |
| status | No | Filter budgets by status. Allowed values: upcoming, active, complete. | |
| page_size | No | Number of budgets to return per page. | |
| project_ids | No | A list of project IDs to filter budgets by project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| budgets | Yes | |
| included | Yes |
twprojects-list_project_categoriesRead-onlyInspect
List project categories in Teamwork.com. The project category is a way to group and label related projects so teams can organize their work more clearly across the platform. By assigning a category, you create a higher-level structure that makes it easier to filter, report on, and navigate multiple projects, ensuring that departments, workflows, or strategic areas remain neatly aligned and easier to manage.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter project categories by name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| projectCategories | Yes |
twprojects-list_projectsRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter projects by tags. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter projects by name or description. | |
| match_all_tags | No | 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. | |
| project_category_ids | No | A list of project category IDs to filter projects by categories. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| projects | Yes |
twprojects-list_project_templatesRead-onlyInspect
List project templates in Teamwork.com. The project template is a reusable project structure designed to standardize workflows and streamline project setup. It typically includes predefined tasks, task lists, milestones, and timelines that reflect a repeatable process, allowing teams to quickly spin up new projects with consistent organization, clear responsibilities, and efficient execution from the start.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter project templates by tags. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter project templates by name or description. | |
| match_all_tags | No | If true, the search will match project templates that have all the specified tags. If false, the search will match project templates that have any of the specified tags. Defaults to false. | |
| project_category_ids | No | A list of project category IDs to filter project templates by categories. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| projects | Yes |
twprojects-list_skillsRead-onlyInspect
List skills in Teamwork.com. Skill represents a specific capability, area of expertise, or proficiency that can be assigned to users to describe what they are good at or qualified to work on. Skills help teams understand the strengths available across the organization and make it easier to match the right skills to the right work when planning projects, assigning tasks, or managing resources. By associating skills with users and leveraging them in planning and reporting, Teamwork enables more effective workload distribution, better project outcomes, and clearer visibility into whether the team has the capabilities needed to deliver upcoming work.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter skills by name, or assigned users. The skill will be selected if each word of the term matches the name, or assigned user first or last name, not requiring that the word matches are in the same field. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| skills | Yes |
twprojects-list_tagsRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| item_type | No | The type of item to filter tags by. Valid values are 'project', 'task', 'tasklist', 'milestone', 'message', 'timelog', 'notebook', 'file', 'company' and 'link'. | |
| page_size | No | Number of results per page for pagination. | |
| project_ids | No | A list of project IDs to filter tags by projects | |
| search_term | No | A search term to filter tags by name. Each word from the search term is used to match against the tag name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| tags | Yes |
twprojects-list_tasklist_budgetsRead-onlyInspect
List tasklist budgets for a project budget in Teamwork.com. In the context of Teamwork.com, a tasklist budget is a budget allocation attached to a specific task list within a project budget. It tracks capacity (in time or money) assigned to and consumed by a task list, helping teams monitor spend and effort at a granular level within a broader project budget.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| project_budget_id | Yes | The ID of the project budget to list tasklist budgets for. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| included | Yes | |
| tasklistBudgets | Yes |
twprojects-list_tasklistsRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter tasklists by name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| tasklists | Yes |
twprojects-list_tasklists_by_projectRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| project_id | Yes | The ID of the project from which to retrieve tasklists. | |
| search_term | No | A search term to filter tasklists by name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| tasklists | Yes |
twprojects-list_tasksRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter tasks by tags | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter tasks by name. | |
| match_all_tags | No | 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. | |
| assignee_user_ids | No | A list of user IDs to filter tasks by assigned users |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| tasks | Yes |
twprojects-list_tasks_by_projectRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter tasks by tags | |
| page_size | No | Number of results per page for pagination. | |
| project_id | Yes | The ID of the project from which to retrieve tasks. | |
| search_term | No | A search term to filter tasks by name. | |
| match_all_tags | No | 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. | |
| assignee_user_ids | No | A list of user IDs to filter tasks by assigned users |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| tasks | Yes |
twprojects-list_tasks_by_tasklistRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter tasks by tags | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter tasks by name. | |
| tasklist_id | Yes | The ID of the tasklist from which to retrieve tasks. | |
| match_all_tags | No | 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. | |
| assignee_user_ids | No | A list of user IDs to filter tasks by assigned users |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| tasks | Yes |
twprojects-list_teamsRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | A search term to filter teams by name or handle. |
Output Schema
| Name | Required | Description |
|---|---|---|
| teams | Yes |
twprojects-list_teams_by_companyRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| company_id | Yes | The ID of the company from which to retrieve teams. | |
| search_term | No | A search term to filter teams by name or handle. |
Output Schema
| Name | Required | Description |
|---|---|---|
| teams | Yes |
twprojects-list_teams_by_projectRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| page_size | No | Number of results per page for pagination. | |
| project_id | Yes | The ID of the project from which to retrieve teams. | |
| search_term | No | A search term to filter teams by name or handle. |
Output Schema
| Name | Required | Description |
|---|---|---|
| teams | Yes |
twprojects-list_timelogsRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter timelogs by tags | |
| end_date | No | End date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| page_size | No | Number of results per page for pagination. | |
| ticketIds | No | A list of desk ticket IDs to filter timelogs by associated desk tickets | |
| start_date | No | Start date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| match_all_tags | No | 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. | |
| assigned_team_ids | No | A list of team IDs to filter timelogs by assigned teams | |
| assigned_user_ids | No | A list of user IDs to filter timelogs by assigned users | |
| assigned_company_ids | No | A list of company IDs to filter timelogs by assigned companies |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| timelogs | Yes |
twprojects-list_timelogs_by_projectRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter timelogs by tags | |
| end_date | No | End date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| page_size | No | Number of results per page for pagination. | |
| ticketIds | No | A list of desk ticket IDs to filter timelogs by associated desk tickets | |
| project_id | Yes | The ID of the project from which to retrieve timelogs. | |
| start_date | No | Start date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| match_all_tags | No | 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. | |
| assigned_team_ids | No | A list of team IDs to filter timelogs by assigned teams | |
| assigned_user_ids | No | A list of user IDs to filter timelogs by assigned users | |
| assigned_company_ids | No | A list of company IDs to filter timelogs by assigned companies |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| timelogs | Yes |
twprojects-list_timelogs_by_taskRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| tag_ids | No | A list of tag IDs to filter timelogs by tags | |
| task_id | Yes | The ID of the task from which to retrieve timelogs. | |
| end_date | No | End date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| page_size | No | Number of results per page for pagination. | |
| ticketIds | No | A list of desk ticket IDs to filter timelogs by associated desk tickets | |
| start_date | No | Start date to filter timelogs. The date format follows RFC3339 - YYYY-MM-DDTHH:MM:SSZ. | |
| match_all_tags | No | 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. | |
| assigned_team_ids | No | A list of team IDs to filter timelogs by assigned teams | |
| assigned_user_ids | No | A list of user IDs to filter timelogs by assigned users | |
| assigned_company_ids | No | A list of company IDs to filter timelogs by assigned companies |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| timelogs | Yes |
twprojects-list_timersRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| task_id | No | The ID of the task to filter timers by. Only timers associated with this task will be returned. | |
| user_id | No | The ID of the user to filter timers by. Only timers associated with this user will be returned. | |
| page_size | No | Number of results per page for pagination. | |
| project_id | No | The ID of the project to filter timers by. Only timers associated with this project will be returned. | |
| running_timers_only | No | If true, only running timers will be returned. Defaults to false, which returns all timers. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| timers | Yes |
twprojects-list_usersRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| type | No | Type of user to filter by. The available options are account, collaborator or contact. | |
| page_size | No | Number of results per page for pagination. | |
| search_term | No | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| people | Yes |
twprojects-list_users_by_projectRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| type | No | Type of user to filter by. The available options are account, collaborator or contact. | |
| page_size | No | Number of results per page for pagination. | |
| project_id | Yes | The ID of the project from which to retrieve users. | |
| search_term | No | 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. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| people | Yes |
twprojects-pause_timerInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the timer to pause. |
twprojects-resume_timerInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the timer to resume. |
twprojects-update_commentInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the comment to update. | |
| body | Yes | The content of the comment. The content can be added as text or HTML. | |
| content_type | No | The content type of the comment. It can be either 'TEXT' or 'HTML'. |
twprojects-update_companyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the company to update. | |
| fax | No | The fax number of the company. | |
| zip | No | The ZIP or postal code of the company. | |
| city | No | The city of the company. | |
| name | No | The name of the company. | |
| phone | No | The phone number of the company. | |
| state | No | The state of the company. | |
| profile | No | A profile description for the company. | |
| tag_ids | No | A list of tag IDs to associate with the company. | |
| website | No | The website of the company. | |
| email_one | No | The primary email address of the company. | |
| email_two | No | The secondary email address of the company. | |
| manager_id | No | The ID of the user who manages the company. | |
| address_one | No | The first line of the address of the company. | |
| address_two | No | The second line of the address of the company. | |
| email_three | No | The tertiary email address of the company. | |
| industry_id | No | The ID of the industry the company belongs to. | |
| country_code | No | The country code of the company, e.g., 'US' for the United States. |
twprojects-update_jobroleInspect
Update an existing job role in Teamwork.com. Job role defines a user's primary function or position within the organization, such as developer, designer, project manager, or account manager. It provides high-level context about what a person is generally responsible for, helping teams understand who does what across projects and departments. Job roles are commonly used in resource planning, capacity forecasting, and reporting, allowing managers to group work by role, plan future demand more accurately, and ensure the right mix of roles is available to deliver projects efficiently.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the job role to update. | |
| name | No | The name of the job role. |
twprojects-update_milestoneInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the milestone to update. | |
| name | No | The name of the milestone. | |
| tag_ids | No | A list of tag IDs to associate with the milestone. | |
| due_date | No | 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. | |
| assignees | No | An object containing assignees for the milestone. | |
| description | No | A description of the milestone. | |
| tasklist_ids | No | A list of tasklist IDs to associate with the milestone. |
twprojects-update_notebookInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the notebook to update. | |
| name | No | The name of the notebook. | |
| type | No | The type of the notebook. Valid values are 'MARKDOWN' and 'HTML'. | |
| tag_ids | No | A list of tag IDs to associate with the notebook. | |
| contents | No | The contents of the notebook. | |
| description | No | A description of the notebook. |
twprojects-update_projectInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the project to update. | |
| name | No | The name of the project. | |
| end_at | No | The end date of the project in the format YYYYMMDD. | |
| status | No | The status of the project. Allowed values: active or archived. | |
| tag_ids | No | A list of tag IDs to associate with the project. | |
| owned_id | No | The ID of the user who owns the project. | |
| start_at | No | The start date of the project in the format YYYYMMDD. | |
| company_id | No | The ID of the company associated with the project. | |
| category_id | No | The ID of the category to which the project belongs. | |
| description | No | The description of the project. |
twprojects-update_project_categoryInspect
Update an existing project category in Teamwork.com. The project category is a way to group and label related projects so teams can organize their work more clearly across the platform. By assigning a category, you create a higher-level structure that makes it easier to filter, report on, and navigate multiple projects, ensuring that departments, workflows, or strategic areas remain neatly aligned and easier to manage.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the project category to update. | |
| name | No | The name of the project category. | |
| color | No | The color of the project category in hex format (e.g., #FF5733). | |
| parent_id | No | The ID of the parent project category, if any. This allows for nested categories. |
twprojects-update_skillInspect
Update an existing skill in Teamwork.com. Skill represents a specific capability, area of expertise, or proficiency that can be assigned to users to describe what they are good at or qualified to work on. Skills help teams understand the strengths available across the organization and make it easier to match the right skills to the right work when planning projects, assigning tasks, or managing resources. By associating skills with users and leveraging them in planning and reporting, Teamwork enables more effective workload distribution, better project outcomes, and clearer visibility into whether the team has the capabilities needed to deliver upcoming work.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the skill to update. | |
| name | No | The name of the skill. | |
| user_ids | No | The user IDs associated with the skill. |
twprojects-update_tagInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the tag to update. | |
| name | No | The name of the tag. It must have less than 50 characters. | |
| project_id | No | The ID of the project to associate the tag with. This is for project-scoped tags. |
twprojects-update_taskInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the task to update. | |
| name | No | The name/title of the task. | |
| tag_ids | No | A list of tag IDs to assign to the task. | |
| due_date | No | 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. | |
| priority | No | The priority of the task. Possible values are: low, medium, high. | |
| progress | No | The progress of the task, as a percentage (0-100). Only whole numbers are allowed. | |
| assignees | No | An object containing assignees for the task. | |
| start_date | No | The start date of the task in ISO 8601 format (YYYY-MM-DD). | |
| description | No | The description of the task. | |
| tasklist_id | No | The ID of the tasklist. | |
| predecessors | No | 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. | |
| parent_task_id | No | The ID of the parent task if creating a subtask. | |
| estimated_minutes | No | The estimated time to complete the task in minutes. |
twprojects-update_tasklistInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the tasklist to update. | |
| name | No | The name of the tasklist. | |
| description | No | The description of the tasklist. | |
| milestone_id | No | The ID of the milestone to associate with the tasklist. |
twprojects-update_teamInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the team to update. | |
| name | No | The name of the team. | |
| handle | No | The handle of the team. It is a unique identifier for the team. It must not have spaces or special characters. | |
| user_ids | No | A list of user IDs to add to the team. | |
| company_id | No | The ID of the company. This is used to create a team scoped for a specific company. | |
| project_id | No | The ID of the project. This is used to create a team scoped for a specific project. | |
| description | No | The description of the team. | |
| parent_team_id | No | The ID of the parent team. This is used to create a hierarchy of teams. |
twprojects-update_timelogInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the timelog to update. | |
| date | No | The date of the timelog in the format YYYY-MM-DD. | |
| time | No | The time of the timelog in the format HH:MM:SS. | |
| hours | No | The number of hours spent on the timelog. Must be a positive integer. | |
| is_utc | No | If true, the time is in UTC. Defaults to false. | |
| minutes | No | The number of minutes spent on the timelog. Must be a positive integer less than 60, otherwise the hours attribute should be incremented. | |
| tag_ids | No | A list of tag IDs to associate with the timelog. | |
| task_id | No | The ID of the task to associate the timelog with. Either project_id or task_id must be provided, but not both. | |
| user_id | No | The ID of the user to associate the timelog with. Defaults to the authenticated user if not provided. | |
| billable | No | If true, the timelog is billable. Defaults to false. | |
| project_id | No | The ID of the project to associate the timelog with. Either project_id or task_id must be provided, but not both. | |
| description | No | A description of the timelog. |
twprojects-update_timerInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the timer to update. | |
| running | No | If true, the timer will start running immediately. | |
| task_id | No | The ID of the task to associate the timer with. | |
| billable | No | If true, the timer is billable. | |
| project_id | No | The ID of the project to associate the timer with. | |
| description | No | A description of the timer. |
twprojects-update_userInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the user to update. | |
| type | No | The type of user, such as 'account', 'collaborator', or 'contact'. | |
| admin | No | Indicates whether the user is an administrator. | |
| No | The email address of the user. | ||
| title | No | The job title of the user, such as 'Project Manager' or 'Senior Software Developer'. | |
| last_name | No | The last name of the user. | |
| company_id | No | The ID of the client/company to which the user belongs. | |
| first_name | No | The first name of the user. |
twprojects-users_workloadRead-onlyInspect
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination of results. | |
| end_date | Yes | The end date of the workload period. The date must be in the format YYYY-MM-DD. | |
| user_ids | No | List of user IDs to filter the workload by. | |
| page_size | No | Number of results per page for pagination. | |
| start_date | Yes | The start date of the workload period. The date must be in the format YYYY-MM-DD. | |
| project_ids | No | List of project IDs to filter the workload by. | |
| user_team_ids | No | List of users' team IDs to filter the workload by. | |
| user_company_ids | No | List of users' client/company IDs to filter the workload by. |
Output Schema
| Name | Required | Description |
|---|---|---|
| meta | Yes | |
| included | Yes | |
| workload | Yes |
Verify Ownership
Claim this connector by publishing a /.well-known/glama.json file on your server's domain with the following structure:
{
"$schema": "https://glama.ai/mcp/schemas/connector.json",
"maintainers": [
{
"email": "your-email@example.com"
}
]
}The email address must match the email associated with your Glama account. Once verified, the connector will appear as claimed by you.
Last verification attempt failed.
Failed to fetch .well-known/glama.json: HTTP 400
Control your server's listing on Glama, including description and metadata
Receive usage reports showing how your server is being used
Get monitoring and health status updates for your server
The connector status is unhealthy when Glama is unable to successfully connect to the server. This can happen for several reasons:
The server is experiencing an outage
The URL of the server is wrong
Credentials required to access the server are missing or invalid
If you are the owner of this MCP connector and would like to make modifications to the listing, including providing test credentials for accessing the server, please contact support@glama.ai.
Discussions
No comments yet. Be the first to start the discussion!
Your Connectors
Sign in to create a connector for this server.