Open Connector
All tools

Teamwork logoTeamwork

No catalog description yet.

teamworkvcatalog-v1409 tools

Authentication

MethodKindStatusDetails
OAuth 2.0oauth2available

Call a tool

import { createClient } from "@open-connector/sdk";const oc = createClient({  baseUrl: "https://api.openconnector.dev",  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({  slug: "TEAMWORK_DELETE_PROJECTS_API_V3_ACTIVITY_ACTIVITY_LOG_ID_JSON",  connectedAccountId: "conn_...",  arguments: { /* match this tool's input schema */ },});
import Composio from "@composio/client";const composio = new Composio({  baseURL: "https://api.openconnector.dev/composio",  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("TEAMWORK_DELETE_PROJECTS_API_V3_ACTIVITY_ACTIVITY_LOG_ID_JSON", {  connected_account_id: "conn_...",  arguments: { /* match this tool's input schema */ },});
oc tools execute TEAMWORK_DELETE_PROJECTS_API_V3_ACTIVITY_ACTIVITY_LOG_ID_JSON --data '{ }'

Tool catalog

Available tools

409 callable operations

Deletes an activity item.TEAMWORK_DELETE_PROJECTS_API_V3_ACTIVITY_ACTIVITY_LOG_ID_JSONDeletes an activity item.

Deletes an activity item.

Authentication

Connected account required

Tags

Activity
Delete an existing notification.TEAMWORK_DELETE_PROJECTS_API_V3_BUDGET_NOTIFICATIONS_NOTIFICATION_ID_JSONDelete an existing notification.

Delete an existing notification.

Authentication

Connected account required

Tags

Budgets
Delete an existing calendar.TEAMWORK_DELETE_PROJECTS_API_V3_CALENDARS_ID_JSONDelete an existing Calendar.

Delete an existing Calendar.

Authentication

Connected account required

Tags

Calendars
Delete an existing company custom field value.TEAMWORK_DELETE_PROJECTS_API_V3_COMPANIES_COMPANY_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONRemoves a company custom field value.

Removes a company custom field value.

Authentication

Connected account required

Tags

CustomFields
Delete an existing company.TEAMWORK_DELETE_PROJECTS_API_V3_COMPANIES_COMPANY_ID_JSONDelete a company.

Delete a company.

Authentication

Connected account required

Tags

Companies
Delete an existing company domain.TEAMWORK_DELETE_PROJECTS_API_V3_COMPANIES_DOMAINS_ID_JSONRemoves a company domain. It's still possible to recover the job role. Marks all related company domains assignments as deleted.

Removes a company domain. It's still possible to recover the job role. Marks all related company domains assignments as deleted.

Authentication

Connected account required

Tags

Companies
Delete an existing container.TEAMWORK_DELETE_PROJECTS_API_V3_CONTAINERS_ID_JSONRemoves a container by its ID. This will permanently delete the container and all its associated widgets.

Removes a container by its ID. This will permanently delete the container and all its associated widgets.

Authentication

Connected account required

Tags

Containers
Delete a custom exchange rateTEAMWORK_DELETE_PROJECTS_API_V3_CUSTOM_EXCHANGE_RATES_ID_JSONSoft-delete a custom exchange rate.

Soft-delete a custom exchange rate.

Authentication

Connected account required

Tags

ExchangeRate
Delete an existing custom fieldTEAMWORK_DELETE_PROJECTS_API_V3_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONRemoves a custom field.

Removes a custom field.

Authentication

Connected account required

Tags

CustomFields
Delete an existing custom item field.TEAMWORK_DELETE_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_ID_JSONDelete a custom item field.

Delete a custom item field.

Authentication

Connected account required

Tags

CustomItems
Delete an existing custom item field optionTEAMWORK_DELETE_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_ID_OPTIONS_OPTION_ID_JSONDelete an existing custom item field option

Delete an existing custom item field option

Authentication

Connected account required

Tags

CustomItems
Delete an existing custom item.TEAMWORK_DELETE_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_JSONDelete a custom item.

Delete a custom item.

Authentication

Connected account required

Tags

CustomItems
Delete a custom item record.TEAMWORK_DELETE_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_RECORDS_ID_JSONDelete a custom item record.

Delete a custom item record.

Authentication

Connected account required

Tags

CustomItems
Delete an existing custom item field value.TEAMWORK_DELETE_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_RECORDS_RECORD_ID_FIELDS_ID_JSONDelete a custom item field value.

Delete a custom item field value.

Authentication

Connected account required

Tags

CustomItems
Delete a custom item section.TEAMWORK_DELETE_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_SECTIONS_ID_JSONDelete a custom item section.

Delete a custom item section.

Authentication

Connected account required

Tags

CustomItems
Delete an existing form.TEAMWORK_DELETE_PROJECTS_API_V3_FORMS_FORM_ID_JSONDelete an existing form.

Delete an existing form.

Authentication

Connected account required

Tags

Forms
Delete an existing job role.TEAMWORK_DELETE_PROJECTS_API_V3_JOBROLES_ID_JSONRemoves a job role. It's still possible to recover the job role. Marks all related job role assignments as deleted.

Removes a job role. It's still possible to recover the job role. Marks all related job role assignments as deleted.

Authentication

Connected account required

Tags

JobRoles
Remove a user from a job role.TEAMWORK_DELETE_PROJECTS_API_V3_JOBROLES_ID_PEOPLE_JSONDeletes one or more users from the given job role.

Deletes one or more users from the given job role.

Authentication

Connected account required

Tags

JobRoles
Delete a timer by IDTEAMWORK_DELETE_PROJECTS_API_V3_ME_TIMERS_TIMER_ID_JSONDelete an existing timer.

Delete an existing timer.

Authentication

Connected account required

Tags

TimeTracking
Delete an existing notebook.TEAMWORK_DELETE_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_JSONDelete an existing notebook.

Delete an existing notebook.

Authentication

Connected account required

Tags

Notebooks
Delete notebook versions.TEAMWORK_DELETE_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_VERSIONS_JSONDeletes some existing versions of a notebook by version ID.

Deletes some existing versions of a notebook by version ID.

Authentication

Connected account required

Tags

Notebooks
Delete an existing person.TEAMWORK_DELETE_PROJECTS_API_V3_PEOPLE_PERSON_ID_JSONDelete a person.

Delete a person.

Authentication

Connected account required

Tags

People
Deletes a projects activity log.TEAMWORK_DELETE_PROJECTS_API_V3_PROJECTS_PROJECT_ID_ACTIVITY_JSONDeletes a projects activity log.

Deletes a projects activity log.

Authentication

Connected account required

Tags

Activity
Delete an existing project custom field value.TEAMWORK_DELETE_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONRemoves a project custom field value.

Removes a project custom field value.

Authentication

Connected account required

Tags

CustomFields
Remove an existing workflow from a project.TEAMWORK_DELETE_PROJECTS_API_V3_PROJECTS_PROJECT_ID_WORKFLOWS_JSONRemove an existing workflow from a project.

Remove an existing workflow from a project.

Authentication

Connected account required

Tags

Workflows
Delete a quote.TEAMWORK_DELETE_PROJECTS_API_V3_QUOTE_ID_JSONDelete a quote.

Delete a quote.

Authentication

Connected account required

Tags

Quotes
Deletes quote line items.TEAMWORK_DELETE_PROJECTS_API_V3_QUOTE_QUOTE_ID_LINEITEM_ID_JSONDeletes quote line items.

Deletes quote line items.

Authentication

Connected account required

Tags

Quotes
Delete a custom report.TEAMWORK_DELETE_PROJECTS_API_V3_REPORTING_CUSTOM_ID_JSONDeletes the custom report identified by `id`.

Deletes the custom report identified by `id`.

Authentication

Connected account required

Tags

CustomReports
Delete a scheduled report.TEAMWORK_DELETE_PROJECTS_API_V3_REPORTING_REPORT_ID_JSONDeletes the scheduled report identified by `reportId`.

Deletes the scheduled report identified by `reportId`.

Authentication

Connected account required

Tags

Reports
Delete an existing risk.TEAMWORK_DELETE_PROJECTS_API_V3_RISKS_RISK_ID_JSONDelete a risk.

Delete a risk.

Authentication

Connected account required

Tags

Risks
Delete an existing skill.TEAMWORK_DELETE_PROJECTS_API_V3_SKILLS_ID_JSONRemoves a skill. It's still possible to recover the skill. Marks all related skill assignments as deleted.

Removes a skill. It's still possible to recover the skill. Marks all related skill assignments as deleted.

Authentication

Connected account required

Tags

Skills
Remove a skill from a user.TEAMWORK_DELETE_PROJECTS_API_V3_SKILLS_ID_PEOPLE_JSONDeletes a skill from one or more users.

Deletes a skill from one or more users.

Authentication

Connected account required

Tags

Skills
Remove a skill from a user.TEAMWORK_DELETE_PROJECTS_API_V3_SKILLS_ID_PEOPLE_USER_ID_JSONDeletes a skill from a single user.

Deletes a skill from a single user.

Authentication

Connected account required

Tags

Skills
Deletes a tagTEAMWORK_DELETE_PROJECTS_API_V3_TAGS_TAG_ID_JSONRemoves a tag. If there's no tag with the given ID the status code 409 (CONFLICT) will be returned.

Removes a tag. If there's no tag with the given ID the status code 409 (CONFLICT) will be returned.

Authentication

Connected account required

Tags

Tags
Delete an existing tasklist.TEAMWORK_DELETE_PROJECTS_API_V3_TASKLISTS_TASKLIST_ID_JSONDelete an existing tasklist.

Delete an existing tasklist.

Authentication

Connected account required

Tags

Tasklists
Delete an existing task custom field value.TEAMWORK_DELETE_PROJECTS_API_V3_TASKS_TASK_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONRemoves a task custom field value.

Removes a task custom field value.

Authentication

Connected account required

Tags

CustomFields
Delete an existing task.TEAMWORK_DELETE_PROJECTS_API_V3_TASKS_TASK_ID_JSONDelete a task and its subtasks.

Delete a task and its subtasks.

Authentication

Connected account required

Tags

Tasks
Delete task reminderTEAMWORK_DELETE_PROJECTS_API_V3_TASKS_TASK_ID_REMINDERS_REMINDER_ID_JSONDeletes an existing reminder for a task.

Deletes an existing reminder for a task.

Authentication

Connected account required

Tags

TaskReminders
Delete an existing timelog.TEAMWORK_DELETE_PROJECTS_API_V3_TIME_TIMELOG_ID_JSONDelete a timelog.

Delete a timelog.

Authentication

Connected account required

Tags

TimeTracking
Delete an existing workflow.TEAMWORK_DELETE_PROJECTS_API_V3_WORKFLOWS_ID_JSONDeletes an existing workflow.

Deletes an existing workflow.

Authentication

Connected account required

Tags

Workflows
Delete an existing stage.TEAMWORK_DELETE_PROJECTS_API_V3_WORKFLOWS_WORKFLOW_ID_STAGES_STAGE_ID_JSONDelete a workflow stage with the given id and migrate tasks to another stage.

Delete a workflow stage with the given id and migrate tasks to another stage.

Authentication

Connected account required

Tags

Workflows
Get time entries for a specific allocationTEAMWORK_GET_PROJECTS_API_V3_ALLOCATIONS_ALLOCATION_ID_TIME_JSONReturn logged time entries for a specific allocation. Only the time entries that the logged-in user can access will be returned.

Return logged time entries for a specific allocation. Only the time entries that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TimeTracking
Generate agenda report in CSV formatTEAMWORK_GET_PROJECTS_API_V3_CALENDAR_EVENTS_CSVGenerates an agenda report in CSV format containing all the events for the provided filters.

Generates an agenda report in CSV format containing all the events for the provided filters.

Authentication

Connected account required

Tags

CalendarEvents
Generate agenda report in HTML formatTEAMWORK_GET_PROJECTS_API_V3_CALENDAR_EVENTS_HTMLGenerates an agenda report in HTML format containing all the events for the provided filters.

Generates an agenda report in HTML format containing all the events for the provided filters.

Authentication

Connected account required

Tags

CalendarEvents
Generate agenda report in PDF formatTEAMWORK_GET_PROJECTS_API_V3_CALENDAR_EVENTS_PDFGenerates an agenda report in PDF format containing all the events for the provided filters.

Generates an agenda report in PDF format containing all the events for the provided filters.

Authentication

Connected account required

Tags

CalendarEvents
Generate agenda report in XLSX formatTEAMWORK_GET_PROJECTS_API_V3_CALENDAR_EVENTS_XLSXGenerates an agenda report in XLSX format containing all the events for the provided filters.

Generates an agenda report in XLSX format containing all the events for the provided filters.

Authentication

Connected account required

Tags

CalendarEvents
Get a specific calendar event.TEAMWORK_GET_PROJECTS_API_V3_CALENDARS_CALENDAR_ID_EVENTS_EVENT_ID_JSONReturns a single event.

Returns a single event.

Authentication

Connected account required

Tags

CalendarEvents
Get all calendar events.TEAMWORK_GET_PROJECTS_API_V3_CALENDARS_CALENDAR_ID_EVENTS_JSONGet all events.

Get all events.

Authentication

Connected account required

Tags

CalendarEvents
Get a specific calendar.TEAMWORK_GET_PROJECTS_API_V3_CALENDARS_CALENDAR_ID_JSONReturns a single calendar.

Returns a single calendar.

Authentication

Connected account required

Tags

Calendars
Get all calendar events.TEAMWORK_GET_PROJECTS_API_V3_CALENDARS_EVENTS_JSONGet all events.

Get all events.

Authentication

Connected account required

Tags

CalendarEvents
Get all calendars.TEAMWORK_GET_PROJECTS_API_V3_CALENDARS_JSONGet all calendars.

Get all calendars.

Authentication

Connected account required

Tags

Calendars
Get a specific calendar event.TEAMWORK_GET_PROJECTS_API_V3_CALENDARS_PRIMARY_EVENTS_EVENT_ID_JSONReturns a single event.

Returns a single event.

Authentication

Connected account required

Tags

CalendarEvents
Get all calendar events.TEAMWORK_GET_PROJECTS_API_V3_CALENDARS_PRIMARY_EVENTS_JSONGet all events.

Get all events.

Authentication

Connected account required

Tags

CalendarEvents
Retrieve a specific commentTEAMWORK_GET_PROJECTS_API_V3_COMMENTS_ID_JSONRetrieve a specific comment

Retrieve a specific comment

Authentication

Connected account required

Tags

Comments
List users notified for a commentTEAMWORK_GET_PROJECTS_API_V3_COMMENTS_ID_NOTIFIED_JSONReturns the users that were notified when the specified comment was posted.

Returns the users that were notified when the specified comment was posted.

Authentication

Connected account required

Tags

Comments
Get a list of commentsTEAMWORK_GET_PROJECTS_API_V3_COMMENTS_JSONGet a list of comments

Get a list of comments

Authentication

Connected account required

Tags

Comments
Company custom field value.TEAMWORK_GET_PROJECTS_API_V3_COMPANIES_COMPANY_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONReturn a specific custom field value from a company.

Return a specific custom field value from a company.

Authentication

Connected account required

Tags

CustomFields
Company custom field values.TEAMWORK_GET_PROJECTS_API_V3_COMPANIES_COMPANY_ID_CUSTOMFIELDS_JSONReturn all custom field values from a specific company.

Return all custom field values from a specific company.

Authentication

Connected account required

Tags

CustomFields
Get a specific company.TEAMWORK_GET_PROJECTS_API_V3_COMPANIES_COMPANY_ID_JSONRetrieves a company by id.

Retrieves a company by id.

Authentication

Connected account required

Tags

Companies
Get all companies.TEAMWORK_GET_PROJECTS_API_V3_COMPANIES_JSONRetrieve all companies for the provided filters. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Retrieve all companies for the provided filters. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Companies
Get all time entries, grouped by company IDTEAMWORK_GET_PROJECTS_API_V3_COMPANIES_TIME_JSONReturn all logged time entries for all projects grouped by company ID. Only the time entries that the logged-in user can access will be returned.

Return all logged time entries for all projects grouped by company ID. Only the time entries that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TimeTracking
Get a list of quotes for a specific company.TEAMWORK_GET_PROJECTS_API_V3_COMPANY_ID_QUOTES_JSONGet a list of quotes for a specific company.

Get a list of quotes for a specific company.

Authentication

Connected account required

Tags

Quotes
Preview the next auto-generated quote number.TEAMWORK_GET_PROJECTS_API_V3_COMPANY_ID_QUOTES_NUMBER_PREVIEW_JSONPreview the next auto-generated quote number.

Preview the next auto-generated quote number.

Authentication

Connected account required

Tags

Quotes
Get a specific container.TEAMWORK_GET_PROJECTS_API_V3_CONTAINERS_ID_JSONThis returns all details about an individual container including its widgets and configuration.

This returns all details about an individual container including its widgets and configuration.

Authentication

Connected account required

Tags

Containers
Get insights containers for a specific route.TEAMWORK_GET_PROJECTS_API_V3_CONTAINERS_INSIGHTS_ENTITY_ENTITY_ID_ROUTE_JSONThis returns containers of type insights filtered by the specified app route. This is a convenience endpoint that automatically filters by container type. The entity-scoped variant additionally filters by the supplied entity type and entity ID.

This returns containers of type insights filtered by the specified app route. This is a convenience endpoint that automatically filters by container type. The entity-scoped variant additionally filters by the supplied entity type and entity ID.

Authentication

Connected account required

Tags

Containers
Get insights containers for a specific route.TEAMWORK_GET_PROJECTS_API_V3_CONTAINERS_INSIGHTS_JSONThis returns containers of type insights filtered by the specified app route. This is a convenience endpoint that automatically filters by container type. The entity-scoped variant additionally filters by the supplied entity type and entity ID.

This returns containers of type insights filtered by the specified app route. This is a convenience endpoint that automatically filters by container type. The entity-scoped variant additionally filters by the supplied entity type and entity ID.

Authentication

Connected account required

Tags

Containers
Get insights containers for a specific route.TEAMWORK_GET_PROJECTS_API_V3_CONTAINERS_INSIGHTS_ROUTE_JSONThis returns containers of type insights filtered by the specified app route. This is a convenience endpoint that automatically filters by container type. The entity-scoped variant additionally filters by the supplied entity type and entity ID.

This returns containers of type insights filtered by the specified app route. This is a convenience endpoint that automatically filters by container type. The entity-scoped variant additionally filters by the supplied entity type and entity ID.

Authentication

Connected account required

Tags

Containers
Get all containers.TEAMWORK_GET_PROJECTS_API_V3_CONTAINERS_JSONThis returns all containers in the installation. You can limit output by provided filters. Default data pagination is 50 items per page.

This returns all containers in the installation. You can limit output by provided filters. Default data pagination is 50 items per page.

Authentication

Connected account required

Tags

Containers
List ExchangeRate for currency pairTEAMWORK_GET_PROJECTS_API_V3_CUSTOM_EXCHANGE_RATES_FROM_CURRENCY_TO_CURRENCY_JSONGet a list of ExchangeRate for a specific currency pair with optional filters. Use the include parameter to sideload related users (creators, updaters).

Get a list of ExchangeRate for a specific currency pair with optional filters. Use the include parameter to sideload related users (creators, updaters).

Authentication

Connected account required

Tags

ExchangeRate
Get a custom exchange rateTEAMWORK_GET_PROJECTS_API_V3_CUSTOM_EXCHANGE_RATES_ID_JSONGet a single custom exchange rate by ID.

Get a single custom exchange rate by ID.

Authentication

Connected account required

Tags

ExchangeRate
List latest ExchangeRate per currency pairTEAMWORK_GET_PROJECTS_API_V3_CUSTOM_EXCHANGE_RATES_LATEST_JSONGet the most relevant exchange rate for each currency pair. Priority: 1) active rates (currently valid), 2) nearest future rate, 3) most recent past rate. Use the include parameter to sideload related users (creators, updaters).

Get the most relevant exchange rate for each currency pair. Priority: 1) active rates (currently valid), 2) nearest future rate, 3) most recent past rate. Use the include parameter to sideload related users (creators, updaters).

