API Data Provider - Online Help

Teamwork Tables

The provider models the data in API as a list of tables in a relational database that can be queried using standard SQL statements.

Teamwork Tables

Name Description
Account Retrieves details about the Teamwork account.
Activities Lists the latest activity across all projects ordered chronologically.
ArchivedMessages Retrieves archived messages.
Boards Retrieves the list of boards in your portfolio view.
CalendarEvents Returns all calendar events that the current user can see in the provided date range.
ClockIns Retrieves a list of clock in/out logs per person.
ColumnCards Retrieves the existing Cards inside a Column.
Columns Retrieves all existing Columns in your Boards view.
Companies Retrieves a list of all of the companies.
CommentLikes Retrieves likes on a comment.
CommentReactions Returns reactions on a specific comment.
Comments Retrieves a list of all of comments accros resources.
Companies Retrieves a list of all of the companies.
CompanyPeople Retrieves the details for all the people from the submitted company (excluding those you don't have permission to see).
CompletedTasks Retrieve completed Tasks in the last 1 month. You can use the CompletedDate to go further back in time.
CurrentUser Returns the details for the account you're currently logged in with.
CurrentUserStats Returns summary details for the user including Tasks today/late/upcoming, Permissions, Events, Milestones, Projects.
Expenses Retrieves a list of all of the expenses accros projects.
File Returns all details about an individual file. Crucially - this call also returns the download URL which is valid only for an hour.
FileCategories Retrieves all the file categories for your project.
FilePeople Returns available people for a project files.
Invoice Retrieves details about an invoice.
Invoices Retrieves a list of all of the invoices.
LinkCategories Retrieves all the message categories for your project
LinkPeople Returns available people for a project links.
Links Retrieves all links on projects that the authenticated user is associated with.
MessageCategories Retrieves all the message categories for your project
MessagePeople Returns available people for messages of a project.
MessageReactions Returns reactions to a message.
MessageReplies Retrieves replies to a specific message.
MessageReplyLikes Retrieves likes on a message reply.
Messages Retrieves latest messages.
MilestonePeople Returns available people for milestones of a project.
Milestones Lists all milestones on projects that the authenticated user is associated with.
MilestoneTags Retrieves all tags for a milestone.
MyStatus Returns the latest status post for the current user.
Notebook Retrieves details about a specific notebook.
NotebookCategories Retrieves all the notebook categories for your project
NotebookPeople Returns available people for a project notebooks.
Notebooks Retrieves all notebooks on projects that the authenticated user is associated with.
People Returns all people visible to the user, including the user themselves.
Permissions Return the details and permissions for a given user on a given project.
PersonStatus Returns the latest status post for a user.
ProjectActivities Lists the latest activity for a specific project.
ProjectCategories Returns all the categories.
ProjectCategoryTasks Returns tasks which are inside the projects in the cateogory.
ProjectCompanies Retrieves all of the companies within the specified project.
ProjectExpenses Retrieves all expenses associated with one project by passing in the project id.
ProjectFiles Returns the list of files for a project.
ProjectLinks Returns the list of links on a project.
ProjectMilestones Lists all milestones on a specific project.
ProjectNotebooks Retrieves a list of notebooks on a project.
ProjectPeople Returns all of the people in a given project.
ProjectRates Lists the rates for a specific project.
ProjectRisks Retrieves all risks in a project.
ProjectRoles Return all tasks on a specific project.
Projects Retrieves all accessible projects. Default returns your active projects.
ProjectStats Returns all stats for that given project.
ProjectTags Retrieves all tags for a project.
ProjectTasklists Return all task lists on a specific project.
ProjectTasks Return all tasks on a specific project.
ProjectTimeEntries Return all time entries on a specific project.
ProjectUpdates Return all project updates.
RecentUpdate Return the most recent update along with the project health.
Risks Retrieves risks across all projects.
StarredProjects Retrieves all of your projects, which have been starred.
Statuses All of the latest status posts are returned for all users in the parent company.
Subtasks Return the sub tasks of a task.
Tags Retrieves all tags.
TaskDependencies This will list any other Tasks that rely on this task to be completed first.
TaskFiles Returns the list of files for a task.
TaskFollowers Returns a list of users that are following the activity of a given task.
Tasklists Return all task lists on your site across all projects.
TasklistTasks Return all tasks on a specific tasklist.
TaskPeople Returns available people for a project tasks.
TaskPredecessors Returns task predecessors. A task which has predecessors cannot be completed unless they are first, so they are essentially blocking a task.
TaskReactions Returns comment reactions on a task.
TaskReminders Retrieves all reminders on a specific task.
Tasks Return all tasks on your site across all projects.
TaskTags Retrieves all tags for a task.
TaskTimeEntries Retrieves all of the time entries from a submitted todo item.
TimeEntries Retrieves time entries for all projects.
WebhookEvents Retrieves a list of all webhooks events that can be used.
Webhooks Retrieves a list of all of the companies.
Workload Retrieves the workload across all projects

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0