Skip to main content
New to Corsair? See API access, authentication, and error handling.

Board Cards

delete

boardCards.delete Remove a card from the board. Risk: destructive
Input
Output

get

boardCards.get Get one board card. Risk: read
Input
Output

list

boardCards.list List the cards in a board column. Risk: read
Input
Output

move

boardCards.move Move a card to another column. Risk: write
Input
Output: empty object

update

boardCards.update Update a board card. Risk: write
Input
Output

Board Columns

create

boardColumns.create Create a board column. Risk: write
Input
Output

delete

boardColumns.delete Delete a board column. Risk: destructive
Input
Output

get

boardColumns.get Get one board column. Risk: read
Input
Output

list

boardColumns.list List the board columns of a project (needs Boards on for the project). Risk: read
Input
Output

update

boardColumns.update Update a board column. Risk: write
Input
Output

Comments

create

comments.create Comment on a task, milestone, file, notebook or link. Teamwork notifies the people in notify. Risk: write
Input
Output

delete

comments.delete Delete a comment. Risk: destructive
Input
Output

get

comments.get Get one comment. Risk: read
Input
Output

list

comments.list List comments across tasks, milestones, files, notebooks and links. Filter with objectIds, projectIds, userIds. Risk: read
Input
Output

listNotified

comments.listNotified List the users notified about a comment. Risk: read
Input
Output

markRead

comments.markRead Mark a comment as read. Risk: write
Input
Output

update

comments.update Edit a comment. Risk: write
Input
Output

Companies

addDomains

companies.addDomains Add email domains to a company. Risk: write
Input
Output

convertCurrency

companies.convertCurrency Convert a company’s currency, rewriting its rates and budgets. Risk: destructive
Input
Output: undefined \| object

create

companies.create Create a company. Risk: write
Input
Output

delete

companies.delete Delete a company. Risk: destructive
Input
Output: undefined \| object

deleteDomain

companies.deleteDomain Delete a company email domain. Risk: destructive
Input
Output: undefined \| object

get

companies.get Get one company. Risk: read
Input
Output

list

companies.list List companies. Risk: read
Input
Output

listForProject

companies.listForProject List the companies on a project. Risk: read
Input
Output

setRates

companies.setRates Set a company’s client rates per role. Risk: write
Input
Output

update

companies.update Update a company. Risk: write
Input
Output

updateDomain

companies.updateDomain Update a company email domain. Risk: write
Input
Output

File Categories

create

fileCategories.create Create a file category. Risk: write
Input
Output

delete

fileCategories.delete Delete a file category. Risk: destructive
Input
Output

get

fileCategories.get Get one file category. Risk: read
Input
Output

list

fileCategories.list List a project’s file categories. Risk: read
Input
Output

update

fileCategories.update Update a file category. Risk: write
Input
Output

Files

addToProject

files.addToProject Attach an uploaded file (pendingFileRef) to a project. Risk: write
Input
Output

addToTask

files.addToTask Attach an uploaded file (pendingFileRef) to a task. Risk: write
Input
Output

addVersion

files.addVersion Add a new version to a file. Risk: write
Input
Output

copy

files.copy Copy a file to another project. Risk: write
Input
Output

delete

files.delete Delete a file. Risk: destructive
Input
Output
files.getShareLink Get a short share link for a file. Risk: read
Input
Output

listForProject

files.listForProject List the files on a project. Risk: read
Input
Output

listForTask

files.listForTask List the files on a task. Risk: read
Input
Output

create

linkCategories.create Create a link category. Risk: write
Input
Output

delete

linkCategories.delete Delete a link category. Risk: destructive
Input
Output

get

linkCategories.get Get one link category. Risk: read
Input
Output

list

linkCategories.list List a project’s link categories. Risk: read
Input
Output

create

links.create Add a link to a project. Risk: write
Input
Output

delete

links.delete Delete a link. Risk: destructive
Input
Output

get

links.get Get one link. Risk: read
Input
Output

list

links.list List links across all projects. Risk: read
Input
Output

listForProject

links.listForProject List the links on a project. Risk: read
Input
Output

update

links.update Update a link. Risk: write
Input
Output

Milestones

complete

milestones.complete Mark a milestone complete. Risk: write
Input
Output

create

milestones.create Create a milestone in a project. Risk: write
Input
Output

delete

milestones.delete Delete a milestone (it goes to the trash). Risk: destructive
Input
Output

get

milestones.get Get one milestone. Risk: read
Input
Output

list

milestones.list List milestones. Filter with projectIds, assignedToUserIds, tagIds and more. Risk: read
Input
Output

listByDeadline

milestones.listByDeadline List milestones due in a date range. Risk: read
Input
Output

uncomplete

milestones.uncomplete Reopen a completed milestone. Risk: write
Input
Output