Authentication

Connected account required

Tags

ExchangeRate
Get live exchange rates for custom pairs.TEAMWORK_GET_PROJECTS_API_V3_CUSTOM_EXCHANGE_RATES_LIVE_JSONRetrieves live exchange rates from the Forex service for all currency pairs that have custom exchange rates defined.

Retrieves live exchange rates from the Forex service for all currency pairs that have custom exchange rates defined.

Authentication

Connected account required

Tags

ExchangeRate
Lookup a custom exchange rateTEAMWORK_GET_PROJECTS_API_V3_CUSTOM_EXCHANGE_RATES_LOOKUP_JSONFind the applicable custom exchange rate for a currency pair on a specific date.

Find the applicable custom exchange rate for a currency pair on a specific date.

Authentication

Connected account required

Tags

ExchangeRate
Get a custom field by id.TEAMWORK_GET_PROJECTS_API_V3_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONThis returns all details about an individual custom field.

This returns all details about an individual custom field.

Authentication

Connected account required

Tags

CustomFields
Get all custom fieldsTEAMWORK_GET_PROJECTS_API_V3_CUSTOMFIELDS_JSONReturn all custom fields for the provided filters.

Return all custom fields for the provided filters.

Authentication

Connected account required

Tags

CustomFields
Get a custom item field by id.TEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_ID_JSONThis returns all details about an individual custom item field.

This returns all details about an individual custom item field.

Authentication

Connected account required

Tags

CustomItems
Get custom item fields for a specific custom itemTEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_JSONReturn all custom item fields for a specific custom item.

Return all custom item fields for a specific custom item.

Authentication

Connected account required

Tags

CustomItems
Get a custom item by id.TEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_JSONThis returns all details about an individual custom item.

This returns all details about an individual custom item.

Authentication

Connected account required

Tags

CustomItems
Get a list of comments for a custom item recordTEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_RECORDS_ID_COMMENTS_JSONGet a list of comments for a custom item record

Get a list of comments for a custom item record

Authentication

Connected account required

Tags

CustomItemRecordComments
Get a custom item record by ID.TEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_RECORDS_ID_JSONReturn all details about an individual custom item record.

Return all details about an individual custom item record.

Authentication

Connected account required

Tags

CustomItems
Get custom item records for a specific custom itemTEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_RECORDS_JSONReturn all custom item records for a specific custom item.

Return all custom item records for a specific custom item.

Authentication

Connected account required

Tags

CustomItems
Get a custom item section by ID.TEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_SECTIONS_ID_JSONReturn all details about an individual custom item section.

Return all details about an individual custom item section.

Authentication

Connected account required

Tags

CustomItems
Get custom item sections for a specific itemTEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_SECTIONS_JSONReturn all custom item sections for a specific custom item.

Return all custom item sections for a specific custom item.

Authentication

Connected account required

Tags

CustomItems
Get a record by ID.TEAMWORK_GET_PROJECTS_API_V3_CUSTOMITEMS_RECORDS_ID_JSONReturn all details about an individual custom item record.

Return all details about an individual custom item record.

Authentication

Connected account required

Tags

CustomItems
Get all dashboardsTEAMWORK_GET_PROJECTS_API_V3_DASHBOARDS_JSONReturn all dashboards that the logged-in user can access. Dashboards contains panels that are used to summarize many activities from the installation.

Return all dashboards that the logged-in user can access. Dashboards contains panels that are used to summarize many activities from the installation.

Authentication

Connected account required

Tags

Dashboards
Get all exchange rates for a base currencyTEAMWORK_GET_PROJECTS_API_V3_EXCHANGE_RATES_BASE_CURRENCY_JSONRetrieves all current exchange rates for the specified base currency from the Forex service.

Retrieves all current exchange rates for the specified base currency from the Forex service.

Authentication

Connected account required

Tags

ExchangeRate
Get exchange rate for a currency pairTEAMWORK_GET_PROJECTS_API_V3_EXCHANGE_RATES_FROM_CURRENCY_TO_CURRENCY_JSONRetrieves the exchange rate between two currencies for a specific date (or today if not specified). Uses the user's timezone to determine "today" when no date is provided.

Retrieves the exchange rate between two currencies for a specific date (or today if not specified). Uses the user's timezone to determine "today" when no date is provided.

Authentication

Connected account required

Tags

ExchangeRate
Get installation featuresTEAMWORK_GET_PROJECTS_API_V3_FEATURES_JSONReturn all features accessible to the current installation.

Return all features accessible to the current installation.

Authentication

Connected account required

Tags

Features
Get a list of comments for a fileTEAMWORK_GET_PROJECTS_API_V3_FILES_FILE_ID_COMMENTS_JSONGet a list of comments for a file

Get a list of comments for a file

Authentication

Connected account required

Tags

FileComments
Get the parent project for a specific file.TEAMWORK_GET_PROJECTS_API_V3_FILES_FILE_ID_PROJECT_JSONReturns the project that the given file belongs to. The id refers to the `projects_files.id` (not a file version).

Returns the project that the given file belongs to. The id refers to the `projects_files.id` (not a file version).

Authentication

Connected account required

Tags

Files
Get a list of comments for a file versionTEAMWORK_GET_PROJECTS_API_V3_FILEVERSIONS_ID_COMMENTS_JSONGet a list of comments for a file version

Get a list of comments for a file version

Authentication

Connected account required

Tags

FileVersionComments
Get the draft version of a specific form.TEAMWORK_GET_PROJECTS_API_V3_FORMS_FORM_ID_DRAFT_JSONGet the draft version of a specific form.

Get the draft version of a specific form.

Authentication

Connected account required

Tags

Forms
Get a specific form.TEAMWORK_GET_PROJECTS_API_V3_FORMS_FORM_ID_JSONGet a specific form.

Get a specific form.

Authentication

Connected account required

Tags

Forms
Get all forms.TEAMWORK_GET_PROJECTS_API_V3_FORMS_JSONReturn a list of all forms.

Return a list of all forms.

Authentication

Connected account required

Tags

Forms
Get a forms via its token.TEAMWORK_GET_PROJECTS_API_V3_FORMS_PUBLIC_TOKEN_JSONThis endpoint does not require authentication.

This endpoint does not require authentication.

Authentication

Connected account required

Tags

FormsPublic
Pre-signed upload URL for form attachments.TEAMWORK_GET_PROJECTS_API_V3_FORMS_PUBLIC_TOKEN_PRESIGNEDURL_JSONReturns a pre-signed URL that the form submitter can use to upload a file attachment directly to the storage backend, scoped to the public form identified by the token.

Returns a pre-signed URL that the form submitter can use to upload a file attachment directly to the storage backend, scoped to the public form identified by the token.

Authentication

Connected account required

Tags

FormsPublic
Get stats about ImportersTEAMWORK_GET_PROJECTS_API_V3_IMPORTER_STATS_JSONThis endpoint returns info about a set of importers. This includes whether they are individually running or not, what's their status and a flag to represent if any importer is running. The endpoint looks up redis for this information. Using the parameter resetImporters this information can be deleted in redis to reset it.

This endpoint returns info about a set of importers. This includes whether they are individually running or not, what's their status and a flag to represent if any importer is running. The endpoint looks up redis for this information. Using the parameter resetImporters this information can be deleted in redis to reset it.

Authentication

Connected account required

Tags

Importers
Get utilization insights by report type.TEAMWORK_GET_PROJECTS_API_V3_INSIGHTS_UTILIZATION_TYPE_JSONReturns utilization data scoped to the supplied report type (user, team, job role, dashboard variants, etc.). Supports the same filters as the people utilization endpoint.

Returns utilization data scoped to the supplied report type (user, team, job role, dashboard variants, etc.). Supports the same filters as the people utilization endpoint.

Authentication

Connected account required

Tags

