NOTE: Certain information in this article may be missing or out of date. We are in the process of updating the content.
Teamwork Projects helps to optimize team performance by enabling collaboration, streamlining processes, and empowering your teams. This article will give you an overview of the Teamwork/Grow integration.
How to Connect
Before connecting please collect your Teamwork API Key and Site Name.
- Sign in to your Grow account and click Add Metric. Select Teamwork from the list of data connections and click the blue Connect button.
- Type in your site name. When your team creates an account in Teamwork, you will choose your site name. This is what you enter into the first field.
- Type in your API key. To find your API Key, log in to your Teamwork account. Then click on your picture in the right-hand corner to find the menu that shows account settings options. Go ahead and click on Edit My Details.
- Your account information will pull up. Along the row of tabs, the rightmost one should be labeled “API and Mobile.”
- Once you open that tab, you will see a section labeled “Your API Token.” Click on the the green Show Your Token button. It will bring a field up that has your API Key.
- Go ahead and copy that into Grow.
And that’s it. You are good to go!
Below is a list of the endpoints offered through the Teamwork/Grow integration, along with a description of the data that each report returns.
- Account Details: Retrieves details about the Teamwork account, including status, name, date signed up, company name, created date, cache UUID, account holder id, logo, id, URL, company id, language, code, etc.
- Budget: Get a list of budgets information including type, status, project status, order mode and by, project healths, page, page size, project tags ids, project owner ids, etc. (Only available with the Teamwork Project "Grow" and "Enterprise" plan)
- Calendar Events: Gets all calendar events that the current user can see in the provided date range including start date, project statuses, order mode and by, end date, project healths, etc.
- Companies: Company information including state, name, address, email, contacts, industry, website, phone, company name URL, country, zip, city, id, etc.
- Completed Tasks: All tasks with completed status for the desired date range, including due date, estimated time, completer name and ID, total time logged, project name and status, company name, etc.
- Custom Field: Return all custom fields for provided filters including, project statuses, order mode and by, name, entities, project id, project limits, project health, etc.
- Dashboards: Dashboards contains panels that are used to summarize many activities from the installation including updated after, order mode and by, user id, project id, page size, etc.
- Expenses: Get all expenses across all projects including invoice id, project id, name, description, created by user first name, company id, project name, created by user id, date, company name, cost, etc.
- Installation Project Summary: Retrieves the summary from the entire installation, returning counters about tasks, milestones, columns, events, risks, timers, projects healths.
- Invoice: Brings back all the invoices across all projects including page and type.
- Latest Activities: Lists the latest activity across all projects ordered chronologically, including updated after, start date, sort, project statuses, project status, order mode, order by, end date, activity types, project id, project healths, page size, etc.
- Milestones: Milestone information, including project ID and name, completer, status, completion details, responsible party details, reminders, task lists, description, deadline, created date, last change date, comment information, among other details.
- Milestones by Project: Milestone information for each project you select, including project ID and name, completer, status, completion details, responsible party details, reminders, task lists, description, deadline, created date, last change date, comment information, among other details.
- Notebooks: Retrieves a list of notebooks including updated after date, search term, project type, project statuses, order mode and by, project healths, etc.
- People: Retrieves all people for the provided filters including, user type, updated after, order by and mode, last login after, included clients, include service accounts, exclude accounts, etc.
- Projects: All projects, including starred, status, substatus, date, category name and ID, tags, created date, start date, end date, company name and ID, description, custom fields, etc.
- Project Updates: Return the updates from all projects that the logged-in user can access including project statuses, order mode and by, created after, project id, project health, etc.
- Risks: Returns all risks for the provided filters including updated after and date, statuses, sort order, sort, search term, report format, report format, project statuses, order mode and by, project healths, probability to and from, etc.
- Running Timers: Returns all currently running timers including project id, task id, running timers only. If the timer has never been stopped then this interval will only have a from property set and the you will need to calculate the current duration of the timer.
- Tags: Returns all tags that the logged-in user can access including updated after, search term order mode and by, item type, filter, page size, etc.
- Tasks: All tasks and subtasks filtered by start, updated, or completed date. Field data includes task ID, completer name and ID, project name and status, company name, project description, priority, estimated time, due date, progress, has tickets, recurring details, etc.
- Time Tracking: All entries for hours worked on tasks and projects for the desired date range, including date, start time, task estimate time, logged time, date updated, to-do item name, is billed, person name, parent task ID, project name and status, invoice number, etc.
- Time Tracking By Project: All entries for hours worked on the selected project(s) for the desired date range, including project name and status, to-do item name, is billed, created date, person name, start time, total time logged, description, etc.
- Time Totals by Project: An aggregate of hours logged on the selected project(s) for the desired date range, including company name and ID, time estimates, total time logged, billed and unbilled hours, billed and unbilled minutes, etc.
- Workload: Lists the workload across all projects, sort by users, company or project.
Note: Custom fields are defined within Teamwork by the account admin.
FAQs + Tips and Tricks
Why can I not see/access the Budget endpoint?
In order to access the Budget endpoint your Teamwork Projects account plan must be subscribed to the "Grow" or "Enterprise" plan.