update

milestones.update Update a milestone. Risk: write
Input
Output

Notebook Categories

create

notebookCategories.create Create a notebook category. Risk: write
Input
Output

delete

notebookCategories.delete Delete a notebook category. Risk: destructive
Input
Output

get

notebookCategories.get Get one notebook category. Risk: read
Input
Output

list

notebookCategories.list List a project’s notebook categories. Risk: read
Input
Output

update

notebookCategories.update Update a notebook category. Risk: write
Input
Output

Notebooks

copy

notebooks.copy Copy a notebook to another project. Risk: write
Input
Output

create

notebooks.create Create a notebook in a project. Risk: write
Input
Output

delete

notebooks.delete Delete a notebook. Risk: destructive
Input
Output: undefined \| object

deleteVersions

notebooks.deleteVersions Delete notebook versions. Risk: destructive
Input
Output: undefined \| object

get

notebooks.get Get one notebook with its contents. Risk: read
Input
Output

getVersion

notebooks.getVersion Get one version of a notebook. Risk: read
Input
Output

list

notebooks.list List notebooks. Filter with projectIds, categoryIds, tagIds. Risk: read
Input
Output

listVersions

notebooks.listVersions List a notebook’s versions. Risk: read
Input
Output

lock

notebooks.lock Lock a notebook for editing. Risk: write
Input
Output

move

notebooks.move Move a notebook to another project. Risk: write
Input
Output

unlock

notebooks.unlock Unlock a notebook. Risk: write
Input
Output

update

notebooks.update Update a notebook. Risk: write
Input
Output

People

addToProjects

people.addToProjects Add one user to many projects at once. Risk: write
Input
Output

create

people.create Add a user to the site. Teamwork emails them an invitation unless sendInvite is false. Risk: destructive
Input
Output

delete

people.delete Delete a user. Risk: destructive
Input
Output: undefined \| object

get

people.get Get one person. Risk: read
Input
Output

list

people.list List people. Filter with projectIds, companyIds, teamIds, searchTerm and more. Risk: read
Input
Output

listDeleted

people.listDeleted List deleted users. Risk: read
Input
Output

me

people.me Get the user the API key belongs to. Risk: read
Input
Output

myStats

people.myStats Summary counts for the current user (tasks, milestones, messages). Risk: read
Input
Output

performance

people.performance The users who completed the most tasks. Risk: read
Input
Output

taskCompletion

people.taskCompletion Task completions per user. Risk: read
Input
Output

update

people.update Update a user. Risk: write
Input
Output

utilization

people.utilization User utilization for a date range. Risk: read
Input
Output

Personal Tasks

create

personalTasks.create Create a personal task. Risk: write
Input
Output

get

personalTasks.get Get one personal task. Risk: read
Input
Output

list

personalTasks.list List the current user’s personal tasks. Risk: read
Input
Output

Portfolio Boards

create

portfolioBoards.create Create a portfolio board. Risk: write
Input
Output

delete

portfolioBoards.delete Delete a portfolio board. Risk: destructive
Input
Output

list

portfolioBoards.list List portfolio boards. Risk: read
Input
Output

update

portfolioBoards.update Update a portfolio board. Risk: write
Input
Output

Portfolio Cards

add

portfolioCards.add Add a project to a portfolio column. Risk: write
Input
Output

delete

portfolioCards.delete Remove a project card from a portfolio column. Risk: destructive
Input
Output

get

portfolioCards.get Get one portfolio card. Risk: read
Input
Output

list

portfolioCards.list List the project cards in a portfolio column. Risk: read
Input
Output

move

portfolioCards.move Move a project card to another column. Risk: write
Input
Output

Portfolio Columns

create

portfolioColumns.create Add a column to a portfolio board. Risk: write
Input
Output

delete

portfolioColumns.delete Delete a portfolio column. Risk: destructive
Input
Output

get

portfolioColumns.get Get one portfolio column. Risk: read
Input
Output

list

portfolioColumns.list List the columns of a portfolio board. Risk: read
Input
Output

Project Categories

create

projectCategories.create Create a project category. Risk: write
Input
Output

delete

projectCategories.delete Delete a project category. Risk: destructive
Input
Output

get

projectCategories.get Get one project category. Risk: read
Input
Output

list

projectCategories.list List project categories. Risk: read
Input
Output

update

projectCategories.update Rename or move a project category. Risk: write
Input
Output

Project Metrics

billable

projectMetrics.billable Total billable time per project. Risk: read
Input
Output

health

projectMetrics.health Health summary across projects. Risk: read
Input
Output

invoices

projectMetrics.invoices Open invoices across projects. Risk: read
Input
Output

unbilled

projectMetrics.unbilled Unbilled expenses across projects. Risk: read
Input
Output