Utilization
Get a specific job role.TEAMWORK_GET_PROJECTS_API_V3_JOBROLES_JOB_ROLE_ID_JSONThis returns all details about an individual job role. When include users all users that are assigned to that role will be side loaded

This returns all details about an individual job role. When include users all users that are assigned to that role will be side loaded

Authentication

Connected account required

Tags

JobRoles
Get all job roles.TEAMWORK_GET_PROJECTS_API_V3_JOBROLES_JSONThis returns all job roles along installation. You can limit output by provided filters. Default data pagination is 50 items per page. When include users all users that are assigned to that role will be side loaded

This returns all job roles along installation. You can limit output by provided filters. Default data pagination is 50 items per page. When include users all users that are assigned to that role will be side loaded

Authentication

Connected account required

Tags

JobRoles
Latest activity (all projects)TEAMWORK_GET_PROJECTS_API_V3_LATESTACTIVITY_JSONLists the latest activity across all projects ordered chronologically. When you log into Teamwork you will see all the recent activity. This corresponds to that view in Teamwork. There are parameters you can send in to filter your results.

Lists the latest activity across all projects ordered chronologically. When you log into Teamwork you will see all the recent activity. This corresponds to that view in Teamwork. There are parameters you can send in to filter your results.

Authentication

Connected account required

Tags

Activity
Get a list of comments for a link itemTEAMWORK_GET_PROJECTS_API_V3_LINKS_LINK_ID_COMMENTS_JSONGet a list of comments for a link item

Get a list of comments for a link item

Authentication

Connected account required

Tags

LinkItems
Get the parent project for a specific link item.TEAMWORK_GET_PROJECTS_API_V3_LINKS_LINK_ID_PROJECT_JSONReturns the project that the given link item belongs to.

Returns the project that the given link item belongs to.

Authentication

Connected account required

Tags

LinkItems
Get logged user informationTEAMWORK_GET_PROJECTS_API_V3_ME_JSONGet logged user information

Get logged user information

Authentication

Connected account required

Tags

People
Get a specific personal task.TEAMWORK_GET_PROJECTS_API_V3_ME_PERSONALTASKS_ID_JSONReturns the personal task with the provided id for the logged-in user. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Returns the personal task with the provided id for the logged-in user. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Tasks
Get the current user's personal tasks.TEAMWORK_GET_PROJECTS_API_V3_ME_PERSONALTASKS_JSONReturns the personal tasks for the logged-in user. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Returns the personal tasks for the logged-in user. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Tasks
Get all your running timersTEAMWORK_GET_PROJECTS_API_V3_ME_TIMERS_JSONWill get all your running timers or the person you are logged in as.

Will get all your running timers or the person you are logged in as.

Authentication

Connected account required

Tags

TimeTracking
Get a specific message replyTEAMWORK_GET_PROJECTS_API_V3_MESSAGEREPLIES_ID_JSONReturns a specific message reply, identified by its id.

Returns a specific message reply, identified by its id.

Authentication

Connected account required

Tags

MessageReplies
Get all repliesTEAMWORK_GET_PROJECTS_API_V3_MESSAGEREPLIES_JSONReturn all replies for messages the user has access to.

Return all replies for messages the user has access to.

Authentication

Connected account required

Tags

MessageReplies
Get all messages.TEAMWORK_GET_PROJECTS_API_V3_MESSAGES_JSONRetrieve all messages for the provided filters.

Retrieve all messages for the provided filters.

Authentication

Connected account required

Tags

Messages
Get a specific message.TEAMWORK_GET_PROJECTS_API_V3_MESSAGES_MESSAGE_ID_JSONRetrieves a message by id.

Retrieves a message by id.

Authentication

Connected account required

Tags

Messages
Get the parent project for a specific message.TEAMWORK_GET_PROJECTS_API_V3_MESSAGES_MESSAGE_ID_PROJECT_JSONReturns the project that the given message belongs to.

Returns the project that the given message belongs to.

Authentication

Connected account required

Tags

Messages
Get all replies to a given messageTEAMWORK_GET_PROJECTS_API_V3_MESSAGES_MESSAGE_ID_REPLIES_JSONReturn all replies for a given message, identified by its id.

Return all replies for a given message, identified by its id.

Authentication

Connected account required

Tags

MessageReplies
Get all milestonesTEAMWORK_GET_PROJECTS_API_V3_MILESTONES_JSONAll milestones are returned on projects that the authenticated user is associated with. You can use the provided filters to return only those milestones that are incomplete, completed, upcoming or late. All milestones are returning in this call. This call uses pagination, returning 100 milestones per page by default.

All milestones are returned on projects that the authenticated user is associated with. You can use the provided filters to return only those milestones that are incomplete, completed, upcoming or late. All milestones are returning in this call. This call uses pagination, returning 100 milestones per page by default.

Authentication

Connected account required

Tags

Milestones
Get milestones by due date in a time rangeTEAMWORK_GET_PROJECTS_API_V3_MILESTONES_METRICS_DEADLINES_JSONCount the number of milestones on each deadline date. Only the milestones that the logged-in user can access will be included in the counting.

Count the number of milestones on each deadline date. Only the milestones that the logged-in user can access will be included in the counting.

Authentication

Connected account required

Tags

Milestones
Get a list of comments for a milestoneTEAMWORK_GET_PROJECTS_API_V3_MILESTONES_MILESTONE_ID_COMMENTS_JSONGet a list of comments for a milestone

Get a list of comments for a milestone

Authentication

Connected account required

Tags

MilestoneComments
Get a milestone by id.TEAMWORK_GET_PROJECTS_API_V3_MILESTONES_MILESTONE_ID_JSONThis returns all details about an individual milestone.

This returns all details about an individual milestone.

Authentication

Connected account required

Tags

Milestones
Get the parent project for a specific milestone.TEAMWORK_GET_PROJECTS_API_V3_MILESTONES_MILESTONE_ID_PROJECT_JSONReturns the project that the given milestone belongs to.

Returns the project that the given milestone belongs to.

Authentication

Connected account required

Tags

Milestones
Get a list of notebooks.TEAMWORK_GET_PROJECTS_API_V3_NOTEBOOKS_JSONGet a list of notebooks.

Get a list of notebooks.

Authentication

Connected account required

Tags

Notebooks
Get a list of comments for a notebookTEAMWORK_GET_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_COMMENTS_JSONGet a list of comments for a notebook

Get a list of comments for a notebook

Authentication

Connected account required

Tags

NotebookComments
Compare 2 notebook versionsTEAMWORK_GET_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_COMPARE_JSONGets the contents diff between the contents of 2 notebook versions

Gets the contents diff between the contents of 2 notebook versions

Authentication

Connected account required

Tags

Notebooks
Get a specific notebook.TEAMWORK_GET_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_JSONGet a specific notebook.

Get a specific notebook.

Authentication

Connected account required

Tags

Notebooks
Get the parent project for a specific notebook.TEAMWORK_GET_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_PROJECT_JSONReturns the project that the given notebook belongs to.

Returns the project that the given notebook belongs to.

Authentication

Connected account required

Tags

Notebooks
Get notebook versionsTEAMWORK_GET_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_VERSIONS_JSONGet a list of a notebooks versions.

Get a list of a notebooks versions.

Authentication

Connected account required

Tags

Notebooks
Get a notebook versionTEAMWORK_GET_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_VERSIONS_VERSION_ID_JSONGet a specific notebook version.

Get a specific notebook version.

Authentication

Connected account required

Tags

Notebooks
Returns a list of peopleTEAMWORK_GET_PROJECTS_API_V3_PEOPLE_JSONRetrieve all people for the provided filters.

Retrieve all people for the provided filters.

Authentication

Connected account required

Tags

People
Performance of users completing the most tasksTEAMWORK_GET_PROJECTS_API_V3_PEOPLE_METRICS_PERFORMANCE_JSONCount the number of completed tasks by user for the provided period. By default the user with the most completed tasks is shown first.

Count the number of completed tasks by user for the provided period. By default the user with the most completed tasks is shown first.

Authentication

Connected account required

Tags

People
Returns a personTEAMWORK_GET_PROJECTS_API_V3_PEOPLE_PERSON_ID_JSONRetrieve a person record.

Retrieve a person record.

Authentication

Connected account required

Tags

People
Return the user utilization.TEAMWORK_GET_PROJECTS_API_V3_PEOPLE_UTILIZATION_JSONVerify the user utilization.

Verify the user utilization.

Authentication

Connected account required

Tags

People
Get price plan by plan IDTEAMWORK_GET_PROJECTS_API_V3_PLANS_JSONReturn price plans and associated features.

Return price plans and associated features.

Authentication

Connected account required

Tags

PricePlans
Get a single price plan by IDTEAMWORK_GET_PROJECTS_API_V3_PLANS_PLAN_ID_JSONReturn a single price plan and its associated features.

Return a single price plan and its associated features.

Authentication

Connected account required

Tags

PricePlans
Get a specific project categoryTEAMWORK_GET_PROJECTS_API_V3_PROJECTCATEGORIES_CATEGORY_ID_JSONGet a specific project category

Get a specific project category

Authentication

Connected account required

Tags

Categories
Returns a list of project categoriesTEAMWORK_GET_PROJECTS_API_V3_PROJECTCATEGORIES_JSONReturns a list of project categories

Returns a list of project categories

Authentication

Connected account required

Tags

Categories
Get all tasklist budgets in a project budget.TEAMWORK_GET_PROJECTS_API_V3_PROJECTS_BUDGETS_ID_TASKLISTS_BUDGETS_JSONGet a list of tasklist budgets information.

Get a list of tasklist budgets information.

Authentication

Connected account required

Tags

Budgets
Get health scores for projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_HEALTH_JSONCalculate and return health scores for projects. If no project IDs are provided, returns health scores for all projects the user has access to.

Calculate and return health scores for projects. If no project IDs are provided, returns health scores for all projects the user has access to.

Authentication

Connected account required

Tags

ProjectHealth
Returns a list of projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_JSONRetrieve all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Retrieve all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
Get the total count of active projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_METRICS_ACTIVE_JSONReturn the number of active projects that the logged-in user can access.

Return the number of active projects that the logged-in user can access.

Authentication

Connected account required

Tags

Projects
Get the total billable time per projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_METRICS_BILLABLE_JSONReturns the total billable time of all projects that the logged-in user has access.

Returns the total billable time of all projects that the logged-in user has access.

Authentication

Connected account required

Tags

Projects
Get a health summary for all projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_METRICS_HEALTHS_JSONReturn the number of projects on each health category. It will only count the projects that the logged-in user can access.

Return the number of projects on each health category. It will only count the projects that the logged-in user can access.

Authentication

Connected account required

Tags

Projects
Return open invoices across all projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_METRICS_INVOICES_JSONCount the number of open invoices on all projects that the logged-in user has access.

Count the number of open invoices on all projects that the logged-in user has access.

Authentication

Connected account required

Tags

Projects
Get number of owned and un-assigned projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_METRICS_OWNERS_JSONCount the number of projects per project owner user.

Count the number of projects per project owner user.

Authentication

Connected account required

Tags

Projects
Return un-billed expenses across all projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_METRICS_UNBILLED_JSONReturn the un-billed expenses for each project that the logged-in user has access.

Return the un-billed expenses for each project that the logged-in user has access.

Authentication

Connected account required

Tags

Projects
Project custom field value.TEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONReturn a specific custom field value from a project.

Return a specific custom field value from a project.

Authentication

Connected account required

Tags

CustomFields
Project custom field values.TEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMFIELDS_JSONReturn all custom field values from a specific project.

Return all custom field values from a specific project.

Authentication

Connected account required

Tags

CustomFields
Get custom items for a specific projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMITEMS_JSONReturn all custom items for a specific project. Only filters that the logged-in user has access will be returned.

Return all custom items for a specific project. Only filters that the logged-in user has access will be returned.

Authentication

Connected account required

Tags

CustomItems
Returns a project features order to display in tabTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_FEATUREORDER_JSONReturns a project features order to display in tab

Returns a project features order to display in tab

Authentication

Connected account required

Tags

Projects
Returns a projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_JSONOn this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
List latest activity for a specific project.TEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_LATESTACTIVITY_JSONLists the latest activity for a specific project. When you access a project you will see all the recent activity. This corresponds to that view in Teamwork. There is some parameters you can send in to filter your results.

Lists the latest activity for a specific project. When you access a project you will see all the recent activity. This corresponds to that view in Teamwork. There is some parameters you can send in to filter your results.

Authentication

Connected account required

Tags

Activity
Get milestones in a projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_MILESTONES_JSONThis lets you query the list of milestones for a project. You can use the provided filters to return only those milestones that are incomplete, completed, upcoming or late. This call uses pagination, returning 100 milestones per page by default.

This lets you query the list of milestones for a project. You can use the provided filters to return only those milestones that are incomplete, completed, upcoming or late. This call uses pagination, returning 100 milestones per page by default.

Authentication

Connected account required

Tags

Milestones
Returns a list of people on a projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_PEOPLE_JSONRetrieve all people on the project.

Retrieve all people on the project.

Authentication

Connected account required

Tags

People
Returns a person on a projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_PEOPLE_PERSON_ID_JSONRetrieve a person record.

Retrieve a person record.

Authentication

Connected account required

Tags

People
Get risks for a specific projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_RISKS_JSONReturn all risks for a specific project. Only filters that the logged-in user has access will be returned.

Return all risks for a specific project. Only filters that the logged-in user has access will be returned.

Authentication

Connected account required

Tags

Risks
Generate tasklist report in CSV formatTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TASKLISTS_CSVGenerates a task list report in CSV format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Generates a task list report in CSV format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TaskLists
Generate tasklist report in HTML formatTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TASKLISTS_HTMLGenerates a task list report in HTML format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Generates a task list report in HTML format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TaskLists
Get tasklists in a projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TASKLISTS_JSONGet tasklists in a project

Get tasklists in a project

Authentication

Connected account required

Tags

