Skip to main content
Teamwork logo
  • Category: project management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: TEAMWORK
  • Version: 20261019_00

Tools

Slug: TEAMWORK_CREATE_TAGCreate a Teamwork tag, or return the existing installation tag when the same name already exists.

Input Parameters

string
required
Non-empty tag name.
string
Optional six-digit hex color, such as #3455DB.
integer
Project ID for a project tag, or 0 for an installation-wide tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_CREATE_TASKCreate a task in a Teamwork task list with common scheduling, assignment, estimate, privacy, and tag fields.

Input Parameters

string
required
Task name.
array
Existing Teamwork tag IDs to attach.
string
Task due date as YYYY-MM-DD.
boolean
Whether the task should be private.
string
Task start date as YYYY-MM-DD.
string
Plain-text task description.
boolean
Allow Teamwork entity-update webhooks for this request.
integer
required
ID of the task list that will contain the task.
boolean
Notify assignees about the new task.
array
Teamwork person IDs to assign.
integer
Estimated effort in minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_LIST_MILESTONESList visible Teamwork milestones by project, status, due-date range, assignee, or text. Returns one page and an opaque continuation cursor.

Input Parameters

array
Filter by one or more milestone statuses, such as completed, incomplete, late, today, or upcoming.
string
Only return milestones due on or after this YYYY-MM-DD date.
integer
Maximum number of milestones to return in this page (1-500).
string
Only return milestones due on or before this YYYY-MM-DD date.
string
Opaque cursor returned by a previous call. Omit for the first page and keep all filters unchanged when continuing.
array
Only return milestones in these Teamwork projects.
string
Filter milestones by name or description.
array
Only return milestones assigned to these Teamwork people.
boolean
Include completed milestones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_LIST_PEOPLEList people visible to the connected Teamwork user for assignment and ownership workflows.

Input Parameters

integer
Maximum people to return in this page (1-500).
string ("account" | "collaborator" | "contact")
Filter by account, collaborator, or contact.
string
Opaque cursor returned by a previous call; omit for the first page.
array
Only return people associated with these project IDs.
string
Filter people by name or other text indexed by Teamwork.
boolean
Include client users.
boolean
Include collaborator users.
boolean
Include service accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_LIST_PROJECTSList projects visible to the connected Teamwork user, with focused filters for name, status, company, membership, and archival state. Returns one page and an opaque continuation cursor.

Input Parameters

integer
Maximum number of projects to return in this page (1-500).
array
Return projects belonging to these Teamwork company IDs.
string
Opaque cursor returned by a previous call. Omit for the first page and keep all filters unchanged when continuing.
string
Filter projects by name.
string
Only return projects updated after this ISO 8601 timestamp.
boolean
Include archived projects in the results.
boolean
Only return projects where the connected user has explicit membership.
array
Filter by one or more project statuses: active, current, late, upcoming, completed, or deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_LIST_TAGSList Teamwork tags visible to the connected user, optionally filtered by project, item type, name, or usage. Returns one page and an opaque continuation cursor.

Input Parameters

string ("all" | "project" | "task" | "tasklist" | "milestone" | "message" | "comment" | "timelog" | "file" | "user" | "company" | "invoice" | "risk" | "notebook" | "link" | "event" | "notebookversion" | "fileversion")
Filter tag usage by item type, such as project, task, tasklist, milestone, timelog, user, or company.
integer
Maximum number of tags to return in this page (1-500).
string
Opaque cursor returned by a previous call. Omit for the first page and keep all filters unchanged when continuing.
array
Only return tags associated with these projects. Installation-wide tags may have project ID 0.
boolean
When true, return recently used tags instead of all accessible tags.
string
Filter tags by name.
boolean
Include each tag’s usage count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_LIST_TASK_LISTSList Teamwork task lists, usually within one or more projects, so an agent can place or locate tasks.

Input Parameters

integer
Maximum task lists in this page (1-500).
string
Opaque cursor returned by a previous call; omit for the first page.
array
Only return task lists in these projects.
string
Filter task lists by name.
boolean
Include task lists that contain no tasks.
string
Only return task lists updated after this ISO 8601 timestamp.
boolean
Include completed task lists.
boolean
Include task lists from archived projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_LIST_TASKSList and filter Teamwork tasks by project, task list, assignee, dates, completion state, or tags. Returns one page and an opaque cursor for continuation.