Project People

add

projectPeople.add Add people to a project. Risk: write
Input
Output

get

projectPeople.get Get one person’s membership on a project. Risk: read
Input
Output

getPermissions

projectPeople.getPermissions Get a person’s permissions on a project. Risk: read
Input
Output

list

projectPeople.list List the people on a project. Risk: read
Input
Output

remove

projectPeople.remove Remove a person from a project. Risk: destructive
Input
Output

Project Roles

delete

projectRoles.delete Delete a project role. Risk: destructive
Input
Output

get

projectRoles.get Get one project role. Risk: read
Input
Output

list

projectRoles.list List the roles on a project. Risk: read
Input
Output

update

projectRoles.update Update a project role. Risk: write
Input
Output

Projects

clone

projects.clone Copy a project, optionally with its tasks, milestones and people. Risk: write
Input
Output

convertTentative

projects.convertTentative Convert a tentative project into a normal project. Risk: write
Input
Output

create

projects.create Create a project. Risk: write
Input
Output

delete

projects.delete Delete a project. Risk: destructive
Input
Output

get

projects.get Get one project by id. Risk: read
Input
Output

getRates

projects.getRates Get a project’s billable rates per user. Risk: read
Input
Output

getStats

projects.getStats Get task and milestone counts for a project. Risk: read
Input
Output

list

projects.list List projects. Filter with projectIds, projectCompanyIds, projectCategoryIds, projectStatuses, searchTerm and more. Risk: read
Input
Output

listStarred

projects.listStarred List the projects the current user has starred. Risk: read
Input
Output

listTaskPredecessors

projects.listTaskPredecessors List every task dependency (predecessor) in a project. Risk: read
Input
Output

setRates

projects.setRates Set a project’s billable rates. Risk: write
Input
Output

star

projects.star Star a project for the current user. Risk: write
Input
Output

update

projects.update Update a project’s name, dates, owner, category or settings. Risk: write
Input
Output

Project Templates

create

projectTemplates.create Create a project template. Risk: write
Input
Output

get

projectTemplates.get Get one project template. Risk: read
Input
Output

list

projectTemplates.list List project templates. Risk: read
Input
Output

listRequiredCustomFields

projectTemplates.listRequiredCustomFields List the custom fields a template requires when a project is made from it. Risk: read
Input
Output

Project Updates

create

projectUpdates.create Post a status update on a project. Notifies the people in notifyIds. Risk: destructive
Input
Output

delete

projectUpdates.delete Delete a project update. Risk: destructive
Input
Output

list

projectUpdates.list List project status updates. Filter with projectIds. Risk: read
Input
Output

request

projectUpdates.request Ask the project owner for a status update. Notifies the owner. Risk: destructive
Input
Output

update

projectUpdates.update Edit a project update. Risk: destructive
Input
Output

Statuses

create

statuses.create Set a person’s status. Risk: write
Input
Output: empty object

delete

statuses.delete Delete a status by id. Risk: destructive
Input
Output

getForPerson

statuses.getForPerson Get a person’s status. Risk: read
Input
Output

getMine

statuses.getMine Get the current user’s status. Risk: read
Input
Output

list

statuses.list List everyone’s current status. Risk: read
Input
Output

timeline

statuses.timeline The people status timeline. Risk: read
Input
Output

update

statuses.update Update a status by id. Risk: write
Input
Output

Tasklists

copy

tasklists.copy Copy a task list, within its project or to another. Risk: write
Input
Output

create

tasklists.create Create a task list in a project. Risk: write
Input
Output

delete

tasklists.delete Delete a task list and its tasks. Risk: destructive
Input
Output

get

tasklists.get Get one task list. Risk: read
Input
Output

list

tasklists.list List task lists. Filter with projectIds. Risk: read
Input
Output

listTemplates

tasklists.listTemplates List task list templates. Risk: read
Input
Output

move

tasklists.move Move a task list to another project. Risk: write
Input
Output

reorder

tasklists.reorder Reorder the task lists in a project. Risk: write
Input
Output

update

tasklists.update Update a task list. Risk: write
Input
Output

Task Reminders

create

taskReminders.create Add a reminder to a task. Teamwork emails or messages the people it names when it fires. Risk: destructive
Input
Output

delete

taskReminders.delete Delete a task reminder. Risk: destructive
Input
Output: undefined \| object

list

taskReminders.list List the reminders on a task. Risk: read
Input
Output

update

taskReminders.update Change a reminder’s time, type or note. To change who gets it, delete it and add a new one. Risk: write
Input
Output

Tasks

complete

tasks.complete Mark a task complete. Risk: write
Input
Output

copy

tasks.copy Copy a task to another project or task list. Risk: write
Input
Output

countCompleted