TaskLists
Generate tasklist report in PDF formatTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TASKLISTS_PDFGenerates a task list report in PDF format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Generates a task list report in PDF format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TaskLists
Generate tasklist report in XLSX formatTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TASKLISTS_XLSXGenerates a task list report in XLSX format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Generates a task list report in XLSX format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TaskLists
Get a specific project's tasks.TEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TASKS_JSONReturn multiple tasks according to the provided filter. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Return multiple tasks according to the provided filter. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Tasks
Get time entries for a specific projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TIME_JSONReturn logged time entries for a specific project. Only the time entries that the logged-in user can access will be returned.

Return logged time entries for a specific project. Only the time entries that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TimeTracking
Get timelog totals for a specific project.TEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TIME_TOTAL_JSONGet timelog totals for a specific project.

Get timelog totals for a specific project.

Authentication

Connected account required

Tags

TimeTracking
Get all workflows.TEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_ID_WORKFLOWS_JSONReturns all workflows. When a project ID is supplied the result is scoped to workflows linked to that project.

Returns all workflows. When a project ID is supplied the result is scoped to workflows linked to that project.

Authentication

Connected account required

Tags

Workflows
Get project summary dashboardTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_IDS_SUMMARY_JSONRetrieves the summary from a specific project, returning counters about tasks, milestones, columns, events, risks, timers, projects healths. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Retrieves the summary from a specific project, returning counters about tasks, milestones, columns, events, risks, timers, projects healths. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Summary
Get all updates from a specific projectTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_PROJECT_IDS_UPDATES_JSONReturn the updates from a specific project.

Return the updates from a specific project.

Authentication

Connected account required

Tags

ProjectUpdates
Returns a list of starred projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_STARRED_JSONRetrieve all starred projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Retrieve all starred projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
Returns a list of teamwork project categoriesTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_TEAMWORK_CATEGORIES_JSONReturns a list of teamwork project categories

Returns a list of teamwork project categories

Authentication

Connected account required

Tags

Categories
Returns a list of teamwork sample projectsTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_TEAMWORK_SAMPLES_JSONRetrieve all sample projects for the provided filters.

Retrieve all sample projects for the provided filters.

Authentication

Connected account required

Tags

Projects
Get required custom fields for a project templateTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_TEMPLATES_ID_CUSTOMFIELDS_REQUIRED_JSONReturns the list of custom fields that are marked as required for the given project template.

Returns the list of custom fields that are marked as required for the given project template.

Authentication

Connected account required

Tags

Projects
Returns a project templateTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_TEMPLATES_ID_JSONRetrieve a single project template by its ID. Only project templates that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Retrieve a single project template by its ID. Only project templates that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
Returns a list of projects templatesTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_TEMPLATES_JSONRetrieve all projects templates for the provided filters. Only the projects templates that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Retrieve all projects templates for the provided filters. Only the projects templates that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
Get all project updatesTEAMWORK_GET_PROJECTS_API_V3_PROJECTS_UPDATES_JSONReturn the updates from all projects that the logged-in user can access.

Return the updates from all projects that the logged-in user can access.

Authentication

Connected account required

Tags

ProjectUpdates
Get export preferences for a quote.TEAMWORK_GET_PROJECTS_API_V3_QUOTE_ID_EXPORT_PREFERENCES_JSONGet export preferences for a quote.

Get export preferences for a quote.

Authentication

Connected account required

Tags

QuoteExportPreferences
Get a quote by ID.TEAMWORK_GET_PROJECTS_API_V3_QUOTE_ID_JSONGet a quote by ID.

Get a quote by ID.

Authentication

Connected account required

Tags

Quotes
Get a list of quotes across all companies.TEAMWORK_GET_PROJECTS_API_V3_QUOTES_JSONBy default, only non-template quotes are returned; pass `?isTemplate=true` to list templates instead.

By default, only non-template quotes are returned; pass `?isTemplate=true` to list templates instead.

Authentication

Connected account required

Tags

Quotes
Get quote settings for the current installation.TEAMWORK_GET_PROJECTS_API_V3_QUOTESETTINGS_JSONGet quote settings for the current installation.

Get quote settings for the current installation.

Authentication

Connected account required

Tags

QuoteSettings
Get custom report builder metadata.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_CUSTOM_BUILDER_JSONReturns the metadata required to build a custom report (available sources, columns, filters and custom fields).

Returns the metadata required to build a custom report (available sources, columns, filters and custom fields).

Authentication

Connected account required

Tags

CustomReports
Get a custom report's data.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_CUSTOM_ID_DATA_JSONReturns the data rows for the custom report. When `reportFormat` is set, an export (csv, xlsx, pdf, html, googlesheets) is generated instead of the JSON response; google sheets exports return a redirect to the spreadsheet.

Returns the data rows for the custom report. When `reportFormat` is set, an export (csv, xlsx, pdf, html, googlesheets) is generated instead of the JSON response; google sheets exports return a redirect to the spreadsheet.

Authentication

Connected account required

Tags

CustomReports
Get a custom report by ID.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_CUSTOM_ID_JSONReturns a single custom report. Supports side-loading of related entities (users, teams, projects, etc).

Returns a single custom report. Supports side-loading of related entities (users, teams, projects, etc).

Authentication

Connected account required

Tags

CustomReports
List custom reports.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_CUSTOM_JSONReturns the custom reports available for the current user. Supports pagination, filtering, sorting and side-loading of related entities.

Returns the custom reports available for the current user. Supports pagination, filtering, sorting and side-loading of related entities.

Authentication

Connected account required

Tags

CustomReports
Get budget chart data.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DATA_BUDGETS_JSONThis returns data for a budget chart, using the provided filters, group by, split by and data points.

This returns data for a budget chart, using the provided filters, group by, split by and data points.

Authentication

Connected account required

Tags

Containers
Get estimation totals.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DATA_ESTIMATION_JSONReturns aggregate counts of overestimated, underestimated, and within-margin tasks along with the overall estimation accuracy score for the given filters.

Returns aggregate counts of overestimated, underestimated, and within-margin tasks along with the overall estimation accuracy score for the given filters.

Authentication

Connected account required

Tags

Estimation
Get milestone chart data.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DATA_MILESTONES_JSONThis returns aggregated milestone data for a chart, using the provided filters, group by, split by and data points.

This returns aggregated milestone data for a chart, using the provided filters, group by, split by and data points.

Authentication

Connected account required

Tags

Milestones
Get project chart data.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DATA_PROJECTS_JSONThis returns data for a project chart, using the provided filters, group by, split by and data points.

This returns data for a project chart, using the provided filters, group by, split by and data points.

Authentication

Connected account required

Tags

Containers
Get risk chart data.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DATA_RISKS_JSONThis returns aggregated risk data for a chart, using the provided filters, group by, split by and data points.

This returns aggregated risk data for a chart, using the provided filters, group by, split by and data points.

Authentication

Connected account required

Tags

Risks
Get task chart data.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DATA_TASKS_JSONThis returns data for a task chart, using the provided filters, group by, split by and data points.

This returns data for a task chart, using the provided filters, group by, split by and data points.

Authentication

Connected account required

Tags

Containers
Get timelog chart data.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DATA_TIMELOGS_JSONThis returns aggregated timelog data for a chart, using the provided filters, group by, split by and data points.

This returns aggregated timelog data for a chart, using the provided filters, group by, split by and data points.

Authentication

Connected account required

Tags

Timelogs
Get budget chart details.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DETAILS_BUDGETS_JSONThis returns a list of budgets matching a budget chart filter. Used for quick views and similar UI elements

This returns a list of budgets matching a budget chart filter. Used for quick views and similar UI elements

Authentication

Connected account required

Tags

Containers
Get estimation details.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DETAILS_ESTIMATION_JSONReturns a paginated list of completed tasks with their estimated vs logged time, accuracy score, and assignees. Supports filtering by status, project, company, task list, and free-text search. Sorting and sideloading of related entities (users, tasks, projects) are also supported.

Returns a paginated list of completed tasks with their estimated vs logged time, accuracy score, and assignees. Supports filtering by status, project, company, task list, and free-text search. Sorting and sideloading of related entities (users, tasks, projects) are also supported.

Authentication

Connected account required

Tags

Estimation
Get milestone details.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DETAILS_MILESTONES_JSONReturns a paginated list of milestones with their full entity data. Supports filtering by project, company, date range, and free-text search. Sorting and sideloading of related entities are also supported.

Returns a paginated list of milestones with their full entity data. Supports filtering by project, company, date range, and free-text search. Sorting and sideloading of related entities are also supported.

Authentication

Connected account required

Tags

Milestones
Get project chart details.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DETAILS_PROJECTS_JSONThis returns a list of projects matching a project chart filter. Used for quick views and similar UI elements

This returns a list of projects matching a project chart filter. Used for quick views and similar UI elements

Authentication

Connected account required

Tags

Containers
Get risk details.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DETAILS_RISKS_JSONReturns a paginated list of risks with their full entity data. Supports filtering by project and company, plus free-text search. Sorting and sideloading of related entities are also supported.

Returns a paginated list of risks with their full entity data. Supports filtering by project and company, plus free-text search. Sorting and sideloading of related entities are also supported.

Authentication

Connected account required

Tags

Risks
Get task chart details.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DETAILS_TASKS_JSONThis returns a list of tasks matching a task chart filter. Used for quick views and similar UI elements (the drawer behind a chart bucket).

This returns a list of tasks matching a task chart filter. Used for quick views and similar UI elements (the drawer behind a chart bucket).

Authentication

Connected account required

Tags

Containers
Get timelog details.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DASHBOARDS_DETAILS_TIMELOGS_JSONReturns a paginated list of timelogs with their full entity data. Supports filtering by project, user, company, task, task list, date range, and free-text search. Sorting and sideloading of related entities are also supported.

Returns a paginated list of timelogs with their full entity data. Supports filtering by project, user, company, task, task list, date range, and free-text search. Sorting and sideloading of related entities are also supported.

Authentication

Connected account required

Tags

Timelogs
Download a scheduled report on the fly.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_DOWNLOAD_REPORT_IDGenerates the report immediately and returns it as a file download. For Google Sheets reports the response is a redirect to the spreadsheet URL.

Generates the report immediately and returns it as a file download. For Google Sheets reports the response is a redirect to the spreadsheet URL.

Authentication

Connected account required

Tags

Reports
Get the HTML email preview for a scheduled report.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_EMAIL_REPORT_IDReturns the rendered HTML email that recipients receive for the given scheduled report. Only recipients of the report can preview the email.

Returns the rendered HTML email that recipients receive for the given scheduled report. Only recipients of the report can preview the email.

Authentication

Connected account required

Tags

Reports
Unsubscribe via the report email link.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_EMAIL_UNSUBSCRIBE_REPORT_IDEndpoint linked from scheduled report emails. Removes the current user from all future deliveries of the given report and returns an HTML confirmation page.

Endpoint linked from scheduled report emails. Removes the current user from all future deliveries of the given report and returns an HTML confirmation page.

Authentication

Connected account required

Tags

Reports
Get financial report data.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_FINANCIAL_DATA_JSONReturns aggregated financial data grouped by the requested dimensions.

Returns aggregated financial data grouped by the requested dimensions.

Authentication

Connected account required

Tags

AnalyticEngine
Get financial report totals.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_FINANCIAL_TOTALS_JSONReturns grand totals across all matching rows without pagination. groupBy is limited to at most one dimension (e.g. company or date) — the grain for averages and counts; a second dimension is rejected with a 400. Use /trends/totals for per-period summaries.

Returns grand totals across all matching rows without pagination. groupBy is limited to at most one dimension (e.g. company or date) — the grain for averages and counts; a second dimension is rejected with a 400. Use /trends/totals for per-period summaries.

Authentication

Connected account required

Tags

AnalyticEngine
Get financial report trends.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_FINANCIAL_TRENDS_JSONReturns metrics over time: the same paged set of entities repeated across each period, gap-filled with zeros. The endpoint forces date grouping; pass one or more entity dimensions in groupBy (e.g. `company` ⇒ company,date). startDate and endDate are required. orderBy accepts `name`, `<metricKey>` (aggregated over the range), or `<periodIndex>-<metricKey>` (0-based, chronological) to rank by one period's column; the candidate set is always the entities active across the full range.

Returns metrics over time: the same paged set of entities repeated across each period, gap-filled with zeros. The endpoint forces date grouping; pass one or more entity dimensions in groupBy (e.g. `company` ⇒ company,date). startDate and endDate are required. orderBy accepts `name`, `<metricKey>` (aggregated over the range), or `<periodIndex>-<metricKey>` (0-based, chronological) to rank by one period's column; the candidate set is always the entities active across the full range.

Authentication

Connected account required

Tags

AnalyticEngine
Get per-period financial report totalsTEAMWORK_GET_PROJECTS_API_V3_REPORTING_FINANCIAL_TRENDS_TOTALS_JSONThe summary rows under /trends. Returns one summary object per period over the whole filtered pool (not page-restricted): `totals` (pooled), plus `averages` and `counts` macro-aggregated over the groupBy dimension. Forces date grouping; pass exactly one non-date dimension in groupBy, which is also used as the implicit averageBy. startDate and endDate are required.

The summary rows under /trends. Returns one summary object per period over the whole filtered pool (not page-restricted): `totals` (pooled), plus `averages` and `counts` macro-aggregated over the groupBy dimension. Forces date grouping; pass exactly one non-date dimension in groupBy, which is also used as the implicit averageBy. startDate and endDate are required.

Authentication

Connected account required

Tags

AnalyticEngine
List scheduled reports.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_JSONReturns the scheduled reports available to the current user with support for pagination, filtering by source, creator, custom report and schedule status, and side-loading of recipients, creators and editors.

Returns the scheduled reports available to the current user with support for pagination, filtering by source, creator, custom report and schedule status, and side-loading of recipients, creators and editors.

Authentication

Connected account required

Tags

Reports
Get the schedule log for a scheduled report.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_LOG_SCHEDULE_ID_JSONReturns the delivery history for a given report schedule, with optional side-loaded recipient logs, users, and the upcoming planned occurrence.