Input Parameters

array
Only return tasks carrying these tag IDs.
string
Only return tasks due on or after this YYYY-MM-DD date.
integer
Maximum tasks in this page (1-500).
string
Only return tasks due on or before this YYYY-MM-DD date.
string
Opaque cursor returned by a previous call; omit for the first page.
array
Only return tasks in these projects.
string
Filter by task text.
string ("all" | "anytime" | "completed" | "created" | "overdue" | "today" | "yesterday" | "started" | "tomorrow" | "thisweek" | "within7" | "within14" | "within30" | "within365" | "nodate" | "noduedate" | "nostartdate" | "newTaskDefaults" | "hasDate")
Teamwork date or state preset used to select a predefined task window.
array
Only return tasks in these task lists.
array
Only return tasks assigned to these people.
boolean
Include completed tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_LIST_TIME_ENTRIESList accessible Teamwork time entries by project, task, person, date range, billing state, or tags. Returns one page and an opaque continuation cursor.

Input Parameters

array
Only return time entries with these tag IDs.
string
Only return entries on or before this ISO 8601 date-time.
array
Only return time entries linked to these tasks.
array
Only return time entries for these people.
integer
Maximum time entries in this page (1-500).
string
Only return entries on or after this ISO 8601 date-time.
string
Opaque cursor returned by a previous call; omit for the first page.
array
Only return time entries for these projects.
string ("all" | "billable" | "non-billable")
Filter by all, billable, or non-billable entries.
string ("all" | "invoiced" | "noninvoiced")
Filter by all, invoiced, or noninvoiced entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_LOG_TIME_ENTRYLog time against a Teamwork task with a date, duration, optional start time, description, person, billing state, and tags without changing task status.

Input Parameters

string
required
Date worked as YYYY-MM-DD.
integer
Whole hours worked (0 or greater).
boolean
Whether date and start_time should be interpreted as UTC.
integer
Additional minutes worked (0-59).
array
Tag IDs to attach to the time entry.
integer
required
ID of the task receiving the time entry.
integer
Person ID to attribute the entry to; omit for the connected user when Teamwork permits.
string
Optional local start time as HH:MM:SS.
string
Description of the work performed.
boolean
Whether the time is billable.
boolean
Allow Teamwork entity-update webhooks for this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_SEARCH_RESOURCESSearch across Teamwork projects, tasks, task lists, milestones, people, companies, time entries, and other supported item types. Returns one page of lightweight references, optional sideloaded details, and a continuation cursor.

Input Parameters

integer
Maximum number of matches to return in this page.
array
Resource types to search. Use all or one or more supported types such as projects, tasks, tasklists, milestones, users, companies, or timelogs.
string ("relevance" | "date")
Order results by relevance or date.
integer
Restrict results to one Teamwork project ID.
string
Opaque cursor returned by a previous call. Omit for the first page; the cursor retains and enforces all filters from the original search.
string
required
Text to search for.
string
Only search items updated after this ISO 8601 timestamp. Omit to use Teamwork’s default search window.
array
Sideload full objects for selected result types, such as projects, tasks, tasklists, milestones, users, companies, or timelogs.
boolean
Include completed tasks, task lists, and milestones.
boolean
Include results from archived projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TEAMWORK_UPDATE_TASKUpdate selected fields of an existing Teamwork task while leaving omitted task fields unchanged.

Input Parameters

string
Replacement task name.
array
Replace attached tag IDs.
integer
required
ID of the task to update.
string
Replacement due date as YYYY-MM-DD.
integer
Completion percentage from 0 to 100.
boolean
Set whether the task is private.
string
Replacement start date as YYYY-MM-DD.
string
Replacement plain-text description.
boolean
Allow Teamwork entity-update webhooks for this request.
boolean
Notify assignees about the update.
array
Replace task assignees with these Teamwork person IDs.
integer
Replacement estimate in minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not