> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Teamwork Connector

## Intro

Teamwork  provides online project management, help desk, and team messaging software.  To learn more about the Teamwork API, visit their page ([https://developer.teamwork.com/](https://developer.teamwork.com/ "https://developer.teamwork.com/projects/introduction/welcome-to-the-teamwork-projects-api") ).

You connect to your Teamwork account in the Data Center. This topic discusses the fields and menus that are specific to the Teamwork connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](/s/article/360042926274).

## Prerequisites

To connect to your Teamwork account and create a DataSet, you must have a Teamwork API key. To learn how to obtain an API key, visit this page: [https://developer.teamwork.com/projects/apikey/key](https://developer.teamwork.com/projects/apikey/key "https://developer.teamwork.com/projects/finding-your-url-and-api-key/api-key-and-url")

## Connecting to Your Teamwork Account

This section enumerates the options in the **Credentials** and **Details** panes in the Teamwork Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your Teamwork account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> API Key </p></td><td colspan="1" rowspan="1"><p> Enter your Teamwork API key. </p></td></tr></tbody></table>

Once you have entered valid Teamwork credentials, you can use the same account any time you go to create a new Teamwork DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

### Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the Teamwork report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p> Accounts </p></td><td colspan="1" rowspan="1"><p> Returns details about your Teamwork accounts. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Activity </p></td><td colspan="1" rowspan="1"><p> Returns a list of the latest activity across all projects ordered chronologically. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Archived Message </p></td><td colspan="1" rowspan="1"><p> Returns a summary record for each message in the specified project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Billing Expenses </p></td><td colspan="1" rowspan="1"><p> Returns all expenses across your projects. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Billing Invoices </p></td><td colspan="1" rowspan="1"><p> Returns all invoices across your projects. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Calendar Events </p></td><td colspan="1" rowspan="1"><p> Returns all calendar events that the current user can see in the provided date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Comments </p></td><td colspan="1" rowspan="1"><p> Returns comments for all projects. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Companies </p></td><td colspan="1" rowspan="1"><p> Returns a list of companies in your account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Company People </p></td><td colspan="1" rowspan="1"><p> Returns all of the people assigned to a given company. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Company Project </p></td><td colspan="1" rowspan="1"><p> Returns all of the projects assigned to a given company. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Completed Task </p></td><td colspan="1" rowspan="1"><p> Returns all completed tasks. </p></td></tr><tr><td colspan="1" rowspan="1"><p> File on Project </p></td><td colspan="1" rowspan="1"><p> Returns a list of files for a given project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> File on Task </p></td><td colspan="1" rowspan="1"><p> Returns a list of files for a given task. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Link </p></td><td colspan="1" rowspan="1"><p> Returns all links on projects the authenticated user is associated with. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Message Reply </p></td><td colspan="1" rowspan="1"><p> Returns all replies to the 25 most recent messages. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Milestones </p></td><td colspan="1" rowspan="1"><p> Returns all milestones on projects the authenticated user is associated with. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Notebook </p></td><td colspan="1" rowspan="1"><p> Returns all notebooks on projects the authenticated user is associated with. </p></td></tr><tr><td colspan="1" rowspan="1"><p> People </p></td><td colspan="1" rowspan="1"><p> Returns all people visible to the user. </p></td></tr><tr><td colspan="1" rowspan="1"><p> People in Project </p></td><td colspan="1" rowspan="1"><p> Returns all people assigned to a given project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> People Status </p></td><td colspan="1" rowspan="1"><p> Returns all of the latest status posts for all users in the parent company. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project </p></td><td colspan="1" rowspan="1"><p> Returns all accessible projects. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project Categories </p></td><td colspan="1" rowspan="1"><p> Returns all project categories. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project Link Categories </p></td><td colspan="1" rowspan="1"><p> Returns all link categories for your project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project Notebook Categories </p></td><td colspan="1" rowspan="1"><p> Returns all notebook categories for your project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project Risk </p></td><td colspan="1" rowspan="1"><p> Returns all risks for a given project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project Roles </p></td><td colspan="1" rowspan="1"><p> Returns a list of roles for a given project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project File Categories </p></td><td colspan="1" rowspan="1"><p> Returns all the file categories for your project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project Message Categories </p></td><td colspan="1" rowspan="1"><p> Returns all message categories for your project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Project Total Time </p></td><td colspan="1" rowspan="1"><p> Returns time totals per project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Retrieve Latest Message </p></td><td colspan="1" rowspan="1"><p> Returns the 25 most recent messages for the given project. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Starred Project </p></td><td colspan="1" rowspan="1"><p> Retrieves all of your starred projects. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Tasks </p></td><td colspan="1" rowspan="1"><p> Returns all tasks across all projects. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Task Dependencies </p></td><td colspan="1" rowspan="1"><p> Returns a list of tasks that rely on the specified task to be completed first. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Task Followers </p></td><td colspan="1" rowspan="1"><p> Returns a list of users following the activity of a given task. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Task List </p></td><td colspan="1" rowspan="1"><p> Returns all project task lists. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Task Reminder </p></td><td colspan="1" rowspan="1"><p> Returns reminders on all tasks. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Time Entries </p></td><td colspan="1" rowspan="1"><p> Returns time entries for all projects. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Workload </p></td><td colspan="1" rowspan="1"><p> Returns a list of workloads across all projects. </p></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Project </p></td><td colspan="1" rowspan="1"><p> Select the project you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Task Filter </p></td><td colspan="1" rowspan="1"><p> Select the filter you want to apply to the tasks in your report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Status </p></td><td colspan="1" rowspan="1"><p> Select the project status you want to use to filter data in your report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Company </p></td><td colspan="1" rowspan="1"><p> Select the company you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Duration </p></td><td colspan="1" rowspan="1"><p> Select whether you want to pull data for a specific date or a date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Date </p></td><td colspan="1" rowspan="1"><p> Select whether the report data is for a specific date or for a relative number of days back from today. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Date </p></td><td colspan="1" rowspan="1"><p> Select the date for the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back </p></td><td colspan="1" rowspan="1"><p> Enter the number of past days that should appear in the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Start Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in <b> End Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> End Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in <b> Start Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1"><p> Select the first date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1"><p> Select the second date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to Start From </p></td><td colspan="1" rowspan="1"><p> Enter the number of the farthest day back that should be represented in the report. Combine with <b> Days Back to End At </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to End At </p></td><td colspan="1" rowspan="1"><p> Enter the number of the most recent day back that should be represented in the report. Combine with <b> Days Back to Start From </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Data Connector](/s/article/360042926274).