Returns the delivery history for a given report schedule, with optional side-loaded recipient logs, users, and the upcoming planned occurrence.

Authentication

Connected account required

Tags

Reports
Start the Google OAuth authorization flow.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_OAUTH_GOOGLE_AUTHORIZERedirects the browser to the Google OAuth consent screen so the user can authorize Teamwork to publish scheduled reports to Google Sheets / Drive.

Redirects the browser to the Google OAuth consent screen so the user can authorize Teamwork to publish scheduled reports to Google Sheets / Drive.

Authentication

Connected account required

Tags

Reports
Unauthenticated Google OAuth callback.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_OAUTH_GOOGLE_CALLBACKPublic callback URL hosted at `authenticate.teamwork.com`. It validates and decrypts the OAuth `state` and redirects to the customer-domain callback (`/reporting/oauth/google/callback-auth`).

Public callback URL hosted at `authenticate.teamwork.com`. It validates and decrypts the OAuth `state` and redirects to the customer-domain callback (`/reporting/oauth/google/callback-auth`).

Authentication

Connected account required

Tags

Reports
Authenticated Google OAuth callback.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_OAUTH_GOOGLE_CALLBACK_AUTHCustomer-domain callback that exchanges the OAuth `code` for tokens and stores them against the current user. Returns an HTML page that posts the outcome back to the opener window and closes itself.

Customer-domain callback that exchanges the OAuth `code` for tokens and stores them against the current user. Returns an HTML page that posts the outcome back to the opener window and closes itself.

Authentication

Connected account required

Tags

Reports
Get the Google OAuth status for the current user.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_OAUTH_GOOGLE_STATUS_JSONReturns whether the current user has a valid stored Google OAuth token that can be used to publish scheduled reports to Google Sheets / Drive.

Returns whether the current user has a valid stored Google OAuth token that can be used to publish scheduled reports to Google Sheets / Drive.

Authentication

Connected account required

Tags

Reports
Get budget reportTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_BUDGET_JSONGet budget report

Get budget report

Authentication

Connected account required

Tags

BudgetReport
Get budget report totalsTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_BUDGET_TOTALS_JSONGet budget report totals

Get budget report totals

Authentication

Connected account required

Tags

BudgetReport
Get object detailsTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_BUDGET_TYPE_ID_JSONGet object details

Get object details

Authentication

Connected account required

Tags

BudgetReport
Get all time entries, grouped by company IDTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_COMPANYTIME_JSONReturn all logged time entries for all projects grouped by company ID. Only the time entries that the logged-in user can access will be returned.

Return all logged time entries for all projects grouped by company ID. Only the time entries that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TimeTracking
Generate project report in CSV formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_HEALTH_PROJECTS_CSVGenerates a project report in CSV format containing all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Generates a project report in CSV format containing all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
Generate project report in HTML formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_HEALTH_PROJECTS_HTMLGenerates a project report in HTML format containing all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Generates a project report in HTML format containing all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
Generate project report in PDF formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_HEALTH_PROJECTS_PDFGenerates a project report in PDF format containing all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Generates a project report in PDF format containing all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
Generate project report in XLSX formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_HEALTH_PROJECTS_XLSXGenerates a project report in XLSX format containing all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Generates a project report in XLSX format containing all projects for the provided filters. Only the projects that the logged-in user can access will be returned. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Projects
Generate milestone report in CSV formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_PLANNEDVSACTUAL_MILESTONES_CSVGenerates a milestone report in CSV format containing all milestones for the provided filters. Only the milestones that the logged-in user can access will be returned.

Generates a milestone report in CSV format containing all milestones for the provided filters. Only the milestones that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

Milestones
Generate milestone report in HTML formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_PLANNEDVSACTUAL_MILESTONES_HTMLGenerates a milestone report in HTML format containing all milestones for the provided filters. Only the milestones that the logged-in user can access will be returned.

Generates a milestone report in HTML format containing all milestones for the provided filters. Only the milestones that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

Milestones
Generate milestone report in PDF formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_PLANNEDVSACTUAL_MILESTONES_PDFGenerates a milestone report in PDF format containing all milestones for the provided filters. Only the milestones that the logged-in user can access will be returned.

Generates a milestone report in PDF format containing all milestones for the provided filters. Only the milestones that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

Milestones
Generate milestone report in XLSX formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_PLANNEDVSACTUAL_MILESTONES_XLSXGenerates a milestone report in XLSX format containing all milestones for the provided filters. Only the milestones that the logged-in user can access will be returned.

Generates a milestone report in XLSX format containing all milestones for the provided filters. Only the milestones that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

Milestones
Generate plannedvsactual report in CSV formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_PLANNEDVSACTUAL_TASKS_CSVGenerates a plannedvsactual report in CSV format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Generates a plannedvsactual report in CSV format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

Tasks
Generate plannedvsactual report in HTML formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_PLANNEDVSACTUAL_TASKS_HTMLGenerates a plannedvsactual report in HTML format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Generates a plannedvsactual report in HTML format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

Tasks
Generate plannedvsactual report in PDF formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_PLANNEDVSACTUAL_TASKS_PDFGenerates a plannedvsactual report in PDF format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Generates a plannedvsactual report in PDF format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

Tasks
Generate plannedvsactual report in XLSX formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_PLANNEDVSACTUAL_TASKS_XLSXGenerates a plannedvsactual report in XLSX format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Generates a plannedvsactual report in XLSX format containing all tasks for the provided filters. Only the tasks that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

Tasks
Generate a precanned task time report.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_TASKTIME_JSONReturns tasks for the precanned task time report, applying the requested filters.

Returns tasks for the precanned task time report, applying the requested filters.

Authentication

Connected account required

Tags

Tasks
Returns task completions for all usersTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_USERTASKCOMPLETION_JSONRetrieve all people for the provided filters and their task completions.

Retrieve all people for the provided filters and their task completions.

Authentication

Connected account required

Tags

People
Returns task completions for given userTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_USERTASKCOMPLETION_USER_ID_JSONRetrieve a person record and its task completion stats.

Retrieve a person record and its task completion stats.

Authentication

Connected account required

Tags

Person
Generate utilization report in CSV formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_UTILIZATION_CSVGenerates a utilization report in CSV format containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Generates a utilization report in CSV format containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

People
Generate utilization report in HTML formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_UTILIZATION_HTMLGenerates a utilization report in HTML format containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Generates a utilization report in HTML format containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

People
Generate utilization report in PDF formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_UTILIZATION_PDFGenerates a utilization report in PDF format containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Generates a utilization report in PDF format containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

People
Generate utilization report in XLSX formatTEAMWORK_GET_PROJECTS_API_V3_REPORTING_PRECANNED_UTILIZATION_XLSXGenerates a utilization report in XLSX format containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Generates a utilization report in XLSX format containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

People
Get a scheduled report by ID.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_REPORT_ID_JSONReturns a single scheduled report with its schedules and options. Supports side-loading of recipients and creators.

Returns a single scheduled report with its schedules and options. Supports side-loading of recipients and creators.

Authentication

Connected account required

Tags

Reports
List available report sources.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_REPORTSOURCES_JSONReturns the report sources (i.e. report types) available on this installation that can be used when creating a scheduled report.

Returns the report sources (i.e. report types) available on this installation that can be used when creating a scheduled report.

Authentication

Connected account required

Tags

Reports
Send a scheduled report immediately.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_SEND_SCHEDULE_ID_JSONTriggers the schedule identified by `scheduleId` to send the report to its recipients immediately, regardless of its scheduled next occurrence.

Triggers the schedule identified by `scheduleId` to send the report to its recipients immediately, regardless of its scheduled next occurrence.

Authentication

Connected account required

Tags

Reports
Download a stored report file from S3.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_STORAGEReturns a previously generated report file from S3 using an encrypted `file` path query parameter. For Google Sheets reports the response is a redirect to the spreadsheet URL.

Returns a previously generated report file from S3 using an encrypted `file` path query parameter. For Google Sheets reports the response is a redirect to the spreadsheet URL.

Authentication

Connected account required

Tags

Reports
Unsubscribe from a scheduled report.TEAMWORK_GET_PROJECTS_API_V3_REPORTING_UNSUBSCRIBE_REPORT_ID_JSONFrontend-facing endpoint that allows users without creator permissions to remove themselves from all schedules of the given report.

Frontend-facing endpoint that allows users without creator permissions to remove themselves from all schedules of the given report.

Authentication

Connected account required

Tags

Reports
Get all risksTEAMWORK_GET_PROJECTS_API_V3_RISKS_JSONReturn all risks for the provided filters. Only filters that the logged-in user has access will be returned.

Return all risks for the provided filters. Only filters that the logged-in user has access will be returned.

Authentication

Connected account required

Tags

Risks
Get a risk by id.TEAMWORK_GET_PROJECTS_API_V3_RISKS_RISK_ID_JSONThis returns all details about an individual risk.

This returns all details about an individual risk.

Authentication

Connected account required

Tags

Risks
Search items in the installation.TEAMWORK_GET_PROJECTS_API_V3_SEARCH_JSONThe search endpoint will return a list of items that match the given query.

The search endpoint will return a list of items that match the given query.

Authentication

Connected account required

Tags

Search
Get all skills.TEAMWORK_GET_PROJECTS_API_V3_SKILLS_JSONThis returns all skills along installation. You can limit output by provided filters. Default data pagination is 50 items per page. When include users all users that are assigned to that skill will be side loaded

This returns all skills along installation. You can limit output by provided filters. Default data pagination is 50 items per page. When include users all users that are assigned to that skill will be side loaded

Authentication

Connected account required

Tags

Skills
Get a specific skill.TEAMWORK_GET_PROJECTS_API_V3_SKILLS_SKILL_ID_JSONThis returns all details about an individual skill. When include users all users that are assigned to that skill will be side loaded

This returns all details about an individual skill. When include users all users that are assigned to that skill will be side loaded

Authentication

Connected account required

Tags

Skills
Get all statusesTEAMWORK_GET_PROJECTS_API_V3_STATUSES_JSONAll of the latest status posts are returned for all users in the parent company.

All of the latest status posts are returned for all users in the parent company.

Authentication

Connected account required

Tags

PeopleStatus
Get the people statuses timeline.TEAMWORK_GET_PROJECTS_API_V3_STATUSES_TIMELINE_JSONReturn a timeline list of people statuses that the logged-in user can access.

Return a timeline list of people statuses that the logged-in user can access.

Authentication

Connected account required

Tags

PeopleStatus
Get installation summary dashboardTEAMWORK_GET_PROJECTS_API_V3_SUMMARY_JSONRetrieves the summary from the entire installation, returning counters about tasks, milestones, columns, events, risks, timers, projects healths. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Retrieves the summary from the entire installation, returning counters about tasks, milestones, columns, events, risks, timers, projects healths. On this endpoint you can filter by project custom fields. The syntax for the query parameter is the following: projectCustomField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: projectCustomField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Summary
Get all tagsTEAMWORK_GET_PROJECTS_API_V3_TAGS_JSONReturn all tags that the logged-in user can access.

Return all tags that the logged-in user can access.

Authentication

Connected account required

Tags

Tags
Get details of an individual tagTEAMWORK_GET_PROJECTS_API_V3_TAGS_TAG_ID_JSONReturn a specific tag.

Return a specific tag.

Authentication

Connected account required

Tags

Tags
Get a specific taskgroup's tasks.TEAMWORK_GET_PROJECTS_API_V3_TASKGROUPS_TASKGROUP_ID_TASKS_JSONReturn multiple tasks belonging to the given taskgroup. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Return multiple tasks belonging to the given taskgroup. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Tasks
Get all tasklistsTEAMWORK_GET_PROJECTS_API_V3_TASKLISTS_JSONGet all tasklists

Get all tasklists

Authentication

Connected account required

Tags

TaskLists
Get specific tasklistTEAMWORK_GET_PROJECTS_API_V3_TASKLISTS_TASKLIST_ID_JSONGet specific tasklist

Get specific tasklist

Authentication

Connected account required

Tags

TaskLists
Get the parent project for a specific tasklist.TEAMWORK_GET_PROJECTS_API_V3_TASKLISTS_TASKLIST_ID_PROJECT_JSONReturns the project that the given tasklist belongs to.

Returns the project that the given tasklist belongs to.

Authentication

Connected account required

Tags

Tasklists
Get a specific tasklist's tasks.TEAMWORK_GET_PROJECTS_API_V3_TASKLISTS_TASKLIST_ID_TASKS_JSONReturn multiple tasks according to the provided filter. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Return multiple tasks according to the provided filter. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Tasks
Get timelog totals for a specific task.TEAMWORK_GET_PROJECTS_API_V3_TASKLISTS_TASKLIST_ID_TIME_TOTAL_JSONGet timelog totals for a specific task.

Get timelog totals for a specific task.

Authentication

Connected account required

Tags

TimeTracking
Get all tasklist templatesTEAMWORK_GET_PROJECTS_API_V3_TASKLISTS_TEMPLATES_JSONGet all tasklist templates

Get all tasklist templates

Authentication

Connected account required

Tags

TaskLists
Gets task remindersTEAMWORK_GET_PROJECTS_API_V3_TASKS_ID_REMINDERS_JSONGets all reminders for a task.

Gets all reminders for a task.

Authentication

Connected account required

Tags

TaskReminders
Get all tasks.TEAMWORK_GET_PROJECTS_API_V3_TASKS_JSONReturn multiple tasks according to the provided filter. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Return multiple tasks according to the provided filter. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Tasks
Total count of completed tasksTEAMWORK_GET_PROJECTS_API_V3_TASKS_METRICS_COMPLETE_JSONReturns the total number of completed tasks. Only the tasks that the logged-in user can access will be counted.

Returns the total number of completed tasks. Only the tasks that the logged-in user can access will be counted.

Authentication

Connected account required

Tags

Tasks
Get total count of late tasksTEAMWORK_GET_PROJECTS_API_V3_TASKS_METRICS_LATE_JSONReturns the number of late tasks. Only the tasks that the logged-in user has access to will be counted.