tasks.countCompleted Count completed tasks. Risk: read
Input
Output

countLate

tasks.countLate Count late tasks. Risk: read
Input
Output

create

tasks.create Create a task in a task list. Risk: write
Input
Output

createSubtask

tasks.createSubtask Create a subtask under a task. Risk: write
Input
Output

delete

tasks.delete Delete a task (it goes to the trash). Risk: destructive
Input
Output: undefined \| object

get

tasks.get Get one task. Risk: read
Input
Output

list

tasks.list List tasks. Filter with projectIds, tasklistIds, parentTaskId, responsiblePartyIds, tagIds, completedOnly/includeCompletedTasks, due dates and more. Risk: read
Input
Output

listDependencies

tasks.listDependencies List the tasks that depend on a task. Risk: read
Input
Output

listPredecessors

tasks.listPredecessors List the tasks a task waits on. Risk: read
Input
Output

listRecurring

tasks.listRecurring List the repeats of a recurring task. Risk: read
Input
Output

move

tasks.move Move a task to another project or task list. Risk: write
Input
Output

quickAdd

tasks.quickAdd Add several tasks to a project at once from lines of text. Risk: write
Input
Output

quickAddSubtasks

tasks.quickAddSubtasks Add several subtasks to a task at once from lines of text. Risk: write
Input
Output

reorder

tasks.reorder Reorder the tasks in a task list. Risk: write
Input
Output

setEstimate

tasks.setEstimate Set a task’s time estimate. Risk: write
Input
Output

timeReport

tasks.timeReport Report of time logged against tasks. Risk: read
Input
Output

uncomplete

tasks.uncomplete Reopen a completed task. Risk: write
Input
Output

update

tasks.update Update a task (only the fields you send change). Risk: write
Input
Output

Teams

create

teams.create Create a team. Risk: write
Input
Output

createForProject

teams.createForProject Create a project-specific team. Risk: write
Input
Output

delete

teams.delete Delete a team. Risk: destructive
Input
Output

get

teams.get Get one team. Risk: read
Input
Output

list

teams.list List teams. Risk: read
Input
Output

listForCompany

teams.listForCompany List a company’s teams. Risk: read
Input
Output

listForPerson

teams.listForPerson List the teams a person is in. Risk: read
Input
Output

listForProject

teams.listForProject List the teams on a project. Risk: read
Input
Output

listMemberIds

teams.listMemberIds The user ids in every team. Risk: read
Input
Output

listSubteams

teams.listSubteams List a team’s subteams. Risk: read
Input
Output

setMembers

teams.setMembers Add members to a team, or replace all of them (action defaults to replace). Risk: destructive
Input
Output

update

teams.update Update a team. Risk: write
Input
Output

Time

byCompany

time.byCompany Time entries grouped by company. Risk: read
Input
Output

create

time.create Log time on a project. Risk: write
Input
Output

createForTask

time.createForTask Log time on a task. Risk: write
Input
Output

delete

time.delete Delete a time entry. Risk: destructive
Input
Output: undefined \| object

estimatedTotals

time.estimatedTotals Estimated time totals per project. Risk: read
Input
Output

get

time.get Get one time entry. Risk: read
Input
Output

list

time.list List time entries. Filter with projectIds, taskIds, tasklistIds, assignedToUserIds, startDate/endDate and more. Risk: read
Input
Output

loggedByPerson

time.loggedByPerson Time a person logged, by day. Risk: read
Input
Output

report

time.report Time report for a date range (startDate and endDate required). Risk: read
Input
Output

reportByType

time.reportByType Time report grouped by user, project, company or task. Risk: read
Input
Output

reportTotals

time.reportTotals Time report totals for a date range. Risk: read
Input
Output

totals

time.totals Total logged time. Filter with projectIds, tasklistIds, taskIds, userIds. Risk: read
Input
Output

update

time.update Update a time entry (only the fields you send change). Risk: write
Input
Output

validate

time.validate Check whether a time entry can be logged (needs time approvals on the plan). Risk: read
Input
Output

Timers

complete

timers.complete Stop a timer and log its time. Risk: write
Input
Output

create

timers.create Start a timer. Risk: write
Input
Output

delete

timers.delete Delete a timer. Risk: destructive
Input
Output: undefined \| object

get

timers.get Get one timer. Risk: read
Input
Output

list

timers.list List running timers. Filter with userId, projectId, taskId. Risk: read
Input
Output

listMine

timers.listMine List the current user’s timers. Risk: read
Input
Output

pause

timers.pause Pause a timer. Risk: write
Input
Output

resume

timers.resume Resume a paused timer. Risk: write
Input
Output

undelete

timers.undelete Restore a deleted timer. Risk: write
Input
Output: undefined \| object

update

timers.update Edit a timer. Risk: write
Input
Output