Returns the number of late tasks. Only the tasks that the logged-in user has access to will be counted.

Authentication

Connected account required

Tags

Tasks
Get a list of comments for a taskTEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_COMMENTS_JSONGet a list of comments for a task

Get a list of comments for a task

Authentication

Connected account required

Tags

TaskComments
Task custom field value.TEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONReturn a specific custom field value from a task.

Return a specific custom field value from a task.

Authentication

Connected account required

Tags

CustomFields
Task custom field values.TEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_CUSTOMFIELDS_JSONReturn all custom field values from a specific task.

Return all custom field values from a specific task.

Authentication

Connected account required

Tags

CustomFields
Get a specific task.TEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_JSONReturns the information about a specific task. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Returns the information about a specific task. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Tasks
Get the parent project for a specific task.TEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_PROJECT_JSONReturns the project that the given task belongs to.

Returns the project that the given task belongs to.

Authentication

Connected account required

Tags

Tasks
Get all subtasks for a specific task.TEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_SUBTASKS_JSONReturn multiple subtasks according to the provided filter. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Return multiple subtasks according to the provided filter. On this endpoint you can filter by custom fields. The syntax for the query parameter is the following: customField[id][op]=value Where: - [id] is the custom field ID - [op] is the operator to apply when filtering, different operators are allowed according to the custom field type - [value] is the value to apply when filtering For example, if I want to filter a dropdown custom field with ID 10 to only return entries that have the value "Option1" we would do the following: customField[10][eq]=Option1 The allowed operators are: - like - not-like - eq - not - lt - gt - any

Authentication

Connected account required

Tags

Tasks
Get time entries for a specific taskTEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_TIME_JSONReturn logged time entries for a specific task. Only the time entries that the logged-in user can access will be returned.

Return logged time entries for a specific task. Only the time entries that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TimeTracking
Get timelog totals for a specific task.TEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_TIME_TOTAL_JSONGet timelog totals for a specific task.

Get timelog totals for a specific task.

Authentication

Connected account required

Tags

TimeTracking
Get all calendar events.TEAMWORK_GET_PROJECTS_API_V3_TASKS_TASK_ID_TIMEBLOCKS_JSONGet all events.

Get all events.

Authentication

Connected account required

Tags

CalendarEvents
Get all time entriesTEAMWORK_GET_PROJECTS_API_V3_TIME_JSONReturn all logged time entries for all projects. Only the time entries that the logged-in user can access will be returned.

Return all logged time entries for all projects. Only the time entries that the logged-in user can access will be returned.

Authentication

Connected account required

Tags

TimeTracking
Get time reportTEAMWORK_GET_PROJECTS_API_V3_TIME_REPORT_JSONGet time report

Get time report

Authentication

Connected account required

Tags

TimeTracking
Get time report totalsTEAMWORK_GET_PROJECTS_API_V3_TIME_REPORT_TOTALS_JSONGet time report totals

Get time report totals

Authentication

Connected account required

Tags

TimeTracking
Get time report by typeTEAMWORK_GET_PROJECTS_API_V3_TIME_REPORT_TYPE_JSONGet time report by type

Get time report by type

Authentication

Connected account required

Tags

TimeTracking
Get a specific time entryTEAMWORK_GET_PROJECTS_API_V3_TIME_TIMELOG_ID_JSONGet a specific time entry

Get a specific time entry

Authentication

Connected account required

Tags

TimeTracking
Get timelog totals.TEAMWORK_GET_PROJECTS_API_V3_TIME_TOTAL_JSONGet timelog totals.

Get timelog totals.

Authentication

Connected account required

Tags

TimeTracking
Validate if a timelog can be createdTEAMWORK_GET_PROJECTS_API_V3_TIME_VALIDATE_JSONValidates if a timelog can be created for a specific date by checking if there are any approved time approvals for that week.

Validates if a timelog can be created for a specific date by checking if there are any approved time approvals for that week.

Authentication

Connected account required

Tags

TimeTracking
Get all running timersTEAMWORK_GET_PROJECTS_API_V3_TIMERS_JSONBrings back all current running timers. Will return a set of existing intervals for each timer. 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.

Brings back all current running timers. Will return a set of existing intervals for each timer. 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.

Authentication

Connected account required

Tags

TimeTracking
Get a specific timerTEAMWORK_GET_PROJECTS_API_V3_TIMERS_TIMER_ID_JSONWill get a timer with with a specific ID.

Will get a timer with with a specific ID.

Authentication

Connected account required

Tags

TimeTracking
Get list of timesheet rowsTEAMWORK_GET_PROJECTS_API_V3_TIMESHEETS_JSONReturn a list of timesheet rows for the given user depending on param options.

Return a list of timesheet rows for the given user depending on param options.

Authentication

Connected account required

Tags

Timesheets
Get the totals for the all the user's timesheets.TEAMWORK_GET_PROJECTS_API_V3_TIMESHEETS_TOTALS_JSONGet the daily totals counts for all the user's timesheets.

Get the daily totals counts for all the user's timesheets.

Authentication

Connected account required

Tags

Timesheets
Get a specific workflow.TEAMWORK_GET_PROJECTS_API_V3_WORKFLOWS_ID_JSONGet a specific workflow.

Get a specific workflow.

Authentication

Connected account required

Tags

Workflows
Get all workflows.TEAMWORK_GET_PROJECTS_API_V3_WORKFLOWS_JSONReturns all workflows. When a project ID is supplied the result is scoped to workflows linked to that project.

Returns all workflows. When a project ID is supplied the result is scoped to workflows linked to that project.

Authentication

Connected account required

Tags

Workflows
Get all stages.TEAMWORK_GET_PROJECTS_API_V3_WORKFLOWS_WORKFLOW_ID_STAGES_JSONRetrieve all stages for a workflow.

Retrieve all stages for a workflow.

Authentication

Connected account required

Tags

Workflows
Get a specific stage.TEAMWORK_GET_PROJECTS_API_V3_WORKFLOWS_WORKFLOW_ID_STAGES_STAGE_ID_JSONReturns a stage for a workflow by id.

Returns a stage for a workflow by id.

Authentication

Connected account required

Tags

Workflows
Return the workload for users.TEAMWORK_GET_PROJECTS_API_V3_WORKLOAD_JSONReturn user's workload across projects.

Return user's workload across projects.

Authentication

Connected account required

Tags

Workload
Retrieve user workload plannerTEAMWORK_GET_PROJECTS_API_V3_WORKLOAD_PLANNERS_JSONReturn the workload planner for each users of the installation.

Return the workload planner for each users of the installation.

Authentication

Connected account required

Tags

Workload
Update an existing notification.TEAMWORK_PATCH_PROJECTS_API_V3_BUDGET_NOTIFICATIONS_NOTIFICATION_ID_JSONUpdate an existing notification.

Update an existing notification.

Authentication

Connected account required

Tags

Budgets
Update an existing calendar.TEAMWORK_PATCH_PROJECTS_API_V3_CALENDARS_ID_JSONUpdate an existing Calendar.

Update an existing Calendar.

Authentication

Connected account required

Tags

Calendars
Update an existing company custom field value.TEAMWORK_PATCH_PROJECTS_API_V3_COMPANIES_COMPANY_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONEdit a company custom field value.

Edit a company custom field value.

Authentication

Connected account required

Tags

CustomFields
Update an existing company.TEAMWORK_PATCH_PROJECTS_API_V3_COMPANIES_COMPANY_ID_JSONModify the properties of an existing company.

Modify the properties of an existing company.

Authentication

Connected account required

Tags

Companies
Set client rates for a company.TEAMWORK_PATCH_PROJECTS_API_V3_COMPANIES_COMPANY_ID_RATES_JSONSet client rates for a company by role.

Set client rates for a company by role.

Authentication

Connected account required

Tags

Companies
Update an existing company domain.TEAMWORK_PATCH_PROJECTS_API_V3_COMPANIES_DOMAINS_ID_JSONUpdate an existing company domain.

Update an existing company domain.

Authentication

Connected account required

Tags

Companies
Update an existing container.TEAMWORK_PATCH_PROJECTS_API_V3_CONTAINERS_ID_JSONUpdates an existing container with new properties. The container will be validated against permission rules before update.

Updates an existing container with new properties. The container will be validated against permission rules before update.

Authentication

Connected account required

Tags

Containers
Update a custom exchange rateTEAMWORK_PATCH_PROJECTS_API_V3_CUSTOM_EXCHANGE_RATES_ID_JSONPartially update an existing custom exchange rate.

Partially update an existing custom exchange rate.

Authentication

Connected account required

Tags

ExchangeRate
Update an existing custom field.TEAMWORK_PATCH_PROJECTS_API_V3_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONUpdates an existing custom field.

Updates an existing custom field.

Authentication

Connected account required

Tags

CustomFields
Edit an existing custom item field.TEAMWORK_PATCH_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_ID_JSONEdit an existing custom item field.

Edit an existing custom item field.

Authentication

Connected account required

Tags

CustomItems
Edit an existing option.TEAMWORK_PATCH_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_ID_OPTIONS_OPTION_ID_JSONEdit an existing custom item field option for the specified field.

Edit an existing custom item field option for the specified field.

Authentication

Connected account required

Tags

CustomItems
Edit an existing custom item.TEAMWORK_PATCH_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_JSONEdit an existing custom item.

Edit an existing custom item.

Authentication

Connected account required

Tags

CustomItems
Edit an existing custom item record.TEAMWORK_PATCH_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_RECORDS_ID_JSONEdit an existing custom item record.

Edit an existing custom item record.

Authentication

Connected account required

Tags

CustomItems
Edit an existing custom item section.TEAMWORK_PATCH_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_SECTIONS_ID_JSONEdit an existing custom item section.

Edit an existing custom item section.

Authentication

Connected account required

Tags

CustomItems
Update the draft version of an existing form.TEAMWORK_PATCH_PROJECTS_API_V3_FORMS_FORM_ID_DRAFT_JSONUpdates the draft revision of a form without publishing the changes to the public-facing form.

Updates the draft revision of a form without publishing the changes to the public-facing form.

Authentication

Connected account required

Tags

Forms
Update an existing form.TEAMWORK_PATCH_PROJECTS_API_V3_FORMS_FORM_ID_JSONUpdate an existing form.

Update an existing form.

Authentication

Connected account required

Tags

Forms
Set cost rates for a job role.TEAMWORK_PATCH_PROJECTS_API_V3_JOBROLES_ID_COST_RATES_JSONSet cost rates for a job role.

Set cost rates for a job role.

Authentication

Connected account required

Tags

JobRoles
Update an existing job role.TEAMWORK_PATCH_PROJECTS_API_V3_JOBROLES_ID_JSONUpdate an existing job role.

Update an existing job role.

Authentication

Connected account required

Tags

JobRoles
Edit a message.TEAMWORK_PATCH_PROJECTS_API_V3_MESSAGES_MESSAGE_ID_JSONUpdate specific fields on a message. If the property `read` is sent with the value `true` all replies from this message will be marked as read.

Update specific fields on a message. If the property `read` is sent with the value `true` all replies from this message will be marked as read.

Authentication

Connected account required

Tags

Messages
Edits a notebookTEAMWORK_PATCH_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_JSONEdits the fields of an existing notebook.

Edits the fields of an existing notebook.

Authentication

Connected account required

Tags

Notebooks
Updates a tasklist budgetTEAMWORK_PATCH_PROJECTS_API_V3_PROJECTS_BUDGETS_BUDGET_ID_TASKLISTS_BUDGETS_TASKLIST_ID_JSONUpdates a tasklist budget

Updates a tasklist budget

Authentication

Connected account required

Tags

Budgets
Update an existing project custom field value.TEAMWORK_PATCH_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONEdit a project custom field value.

Edit a project custom field value.

Authentication

Connected account required

Tags

CustomFields
Update a quote.TEAMWORK_PATCH_PROJECTS_API_V3_QUOTE_ID_JSONUpdate a quote.

Update a quote.

Authentication

Connected account required

Tags

Quotes
Update a quote line item.TEAMWORK_PATCH_PROJECTS_API_V3_QUOTE_QUOTE_ID_LINEITEM_ID_JSONUpdate a quote line item.

Update a quote line item.

Authentication

Connected account required

Tags

Quotes
Update a quote section.TEAMWORK_PATCH_PROJECTS_API_V3_QUOTE_QUOTE_ID_SECTION_ID_JSONUpdate a quote section.

Update a quote section.

Authentication

Connected account required

Tags

Quotes
Update a custom report.TEAMWORK_PATCH_PROJECTS_API_V3_REPORTING_CUSTOM_ID_JSONApplies a partial update to the custom report identified by `id`. On success the updated custom report is returned in the same shape as `GET /reporting/custom/{id}.json`.

Applies a partial update to the custom report identified by `id`. On success the updated custom report is returned in the same shape as `GET /reporting/custom/{id}.json`.

Authentication

Connected account required

Tags

CustomReports
Update a scheduled report.TEAMWORK_PATCH_PROJECTS_API_V3_REPORTING_REPORT_ID_JSONApplies a partial update to the scheduled report identified by `reportId`, its schedules and its options. Returns the updated report.

Applies a partial update to the scheduled report identified by `reportId`, its schedules and its options. Returns the updated report.

Authentication

Connected account required

Tags

Reports
Update an existing risk.TEAMWORK_PATCH_PROJECTS_API_V3_RISKS_RISK_ID_JSONModify the properties of an existing risk.

Modify the properties of an existing risk.

Authentication

Connected account required

Tags

Risks
Update an existing skill.TEAMWORK_PATCH_PROJECTS_API_V3_SKILLS_ID_JSONUpdate an existing skill.

Update an existing skill.

Authentication

Connected account required

Tags

Skills
Update a single tagTEAMWORK_PATCH_PROJECTS_API_V3_TAGS_TAG_ID_JSONUpdates a existing tag. If there's already a tag with the same changed name in the installation, it will be returned the status code 409 (CONFLICT).

Updates a existing tag. If there's already a tag with the same changed name in the installation, it will be returned the status code 409 (CONFLICT).

Authentication

Connected account required

Tags

Tags
Update an existing task custom field value.TEAMWORK_PATCH_PROJECTS_API_V3_TASKS_TASK_ID_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONEdit a task custom field value.

Edit a task custom field value.

Authentication

Connected account required

Tags

CustomFields
Update an existing task.TEAMWORK_PATCH_PROJECTS_API_V3_TASKS_TASK_ID_JSONModify the properties of an existing task.

Modify the properties of an existing task.

Authentication

Connected account required

Tags

Tasks
Update task reminderTEAMWORK_PATCH_PROJECTS_API_V3_TASKS_TASK_ID_REMINDERS_REMINDER_ID_JSONUpdates an existing reminder for a task.

Updates an existing reminder for a task.

Authentication

Connected account required

Tags

TaskReminders
Edits the position of a task in a stageTEAMWORK_PATCH_PROJECTS_API_V3_TASKS_TASK_ID_WORKFLOWS_WORKFLOW_ID_JSONEdits the position of a task in a stage

Edits the position of a task in a stage

Authentication

Connected account required

Tags

Workflows
Update an existing time entry.TEAMWORK_PATCH_PROJECTS_API_V3_TIME_TIMELOG_ID_JSONModify the properties of an existing time entry.

Modify the properties of an existing time entry.

Authentication

Connected account required

Tags

TimeTracking
Update an existing workflow.TEAMWORK_PATCH_PROJECTS_API_V3_WORKFLOWS_ID_JSONPartial update a workflow.

Partial update a workflow.

Authentication

Connected account required

Tags

Workflows
Update an existing stage.TEAMWORK_PATCH_PROJECTS_API_V3_WORKFLOWS_WORKFLOW_ID_STAGES_STAGE_ID_JSONUpdates a stage by id with the given workflow id.

Updates a stage by id with the given workflow id.

Authentication

Connected account required

Tags

Workflows
Creates new tasklist budgetsTEAMWORK_POST_PROJECTS_API_V3_BUDGETS_ID_TASKLISTS_BUDGETS_BULK_ADD_JSONCreates new tasklist budgets

Creates new tasklist budgets

Authentication

Connected account required

Tags

Budgets
Create a new calendar event.TEAMWORK_POST_PROJECTS_API_V3_CALENDARS_CALENDAR_ID_EVENTS_JSONAdd a new Event.

Add a new Event.

Authentication

Connected account required

Tags

CalendarEvents
Create a task from a calendar event.TEAMWORK_POST_PROJECTS_API_V3_CALENDARS_EVENTS_TASK_FROM_EVENT_JSONCreates a new task based on a calendar event, linking all related events (sharing the same iCalUID) to the task and removing the event from unavailable time planning calculations. Request (application/json): payloadcalendarevent.TaskFromEventRequest

Creates a new task based on a calendar event, linking all related events (sharing the same iCalUID) to the task and removing the event from unavailable time planning calculations. Request (application/json): payloadcalendarevent.TaskFromEventRequest

Authentication

Connected account required

Tags

CalendarEvent
Create a new calendar.TEAMWORK_POST_PROJECTS_API_V3_CALENDARS_JSONAdd a new Calendar.

Add a new Calendar.

Authentication

Connected account required

Tags

Calendars
Create a new calendar event.TEAMWORK_POST_PROJECTS_API_V3_CALENDARS_PRIMARY_EVENTS_JSONAdd a new Event.

Add a new Event.

Authentication

Connected account required

Tags

CalendarEvents
Create a commentTEAMWORK_POST_PROJECTS_API_V3_COMMENTS_JSONCreates a new comment attached to the object identified by one of the query parameters (taskId, fileVersionId, notebookId, milestoneId, linkId, eventId, statusId, or projectUpdateId).

Creates a new comment attached to the object identified by one of the query parameters (taskId, fileVersionId, notebookId, milestoneId, linkId, eventId, statusId, or projectUpdateId).

Authentication

Connected account required

Tags

Comments
Delete many company custom fields values at once.TEAMWORK_POST_PROJECTS_API_V3_COMPANIES_COMPANY_ID_CUSTOMFIELDS_BULK_DELETE_JSONRemove many entries of company custom field values at once.

Remove many entries of company custom field values at once.

Authentication

Connected account required

Tags

CustomFields
Update many company custom field values at once.TEAMWORK_POST_PROJECTS_API_V3_COMPANIES_COMPANY_ID_CUSTOMFIELDS_BULK_UPDATE_JSONEdit many entries of company custom field values at once.

Edit many entries of company custom field values at once.

Authentication

Connected account required

Tags

CustomFields
Add company custom field value.TEAMWORK_POST_PROJECTS_API_V3_COMPANIES_COMPANY_ID_CUSTOMFIELDS_JSONAdd a company custom field value.

Add a company custom field value.

Authentication

Connected account required

Tags

CustomFields
Convert a company's currencyTEAMWORK_POST_PROJECTS_API_V3_COMPANIES_ID_CONVERT_CURRENCY_JSONRequest: payloadcompany.ConvertCurrencyRequest

Request: payloadcompany.ConvertCurrencyRequest

Authentication

Connected account required

Tags

Companies
Create a new company domains.TEAMWORK_POST_PROJECTS_API_V3_COMPANIES_ID_DOMAINS_JSONCreates a new company domain attached to company that id is passed as param.

Creates a new company domain attached to company that id is passed as param.

Authentication

Connected account required

Tags

Companies
Create a company.TEAMWORK_POST_PROJECTS_API_V3_COMPANIES_JSONCreate a company.

Create a company.

Authentication

Connected account required

Tags

Companies
Create a new container.TEAMWORK_POST_PROJECTS_API_V3_CONTAINERS_JSONCreates a new container with the specified type, widgets, and configuration. The container will be validated against permission rules before creation.

Creates a new container with the specified type, widgets, and configuration. The container will be validated against permission rules before creation.

Authentication

Connected account required

Tags

Containers
Create a new custom exchange rateTEAMWORK_POST_PROJECTS_API_V3_CUSTOM_EXCHANGE_RATES_JSONCreate a custom exchange rate for a specific currency pair and validity period.

Create a custom exchange rate for a specific currency pair and validity period.

Authentication

Connected account required

Tags

ExchangeRate
Delete many custom fields at onceTEAMWORK_POST_PROJECTS_API_V3_CUSTOMFIELDS_BULK_DELETE_JSONRemove multiple custom fields at once.

Remove multiple custom fields at once.

Authentication

Connected account required

Tags

CustomFields
Create a new custom fieldTEAMWORK_POST_PROJECTS_API_V3_CUSTOMFIELDS_JSONCreates a new custom field. The custom field could have a scope at an installation-level or at a project-level.

Creates a new custom field. The custom field could have a scope at an installation-level or at a project-level.

Authentication

Connected account required

Tags

CustomFields
Validate syntax of formula fieldTEAMWORK_POST_PROJECTS_API_V3_CUSTOMFIELDS_VALIDATE_JSONValidates syntax of formula field. Do not check for permissions, naming etc.

Validates syntax of formula field. Do not check for permissions, naming etc.

Authentication

Connected account required

Tags

CustomFields
Create a new option.TEAMWORK_POST_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_ID_OPTIONS_JSONCreate a new custom item field option for the specified field.

Create a new custom item field option for the specified field.

Authentication

Connected account required

Tags

CustomItems
Create a new field.TEAMWORK_POST_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_JSONCreate a new custom item field for the specified custom item.

Create a new custom item field for the specified custom item.

Authentication

Connected account required

Tags

CustomItems
Validate a custom item formula expression.TEAMWORK_POST_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_FIELDS_VALIDATE_FORMULA_JSONValidates a candidate formula against the custom item's existing field schema without persisting anything. Returns the formula's output unit on success, or a list of structured errors describing what is wrong.

Validates a candidate formula against the custom item's existing field schema without persisting anything. Returns the formula's output unit on success, or a list of structured errors describing what is wrong.

Authentication

Connected account required

Tags

CustomItems
Delete many custom item records at once.TEAMWORK_POST_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_RECORDS_BULK_DELETE_JSONDelete several custom item records.

Delete several custom item records.

Authentication

Connected account required

Tags

CustomItems
Create a new record.TEAMWORK_POST_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_RECORDS_JSONCreate a new custom item record for the specified custom item.

Create a new custom item record for the specified custom item.

Authentication

Connected account required

Tags

CustomItems
Create a new section.TEAMWORK_POST_PROJECTS_API_V3_CUSTOMITEMS_CUSTOM_ITEM_ID_SECTIONS_JSONCreate a new custom item section for the specified custom item.

Create a new custom item section for the specified custom item.

Authentication

Connected account required

Tags

CustomItems
Copy a formTEAMWORK_POST_PROJECTS_API_V3_FORMS_FORM_ID_COPY_JSONCopy a form

Copy a form

Authentication

Connected account required

Tags

FormsPublic
Create a new form.TEAMWORK_POST_PROJECTS_API_V3_FORMS_JSONCreate a new form.

Create a new form.

Authentication

Connected account required

Tags

Forms
Set billable rates for a job role.TEAMWORK_POST_PROJECTS_API_V3_JOBROLES_ID_BILLABLE_RATES_JSONSet billable rates for a job role.

Set billable rates for a job role.

Authentication

Connected account required

Tags

JobRoles
Assign a job role.TEAMWORK_POST_PROJECTS_API_V3_JOBROLES_ID_PEOPLE_JSONAssign a job role to one or more users. It will automatically unassign the given users from any other job role they might have assigned currently.

Assign a job role to one or more users. It will automatically unassign the given users from any other job role they might have assigned currently.

Authentication

Connected account required

Tags

JobRoles
Create a new job role.TEAMWORK_POST_PROJECTS_API_V3_JOBROLES_JSONCreates a new job role global to the entire installation.

Creates a new job role global to the entire installation.

Authentication

Connected account required

Tags

JobRoles
Creates a personal task.TEAMWORK_POST_PROJECTS_API_V3_ME_PERSONALTASKS_JSONCreate a new personal task.

Create a new personal task.

Authentication

Connected account required

Tags

Tasks
Create a new timerTEAMWORK_POST_PROJECTS_API_V3_ME_TIMERS_JSONCreates a new timer. If there's already a timer running, it will stop this timer at default.

Creates a new timer. If there's already a timer running, it will stop this timer at default.

Authentication

Connected account required

Tags

TimeTracking
Create a new user.TEAMWORK_POST_PROJECTS_API_V3_PEOPLE_JSONCreate a new user.

Create a new user.

Authentication

Connected account required

Tags

Users
Parse an expense receipt with AI.TEAMWORK_POST_PROJECTS_API_V3_PROJECTS_EXPENSES_READ_WITH_AI_JSONAccepts a previously uploaded file (by file name) and returns a draft expense payload extracted from the document via the AI extraction service. Requires the expenses AI feature to be enabled for the installation.

Accepts a previously uploaded file (by file name) and returns a draft expense payload extracted from the document via the AI extraction service. Requires the expenses AI feature to be enabled for the installation.

Authentication

Connected account required

Tags

BETA
Delete many project custom fields values at once.TEAMWORK_POST_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMFIELDS_BULK_DELETE_JSONRemove many entries of project custom field values at once.

Remove many entries of project custom field values at once.

Authentication

Connected account required

Tags

CustomFields
Update many project custom field values at once.TEAMWORK_POST_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMFIELDS_BULK_UPDATE_JSONEdit many entries of project custom field values at once.

Edit many entries of project custom field values at once.

Authentication

Connected account required

Tags

CustomFields
Add project custom field value.TEAMWORK_POST_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMFIELDS_JSONAdd a project custom field value.

Add a project custom field value.

Authentication

Connected account required

Tags

CustomFields
Create a new customitem.TEAMWORK_POST_PROJECTS_API_V3_PROJECTS_PROJECT_ID_CUSTOMITEMS_JSONCreate a new customitem.

Create a new customitem.

Authentication

Connected account required

Tags

CustomItems
Create a new notebook.TEAMWORK_POST_PROJECTS_API_V3_PROJECTS_PROJECT_ID_NOTEBOOKS_JSONCreate a new notebook.

Create a new notebook.

Authentication

Connected account required

Tags

Notebooks
Create a risk in a specific project.TEAMWORK_POST_PROJECTS_API_V3_PROJECTS_PROJECT_ID_RISKS_JSONCreate a risk in the desired project.

Create a risk in the desired project.

Authentication

Connected account required

Tags

Risks
Create a time entry in a specific project.TEAMWORK_POST_PROJECTS_API_V3_PROJECTS_PROJECT_ID_TIME_JSONCreate a time entry in the desired project.

Create a time entry in the desired project.

Authentication

Connected account required

Tags

TimeTracking
Applies a workflow to a projectTEAMWORK_POST_PROJECTS_API_V3_PROJECTS_PROJECT_ID_WORKFLOWS_JSONApplies a workflow to a project

Applies a workflow to a project

Authentication

Connected account required

Tags

Workflows
Create a new quote line item.TEAMWORK_POST_PROJECTS_API_V3_QUOTE_QUOTE_ID_LINEITEM_JSONCreate a new quote line item.

Create a new quote line item.

Authentication

Connected account required

Tags

Quotes
Deletes quote line items.TEAMWORK_POST_PROJECTS_API_V3_QUOTE_QUOTE_ID_LINEITEMS_BULK_DELETEDeletes quote line items.

Deletes quote line items.

Authentication

Connected account required

Tags

Quotes
Create a new quote section.TEAMWORK_POST_PROJECTS_API_V3_QUOTE_QUOTE_ID_SECTION_JSONCreate a new quote section.

Create a new quote section.

Authentication

Connected account required

Tags

Quotes
Clone an existing quote.TEAMWORK_POST_PROJECTS_API_V3_QUOTES_CLONEClone an existing quote.

Clone an existing quote.

Authentication

Connected account required

Tags

Quotes
Create a new quote.TEAMWORK_POST_PROJECTS_API_V3_QUOTES_JSONCreate a new quote.

Create a new quote.

Authentication

Connected account required

Tags

Quotes
Bulk delete scheduled reports.TEAMWORK_POST_PROJECTS_API_V3_REPORTING_BULK_DELETE_JSONDeletes multiple scheduled reports in a single request. The body must specify the `reportIds` to remove.

Deletes multiple scheduled reports in a single request. The body must specify the `reportIds` to remove.

Authentication

Connected account required

Tags

Reports
Bulk delete custom reports.TEAMWORK_POST_PROJECTS_API_V3_REPORTING_CUSTOM_BULK_DELETE_JSONDeletes multiple custom reports in a single request. The body must specify the `ids` of the reports to remove.

Deletes multiple custom reports in a single request. The body must specify the `ids` of the reports to remove.

Authentication

Connected account required

Tags

CustomReports
Create a custom report.TEAMWORK_POST_PROJECTS_API_V3_REPORTING_CUSTOM_JSONCreates a new custom report from the supplied configuration. On success the newly created custom report is returned in the same shape as `GET /reporting/custom/{id}.json`.

Creates a new custom report from the supplied configuration. On success the newly created custom report is returned in the same shape as `GET /reporting/custom/{id}.json`.

Authentication

Connected account required

Tags

CustomReports
Create a scheduled report.TEAMWORK_POST_PROJECTS_API_V3_REPORTING_JSONCreates a new scheduled report along with its schedules and options. The newly created report is returned and the `Location` header points at its canonical URL.

Creates a new scheduled report along with its schedules and options. The newly created report is returned and the `Location` header points at its canonical URL.

Authentication

Connected account required

Tags

Reports
Delete many skills at once.TEAMWORK_POST_PROJECTS_API_V3_SKILLS_BULK_DELETE_JSONBulk delete a number of skills.

Bulk delete a number of skills.

Authentication

Connected account required

Tags

Skills
Assign a skill.TEAMWORK_POST_PROJECTS_API_V3_SKILLS_ID_PEOPLE_JSONAssign a skill to one or more users.

Assign a skill to one or more users.

Authentication

Connected account required

Tags

Skills
Assign a skill to a single user.TEAMWORK_POST_PROJECTS_API_V3_SKILLS_ID_PEOPLE_USER_ID_JSONAssign a skill to a single user.

Assign a skill to a single user.

Authentication

Connected account required

Tags

Skills
Create a new skill.TEAMWORK_POST_PROJECTS_API_V3_SKILLS_JSONCreates a new skill global to the entire installation.

Creates a new skill global to the entire installation.

Authentication

Connected account required

Tags

Skills
Delete many tags at onceTEAMWORK_POST_PROJECTS_API_V3_TAGS_BULK_DELETE_JSONRemoves many tags at once.

Removes many tags at once.

Authentication

Connected account required

Tags

Tags
Create a single tagTEAMWORK_POST_PROJECTS_API_V3_TAGS_JSONCreates a new tag. If there's already a tag with the same name in the installation, it will be returned in the response with the status code 200 (OK).

Creates a new tag. If there's already a tag with the same name in the installation, it will be returned in the response with the status code 200 (OK).

Authentication

Connected account required

Tags

Tags
Creates a task in a taskgroup.TEAMWORK_POST_PROJECTS_API_V3_TASKGROUPS_TASKGROUP_ID_TASKS_JSONCreate a new task within the provided taskgroup.

Create a new task within the provided taskgroup.

Authentication

Connected account required

Tags

Tasks
Creates a task.TEAMWORK_POST_PROJECTS_API_V3_TASKLISTS_TASKLIST_ID_TASKS_JSONCreate a new task in the provided task list.

Create a new task in the provided task list.

Authentication

Connected account required

Tags

Tasks
Create a comment on a task.TEAMWORK_POST_PROJECTS_API_V3_TASKS_TASK_ID_COMMENTS_JSONAdds a new comment to the given task.

Adds a new comment to the given task.

Authentication

Connected account required

Tags

TaskComments
Delete many task custom fields values at once.TEAMWORK_POST_PROJECTS_API_V3_TASKS_TASK_ID_CUSTOMFIELDS_BULK_DELETE_JSONRemove many entries of task custom field values at once.

Remove many entries of task custom field values at once.

Authentication

Connected account required

Tags

CustomFields
Update many task custom field values at once.TEAMWORK_POST_PROJECTS_API_V3_TASKS_TASK_ID_CUSTOMFIELDS_BULK_UPDATE_JSONEdit many entries of task custom field values at once.

Edit many entries of task custom field values at once.

Authentication

Connected account required

Tags

CustomFields
Add task custom field value.TEAMWORK_POST_PROJECTS_API_V3_TASKS_TASK_ID_CUSTOMFIELDS_JSONAdd a task custom field value.

Add a task custom field value.

Authentication

Connected account required

Tags

CustomFields
Add task reminderTEAMWORK_POST_PROJECTS_API_V3_TASKS_TASK_ID_REMINDERS_JSONCreates reminders for a task. Accepts a list of userIds and/or teamIds; one reminder row is created per resolved user.

Creates reminders for a task. Accepts a list of userIds and/or teamIds; one reminder row is created per resolved user.

Authentication

Connected account required

Tags

TaskReminders
Creates a subtask.TEAMWORK_POST_PROJECTS_API_V3_TASKS_TASK_ID_SUBTASKS_JSONCreate a new subtask under the provided parent task.

Create a new subtask under the provided parent task.

Authentication

Connected account required

Tags

Tasks
Create a time entry linked to a specific task.TEAMWORK_POST_PROJECTS_API_V3_TASKS_TASK_ID_TIME_JSONCreate a time entry linked to the desired task.

Create a time entry linked to the desired task.

Authentication

Connected account required

Tags

TimeTracking
Reopen a time approval back to in reviewTEAMWORK_POST_PROJECTS_API_V3_TIME_APPROVALS_APPROVAL_ID_REOPEN_JSONPath Parameters: - approvalId: The ID of the time approval to reopen

Path Parameters: - approvalId: The ID of the time approval to reopen

Authentication

Connected account required

Tags

TimeApprovals
Request to reopen a time approval.TEAMWORK_POST_PROJECTS_API_V3_TIME_APPROVALS_APPROVAL_ID_REQUESTREOPEN_JSONPath Parameters: - approvalId: The ID of the time approval to request reopening for

Path Parameters: - approvalId: The ID of the time approval to request reopening for

Authentication

Connected account required

Tags

TimeApprovals
Create a new workflow.TEAMWORK_POST_PROJECTS_API_V3_WORKFLOWS_JSONCreates a new workflow.

Creates a new workflow.

Authentication

Connected account required

Tags

Workflows
Create a new stage for a workflow.TEAMWORK_POST_PROJECTS_API_V3_WORKFLOWS_WORKFLOW_ID_STAGES_JSONCreates a new stage for a workflow with the given id.

Creates a new stage for a workflow with the given id.

Authentication

Connected account required

Tags

Workflows
Update an existing custom field.TEAMWORK_PUT_PROJECTS_API_V3_CUSTOMFIELDS_CUSTOM_FIELD_ID_JSONUpdates an existing custom field.

Updates an existing custom field.

Authentication

Connected account required

Tags

CustomFields
Complete a timer by IDTEAMWORK_PUT_PROJECTS_API_V3_ME_TIMERS_TIMER_ID_COMPLETE_JSONComplete an existing timer. If the timer is currently running, it is paused to create the timelog entry. When the timelog is created, the timer is deleted.

Complete an existing timer. If the timer is currently running, it is paused to create the timelog entry. When the timelog is created, the timer is deleted.

Authentication

Connected account required

Tags

TimeTracking
Edits a timerTEAMWORK_PUT_PROJECTS_API_V3_ME_TIMERS_TIMER_ID_JSONEdits the fields of a timer.

Edits the fields of a timer.

Authentication

Connected account required

Tags

TimeTracking
Pause a timer by IDTEAMWORK_PUT_PROJECTS_API_V3_ME_TIMERS_TIMER_ID_PAUSE_JSONPause an existing timer.

Pause an existing timer.

Authentication

Connected account required

Tags

TimeTracking
Resume a timer by IDTEAMWORK_PUT_PROJECTS_API_V3_ME_TIMERS_TIMER_ID_RESUME_JSONResume an existing timer. If other timers are currently running, those timers are paused before resuming.

Resume an existing timer. If other timers are currently running, those timers are paused before resuming.

Authentication

Connected account required

Tags

TimeTracking
Restore a deleted timer item.TEAMWORK_PUT_PROJECTS_API_V3_ME_TIMERS_TIMER_ID_UNDELETE_JSONRestore an deleted timer.

Restore an deleted timer.

Authentication

Connected account required

Tags

TimeTracking
Lock a notebookTEAMWORK_PUT_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_LOCK_JSONLocks a specific notebook.

Locks a specific notebook.

Authentication

Connected account required

Tags

Notebooks
Unlock a notebookTEAMWORK_PUT_PROJECTS_API_V3_NOTEBOOKS_NOTEBOOK_ID_UNLOCK_JSONUnlocks a specific notebook.

Unlocks a specific notebook.

Authentication

Connected account required

Tags

Notebooks
Adds or updates task list budgets depending on theTEAMWORK_PUT_PROJECTS_API_V3_PROJECTS_BUDGETS_ID_TASKLISTS_BUDGETS_JSONpayload. If an ID is provided it is seen as an update, else it inserts. NOTE: the payload provided is the final source of truth, meaning any budgets omitted will be cleared. Adds or updates task list budgets.

payload. If an ID is provided it is seen as an update, else it inserts. NOTE: the payload provided is the final source of truth, meaning any budgets omitted will be cleared. Adds or updates task list budgets.

Authentication

Connected account required

Tags

Budgets
Bulk applies a user to many projectsTEAMWORK_PUT_PROJECTS_API_V3_PROJECTS_PEOPLE_USER_ID_ENQUEUE_JSONBulk applies a user to many projects

Bulk applies a user to many projects

Authentication

Connected account required

Tags

People
Sets the the features order to display in tabTEAMWORK_PUT_PROJECTS_API_V3_PROJECTS_PROJECT_ID_FEATUREORDER_JSONEach field must have an index, from 0 to numFeatures -1 without repeated numbers to provide the order to display the features

Each field must have an index, from 0 to numFeatures -1 without repeated numbers to provide the order to display the features

Authentication

Connected account required

Tags

Projects
Add people to a projectTEAMWORK_PUT_PROJECTS_API_V3_PROJECTS_PROJECT_ID_PEOPLE_JSONAdds a list of user ID's to a project.

Adds a list of user ID's to a project.

Authentication

Connected account required

Tags

People
Copies project risksTEAMWORK_PUT_PROJECTS_API_V3_PROJECTS_PROJECT_ID_RISKS_COPY_JSONCopies the risk register from one project to another.

Copies the risk register from one project to another.

Authentication

Connected account required

Tags

Risks
Update required custom fields on a templateTEAMWORK_PUT_PROJECTS_API_V3_PROJECTS_TEMPLATES_ID_CUSTOMFIELDS_REQUIRED_JSONReplaces the set of custom fields marked as required on the given project template with the supplied list.

Replaces the set of custom fields marked as required on the given project template with the supplied list.

Authentication

Connected account required

Tags

Projects
Converts the given tentative project into normalTEAMWORK_PUT_PROJECTS_API_V3_PROJECTS_TENTATIVE_PROJECT_ID_CONVERT_JSONConverts the given tentative project into normal

Converts the given tentative project into normal

Authentication

Connected account required

Tags

Projects
Save quote export preferences.TEAMWORK_PUT_PROJECTS_API_V3_QUOTE_ID_EXPORT_PREFERENCES_TYPE_JSONSave quote export preferences.

Save quote export preferences.

Authentication

Connected account required

Tags

QuoteExportPreferences
Update a list of quote sections.TEAMWORK_PUT_PROJECTS_API_V3_QUOTE_SECTIONS_BULK_UPDATE_JSONUpdate a list of quote sections.

Update a list of quote sections.

Authentication

Connected account required

Tags

Quotes
Update quote settings.TEAMWORK_PUT_PROJECTS_API_V3_QUOTESETTINGS_JSONUpdate quote settings.

Update quote settings.

Authentication

Connected account required

Tags

QuoteSettings
Enqueue a custom report for processing.TEAMWORK_PUT_PROJECTS_API_V3_REPORTING_CUSTOM_ENQUEUE_ID_JSONTriggers the custom reports worker to (re)generate the data for the given custom report. Optional `dryRun` and `force` query parameters control dry-run and forced re-processing.

Triggers the custom reports worker to (re)generate the data for the given custom report. Optional `dryRun` and `force` query parameters control dry-run and forced re-processing.

Authentication

Connected account required

Tags

CustomReports
Update an existing risk.TEAMWORK_PUT_PROJECTS_API_V3_RISKS_RISK_ID_JSONModify the properties of an existing risk.

Modify the properties of an existing risk.

Authentication

Connected account required

Tags

Risks
Assign a skill.TEAMWORK_PUT_PROJECTS_API_V3_SKILLS_ID_PEOPLE_JSONAssign or remove a skill to one or more users.

Assign or remove a skill to one or more users.

Authentication

Connected account required

Tags

Skills
Assign a skill.TEAMWORK_PUT_PROJECTS_API_V3_SKILLS_PEOPLE_ID_JSONAssign or remove skills to a single user.

Assign or remove skills to a single user.

Authentication

Connected account required

Tags

Skills
Update an existing task.TEAMWORK_PUT_PROJECTS_API_V3_TASKS_TASK_ID_JSONModify the properties of an existing task.

Modify the properties of an existing task.

Authentication

Connected account required

Tags

Tasks
Update an existing time entry.TEAMWORK_PUT_PROJECTS_API_V3_TIME_TIMELOG_ID_JSONModify the properties of an existing time entry. Equivalent to the PATCH variant; only fields included in the request body are modified.

Modify the properties of an existing time entry. Equivalent to the PATCH variant; only fields included in the request body are modified.

Authentication

Connected account required

Tags

TimeTracking

Provider resources