Peoplestatus 1 endpoints

GET /projects/api/v3/teams/{teamId}/statuses/timeline.json Get statuses timeline for a specific team

Return people statuses from a specific team that the logged-in user can
access.

operationId: PeopleStatus_listTimeline

Parameters

Name	In	Required	Type	Description
searchTerm	query	optional	string	filter by the user name or status message
teamId	path	required	integer	—
teamId	query	optional	integer	filter by team
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showDeleted	query	optional	boolean	showDeleted statuses
includeSubteams	query	optional	boolean	also include statuses from subteams
include	query	optional	array	include
fields[users]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/teams/{teamId}/statuses/timeline.json

Person 3 endpoints

GET /projects/api/v3/people/{personId}.json Returns a person

Retrieve a person record.

operationId: Person_getRecord

Parameters

Name	In	Required	Type	Description
userType	query	optional	string	user type
updatedAfter	query	optional	string	date time
searchTerm	query	optional	string	filter by comment content
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
lastLoginAfter	query	optional	string	—
personId	path	required	integer	—
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showDeleted	query	optional	boolean	include deleted items
orderPrioritiseCurrentUser	query	optional	boolean	Force to have the current/session user in the response
onlySiteOwner	query	optional	boolean	—
onlyOwnerCompany	query	optional	boolean	return people only from the owner company. This will replace any provided company ID.
includeServiceAccounts	query	optional	boolean	include service accounts
includeCollaborators	query	optional	boolean	exclude collaborators types, returning only account and contact.
includeClients	query	optional	boolean	include clients
filterByNoCostRate	query	optional	boolean	Returns users who are missing cost rates(OCA only)
excludeContacts	query	optional	boolean	exclude contact types, returning only account and collaborator.
teamIds	query	optional	array	team ids
projectIds	query	optional	array	filter by project ids
include	query	optional	array	include (not used when generating reports)
ids	query	optional	array	filter by user ids
fields[teams]	query	optional	array	—
fields[person]	query	optional	array	—
fields[people]	query	optional	array	—
fields[companies]	query	optional	array	—
fields[ProjectPermissions]	query	optional	array	—
excludeProjectIds	query	optional	array	exclude people assigned to certain project id
companyIds	query	optional	array	company ids

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/people/{personId}.json

GET /projects/api/v3/projects/{projectId}/people/{personId}.json Returns a person on a project

Retrieve a person record.

operationId: Person_getRecord

Parameters

Name	In	Required	Type	Description
userType	query	optional	string	user type
updatedAfter	query	optional	string	date time
searchTerm	query	optional	string	filter by comment content
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
lastLoginAfter	query	optional	string	—
projectId	path	required	integer	—
personId	path	required	integer	—
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showDeleted	query	optional	boolean	include deleted items
orderPrioritiseCurrentUser	query	optional	boolean	Force to have the current/session user in the response
onlySiteOwner	query	optional	boolean	—
onlyOwnerCompany	query	optional	boolean	return people only from the owner company. This will replace any provided company ID.
includeServiceAccounts	query	optional	boolean	include service accounts
includeCollaborators	query	optional	boolean	exclude collaborators types, returning only account and contact.
includeClients	query	optional	boolean	include clients
filterByNoCostRate	query	optional	boolean	Returns users who are missing cost rates(OCA only)
excludeContacts	query	optional	boolean	exclude contact types, returning only account and collaborator.
teamIds	query	optional	array	team ids
projectIds	query	optional	array	filter by project ids
include	query	optional	array	include (not used when generating reports)
ids	query	optional	array	filter by user ids
fields[teams]	query	optional	array	—
fields[person]	query	optional	array	—
fields[people]	query	optional	array	—
fields[companies]	query	optional	array	—
fields[ProjectPermissions]	query	optional	array	—
excludeProjectIds	query	optional	array	exclude people assigned to certain project id
companyIds	query	optional	array	company ids

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/{projectId}/people/{personId}.json

GET /projects/api/v3/reporting/precanned/usertaskcompletion/{userId}.json Returns task completions for given user

Retrieve a person record and its task completion stats.

operationId: Person_getTaskCompletionsByUser

Parameters

Name	In	Required	Type	Description
userType	query	optional	string	user type
updatedAfter	query	optional	string	date time
startDate	query	optional	string	start date for task completion report
searchTerm	query	optional	string	filter by comment content
reportFormat	query	optional	string	define the format of the report
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
lastLoginAfter	query	optional	string	—
endDate	query	optional	string	end date for task completion report
userId	path	required	integer	—
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showDeleted	query	optional	boolean	include deleted items
orderPrioritiseCurrentUser	query	optional	boolean	Force to have the current/session user in the response
onlySiteOwner	query	optional	boolean	—
onlyOwnerCompany	query	optional	boolean	return people only from the owner company. This will replace any provided company ID.
isReportDownload	query	optional	boolean	generate a report document
includeServiceAccounts	query	optional	boolean	include service accounts
includeCollaborators	query	optional	boolean	exclude collaborators types, returning only account and contact.
includeClients	query	optional	boolean	include clients
filterByNoCostRate	query	optional	boolean	Returns users who are missing cost rates(OCA only)
excludeContacts	query	optional	boolean	exclude contact types, returning only account and collaborator.
teamIds	query	optional	array	team ids
selectedColumns	query	optional	array	customise the report by selecting columns
projectIds	query	optional	array	filter by project ids
include	query	optional	array	include (not used when generating reports)
ids	query	optional	array	filter by user ids
fields[teams]	query	optional	array	—
fields[person]	query	optional	array	—
fields[people]	query	optional	array	—
fields[companies]	query	optional	array	—
fields[ProjectPermissions]	query	optional	array	—
excludeProjectIds	query	optional	array	exclude people assigned to certain project id
companyIds	query	optional	array	company ids

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/reporting/precanned/usertaskcompletion/{userId}.json

Projectupdates 2 endpoints

GET /projects/api/v3/projects/updates.json Get all project updates

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

operationId: ProjectUpdates_getAllUpdates

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	filter by updated after
projectStatus	query	optional	string	filter by project status
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
createdAfter	query	optional	string	filter by creation date
projectId	query	optional	integer	filter by project id
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showDeleted	query	optional	boolean	include deleted items
reactions	query	optional	boolean	add reactions to the response
onlyStarredProjects	query	optional	boolean	filter by starred projects only
matchAllProjectTags	query	optional	boolean	match all project tags
includeArchivedProjects	query	optional	boolean	include archived projects
emoji	query	optional	boolean	parse emojis to unicode
activeOnly	query	optional	boolean	filter by active
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	list of project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectHealths	query	optional	array	filter by project health
projectHealth	query	optional	array	filter by project health (deprecated, use projectHealths)
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
include	query	optional	array	include
fields[users]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/updates.json

GET /projects/api/v3/projects/{projectIds}/updates.json Get all updates from a specific project

Return the updates from a specific project.

operationId: ProjectUpdates_getAllUpdates

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	filter by updated after
projectStatus	query	optional	string	filter by project status
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
createdAfter	query	optional	string	filter by creation date
projectIds	path	required	integer	—
projectId	query	optional	integer	filter by project id
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showDeleted	query	optional	boolean	include deleted items
reactions	query	optional	boolean	add reactions to the response
onlyStarredProjects	query	optional	boolean	filter by starred projects only
matchAllProjectTags	query	optional	boolean	match all project tags
includeArchivedProjects	query	optional	boolean	include archived projects
emoji	query	optional	boolean	parse emojis to unicode
activeOnly	query	optional	boolean	filter by active
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	list of project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectHealths	query	optional	array	filter by project health
projectHealth	query	optional	array	filter by project health (deprecated, use projectHealths)
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
include	query	optional	array	include
fields[users]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/{projectIds}/updates.json

Projects 19 endpoints

GET /projects/api/v3/projects.json Returns a list of projects

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

operationId: Projects_listProjectsFilteredByCustomFields

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	updated after
searchTerm	query	optional	string	filter by project name
reportType	query	optional	string	define the type of the report
reportTimezone	query	optional	string	Optional to configure the report dates displayed in a timezone
reportFormat	query	optional	string	define the format of the report
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
minLastActivityDate	query	optional	string	filter by min last activity date
maxLastActivityDate	query	optional	string	filter by max last activity date
currencySymbol	query	optional	string	currency symbol for report export
userId	query	optional	integer	filter by user id
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
minBudgetCapacityUsedPercent	query	optional	integer	filter by minimum budget capacity used
maxBudgetCapacityUsedPercent	query	optional	integer	filter by maximum budget capacity used
useFormulaFields	query	optional	boolean	use formula fields
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchCompanies	query	optional	boolean	include companies in the search
searchByLetter	query	optional	boolean	search projects beginning with the search term character only when it contains a single character.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectsWithExplicitMembership	query	optional	boolean	only show projects with explicit membership
onlyProjectsThatCanLogTime	query	optional	boolean	can log time on projects
onlyArchivedProjects	query	optional	boolean	return only archived projects
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all excluded project tags
isReportDownload	query	optional	boolean	generate a report document
includeTentativeProjects	query	optional	boolean	include alongside normal projects, tentative ones
includeSubCategories	query	optional	boolean	include sub categories when filtering by ids
includeStats	query	optional	boolean	include project status counts for tasks columns billing events milestones
includeProjectUserInfo	query	optional	boolean	fetch user-specific data such as isStarred
includeProjectProfitability	query	optional	boolean	include project profitability in response
includeProjectDates	query	optional	boolean	include minimum and maximum start/end dates for projects
includeCustomFields	query	optional	boolean	include custom fields
includeCounts	query	optional	boolean	include project related counts
includeCompletedStatus	query	optional	boolean	optional to include completed projects when filtering by project statuses “current,late”.
includeArchivedProjects	query	optional	boolean	include archived projects
hideObservedProjects	query	optional	boolean	hide projects where the logged-in user is just an observer
alwaysIncludeFiltering	query	optional	boolean	includes filters when project ids are provided
teamIds	query	optional	array	filter by projects that contain users associated with the team ids
selectedColumns	query	optional	array	select the columns to use in exports.
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include (not used when generating reports)
fields[workflows]	query	optional	array	—
fields[users]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[stages]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectcategories]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—
fields[projectBudgets]	query	optional	array	—
fields[portfolioColumns]	query	optional	array	—
fields[portfolioCards]	query	optional	array	—
fields[portfolioBoards]	query	optional	array	—
fields[industries]	query	optional	array	—
fields[customfields]	query	optional	array	—
fields[customfieldProjects]	query	optional	array	—
fields[countries]	query	optional	array	—
fields[companies]	query	optional	array	—
featuresEnabled	query	optional	array	filter by projects that have features enabled
excludeTagIds	query	optional	array	exclude by project tag ids

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects.json

PUT /projects/api/v3/projects/featureorder.json Sets the default features order to display in tab

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

operationId: Projects_setDefaultFeaturesOrder

Request Body

required

application/json

schema project.FeatureOrderDefaults

Property	Type	Required
list	integer	optional
time	integer	optional
board	integer	optional
files	integer	optional
forms	integer	optional
gantt	integer	optional
links	integer	optional
risks	integer	optional
table	integer	optional
people	integer	optional
proofs	integer	optional
billing	integer	optional
finance	integer	optional
comments	integer	optional
messages	integer	optional
settings	integer	optional
dashboard	integer	optional
notebooks	integer	optional
milestones	integer	optional
numVisibleTabs	integer	optional

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

PUT /projects/api/v3/projects/featureorder.json

GET /projects/api/v3/projects/metrics/active.json Get the total count of active projects

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

operationId: Projects_getActiveCount

Responses

200

200 OK

400

400 Bad Request

404

404 Not Found (no data)

GET /projects/api/v3/projects/metrics/active.json

GET /projects/api/v3/projects/metrics/billable.json Get the total billable time per project

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

operationId: Projects_getTotalBillableTime

Parameters

Name	In	Required	Type	Description
startDate	query	optional	string	—
orderMode	query	optional	string	order mode
endDate	query	optional	string	—

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/metrics/billable.json

GET /projects/api/v3/projects/metrics/healths.json Get a health summary for all projects

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

operationId: Projects_getAllHealthSummaries

Parameters

Name	In	Required	Type	Description
projectStatus	query	optional	string	filter by project status
onlyStarredProjects	query	optional	boolean	filter by starred projects only
matchAllProjectTags	query	optional	boolean	match all project tags
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project statuses
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	project health 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/metrics/healths.json

GET /projects/api/v3/projects/metrics/invoice.json Return open invoices across all projects

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

operationId: Projects_getAllOpenInvoices

Parameters

Name	In	Required	Type	Description
onlyStarredProjects	query	optional	boolean	filter by starred projects only
matchAllProjectTags	query	optional	boolean	match all project tags
includeArchivedProjects	query	optional	boolean	include archived projects
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	project health 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/metrics/invoice.json

GET /projects/api/v3/projects/metrics/owners.json Get number of owned and un-assigned projects

Count the number of projects per project owner user.

operationId: Projects_countOwnedProjects

Parameters

Name	In	Required	Type	Description
orderMode	query	optional	string	sort order
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
matchAllProjectTags	query	optional	boolean	match all project tags
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	project health 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/metrics/owners.json

GET /projects/api/v3/projects/metrics/unbilled.json Return un-billed expenses across all projects

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

operationId: Projects_getUnbilledExpenses

Parameters

Name	In	Required	Type	Description
onlyStarredProjects	query	optional	boolean	filter by starred projects only
matchAllProjectTags	query	optional	boolean	match all project tags
includeArchivedProjects	query	optional	boolean	include archived projects
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	project health 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/metrics/unbilled.json

GET /projects/api/v3/projects/starred.json Returns a list of starred projects

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

operationId: Projects_listStarredProjects

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	updated after
searchTerm	query	optional	string	filter by project name
reportType	query	optional	string	define the type of the report
reportTimezone	query	optional	string	Optional to configure the report dates displayed in a timezone
reportFormat	query	optional	string	define the format of the report
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
minLastActivityDate	query	optional	string	filter by min last activity date
maxLastActivityDate	query	optional	string	filter by max last activity date
currencySymbol	query	optional	string	currency symbol for report export
userId	query	optional	integer	filter by user id
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
minBudgetCapacityUsedPercent	query	optional	integer	filter by minimum budget capacity used
maxBudgetCapacityUsedPercent	query	optional	integer	filter by maximum budget capacity used
useFormulaFields	query	optional	boolean	use formula fields
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchCompanies	query	optional	boolean	include companies in the search
searchByLetter	query	optional	boolean	search projects beginning with the search term character only when it contains a single character.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectsWithExplicitMembership	query	optional	boolean	only show projects with explicit membership
onlyProjectsThatCanLogTime	query	optional	boolean	can log time on projects
onlyArchivedProjects	query	optional	boolean	return only archived projects
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all excluded project tags
isReportDownload	query	optional	boolean	generate a report document
includeTentativeProjects	query	optional	boolean	include alongside normal projects, tentative ones
includeSubCategories	query	optional	boolean	include sub categories when filtering by ids
includeStats	query	optional	boolean	include project status counts for tasks columns billing events milestones
includeProjectUserInfo	query	optional	boolean	fetch user-specific data such as isStarred
includeProjectProfitability	query	optional	boolean	include project profitability in response
includeProjectDates	query	optional	boolean	include minimum and maximum start/end dates for projects
includeCustomFields	query	optional	boolean	include custom fields
includeCounts	query	optional	boolean	include project related counts
includeCompletedStatus	query	optional	boolean	optional to include completed projects when filtering by project statuses “current,late”.
includeArchivedProjects	query	optional	boolean	include archived projects
hideObservedProjects	query	optional	boolean	hide projects where the logged-in user is just an observer
alwaysIncludeFiltering	query	optional	boolean	includes filters when project ids are provided
teamIds	query	optional	array	filter by projects that contain users associated with the team ids
selectedColumns	query	optional	array	select the columns to use in exports.
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include (not used when generating reports)
fields[workflows]	query	optional	array	—
fields[users]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[stages]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectcategories]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—
fields[projectBudgets]	query	optional	array	—
fields[portfolioColumns]	query	optional	array	—
fields[portfolioCards]	query	optional	array	—
fields[portfolioBoards]	query	optional	array	—
fields[industries]	query	optional	array	—
fields[customfields]	query	optional	array	—
fields[customfieldProjects]	query	optional	array	—
fields[countries]	query	optional	array	—
fields[companies]	query	optional	array	—
featuresEnabled	query	optional	array	filter by projects that have features enabled
excludeTagIds	query	optional	array	exclude by project tag ids

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/starred.json

GET /projects/api/v3/projects/teamwork/samples.json Returns a list of teamwork sample projects

Retrieve all sample projects for the provided filters.

operationId: Projects_listTeamworkSamples

Parameters

Name	In	Required	Type	Description
searchTerm	query	optional	string	filter by project name
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
ids	query	optional	array	filter by sample ids
fields[sampleprojects]	query	optional	array	—
categoryIds	query	optional	array	filter by category ids

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/teamwork/samples.json

GET /projects/api/v3/projects/templates.json Returns a list of projects templates

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

operationId: Projects_listProjectTemplates

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	updated after
searchTerm	query	optional	string	filter by project name
reportType	query	optional	string	define the type of the report
reportTimezone	query	optional	string	Optional to configure the report dates displayed in a timezone
reportFormat	query	optional	string	define the format of the report
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
minLastActivityDate	query	optional	string	filter by min last activity date
maxLastActivityDate	query	optional	string	filter by max last activity date
currencySymbol	query	optional	string	currency symbol for report export
userId	query	optional	integer	filter by user id
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
minBudgetCapacityUsedPercent	query	optional	integer	filter by minimum budget capacity used
maxBudgetCapacityUsedPercent	query	optional	integer	filter by maximum budget capacity used
useFormulaFields	query	optional	boolean	use formula fields
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchCompanies	query	optional	boolean	include companies in the search
searchByLetter	query	optional	boolean	search projects beginning with the search term character only when it contains a single character.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectsWithExplicitMembership	query	optional	boolean	only show projects with explicit membership
onlyProjectsThatCanLogTime	query	optional	boolean	can log time on projects
onlyArchivedProjects	query	optional	boolean	return only archived projects
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all excluded project tags
isReportDownload	query	optional	boolean	generate a report document
includeTentativeProjects	query	optional	boolean	include alongside normal projects, tentative ones
includeSubCategories	query	optional	boolean	include sub categories when filtering by ids
includeStats	query	optional	boolean	include project status counts for tasks columns billing events milestones
includeProjectUserInfo	query	optional	boolean	fetch user-specific data such as isStarred
includeProjectProfitability	query	optional	boolean	include project profitability in response
includeProjectDates	query	optional	boolean	include minimum and maximum start/end dates for projects
includeCustomFields	query	optional	boolean	include custom fields
includeCounts	query	optional	boolean	include project related counts
includeCompletedStatus	query	optional	boolean	optional to include completed projects when filtering by project statuses “current,late”.
includeArchivedProjects	query	optional	boolean	include archived projects
hideObservedProjects	query	optional	boolean	hide projects where the logged-in user is just an observer
alwaysIncludeFiltering	query	optional	boolean	includes filters when project ids are provided
teamIds	query	optional	array	filter by projects that contain users associated with the team ids
selectedColumns	query	optional	array	select the columns to use in exports.
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include (not used when generating reports)
fields[workflows]	query	optional	array	—
fields[users]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[stages]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectcategories]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—
fields[projectBudgets]	query	optional	array	—
fields[portfolioColumns]	query	optional	array	—
fields[portfolioCards]	query	optional	array	—
fields[portfolioBoards]	query	optional	array	—
fields[industries]	query	optional	array	—
fields[customfields]	query	optional	array	—
fields[customfieldProjects]	query	optional	array	—
fields[countries]	query	optional	array	—
fields[companies]	query	optional	array	—
featuresEnabled	query	optional	array	filter by projects that have features enabled
excludeTagIds	query	optional	array	exclude by project tag ids

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/templates.json

PUT /projects/api/v3/projects/tentative/{projectId}/convert.json Converts the given tentative project into normal

operationId: Projects_convertTentativeProject

Parameters

Name	In	Required	Type	Description
projectId	path	required	integer	—

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

PUT /projects/api/v3/projects/tentative/{projectId}/convert.json

GET /projects/api/v3/projects/{projectId}.json Returns a project

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

operationId: Projects_getProjectByCustomFields

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	updated after
searchTerm	query	optional	string	filter by project name
reportType	query	optional	string	define the type of the report
reportTimezone	query	optional	string	Optional to configure the report dates displayed in a timezone
reportFormat	query	optional	string	define the format of the report
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
minLastActivityDate	query	optional	string	filter by min last activity date
maxLastActivityDate	query	optional	string	filter by max last activity date
currencySymbol	query	optional	string	currency symbol for report export
userId	query	optional	integer	filter by user id
projectId	path	required	integer	—
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
minBudgetCapacityUsedPercent	query	optional	integer	filter by minimum budget capacity used
maxBudgetCapacityUsedPercent	query	optional	integer	filter by maximum budget capacity used
useFormulaFields	query	optional	boolean	use formula fields
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchCompanies	query	optional	boolean	include companies in the search
searchByLetter	query	optional	boolean	search projects beginning with the search term character only when it contains a single character.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectsWithExplicitMembership	query	optional	boolean	only show projects with explicit membership
onlyProjectsThatCanLogTime	query	optional	boolean	can log time on projects
onlyArchivedProjects	query	optional	boolean	return only archived projects
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all excluded project tags
isReportDownload	query	optional	boolean	generate a report document
includeTentativeProjects	query	optional	boolean	include alongside normal projects, tentative ones
includeSubCategories	query	optional	boolean	include sub categories when filtering by ids
includeStats	query	optional	boolean	include project status counts for tasks columns billing events milestones
includeProjectUserInfo	query	optional	boolean	fetch user-specific data such as isStarred
includeProjectProfitability	query	optional	boolean	include project profitability in response
includeProjectDates	query	optional	boolean	include minimum and maximum start/end dates for projects
includeCustomFields	query	optional	boolean	include custom fields
includeCounts	query	optional	boolean	include project related counts
includeCompletedStatus	query	optional	boolean	optional to include completed projects when filtering by project statuses “current,late”.
includeArchivedProjects	query	optional	boolean	include archived projects
hideObservedProjects	query	optional	boolean	hide projects where the logged-in user is just an observer
alwaysIncludeFiltering	query	optional	boolean	includes filters when project ids are provided
teamIds	query	optional	array	filter by projects that contain users associated with the team ids
selectedColumns	query	optional	array	select the columns to use in exports.
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include (not used when generating reports)
fields[workflows]	query	optional	array	—
fields[users]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[stages]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectcategories]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—
fields[projectBudgets]	query	optional	array	—
fields[portfolioColumns]	query	optional	array	—
fields[portfolioCards]	query	optional	array	—
fields[portfolioBoards]	query	optional	array	—
fields[industries]	query	optional	array	—
fields[customfields]	query	optional	array	—
fields[customfieldProjects]	query	optional	array	—
fields[countries]	query	optional	array	—
fields[companies]	query	optional	array	—
featuresEnabled	query	optional	array	filter by projects that have features enabled
excludeTagIds	query	optional	array	exclude by project tag ids

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

404

404 Not Found (no data)

GET /projects/api/v3/projects/{projectId}.json

GET /projects/api/v3/projects/{projectId}/featureorder.json Returns a project features order to display in tab

operationId: Projects_getFeatureOrder

Parameters

Name	In	Required	Type	Description
projectId	path	required	integer	—

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/{projectId}/featureorder.json

PUT /projects/api/v3/projects/{projectId}/featureorder.json Sets the the features order to display in tab

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

operationId: Projects_updateFeatureOrder

Parameters

Name	In	Required	Type	Description
projectId	path	required	integer	—

Request Body

required

application/json

schema project.FeatureOrderRequest

Property	Type	Required
featureOrder	object	optional
└ id	integer	optional
└ list	integer	optional
└ time	integer	optional
└ board	integer	optional
└ files	integer	optional
└ forms	integer	optional
└ gantt	integer	optional
└ links	integer	optional
└ risks	integer	optional
└ table	integer	optional
└ people	integer	optional
└ proofs	integer	optional
└ billing	integer	optional
└ finance	integer	optional
└ comments	integer	optional
└ messages	integer	optional
└ settings	integer	optional
└ dashboard	integer	optional
└ notebooks	integer	optional
└ projectId	integer	optional
└ …3 more	object	optional
featureOrderOptions	object	optional
└ useNotifyViaTWIM	boolean	optional

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

PUT /projects/api/v3/projects/{projectId}/featureorder.json

GET /projects/api/v3/reporting/precanned/health/projects.csv Generate project report in CSV format

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

operationId: Projects_generateProjectReportCsv

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	updated after
searchTerm	query	optional	string	filter by project name
reportType	query	optional	string	define the type of the report
reportTimezone	query	optional	string	Optional to configure the report dates displayed in a timezone
reportFormat	query	optional	string	define the format of the report
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
minLastActivityDate	query	optional	string	filter by min last activity date
maxLastActivityDate	query	optional	string	filter by max last activity date
currencySymbol	query	optional	string	currency symbol for report export
userId	query	optional	integer	filter by user id
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
minBudgetCapacityUsedPercent	query	optional	integer	filter by minimum budget capacity used
maxBudgetCapacityUsedPercent	query	optional	integer	filter by maximum budget capacity used
useFormulaFields	query	optional	boolean	use formula fields
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchCompanies	query	optional	boolean	include companies in the search
searchByLetter	query	optional	boolean	search projects beginning with the search term character only when it contains a single character.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectsWithExplicitMembership	query	optional	boolean	only show projects with explicit membership
onlyProjectsThatCanLogTime	query	optional	boolean	can log time on projects
onlyArchivedProjects	query	optional	boolean	return only archived projects
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all excluded project tags
isReportDownload	query	optional	boolean	generate a report document
includeTentativeProjects	query	optional	boolean	include alongside normal projects, tentative ones
includeSubCategories	query	optional	boolean	include sub categories when filtering by ids
includeStats	query	optional	boolean	include project status counts for tasks columns billing events milestones
includeProjectUserInfo	query	optional	boolean	fetch user-specific data such as isStarred
includeProjectProfitability	query	optional	boolean	include project profitability in response
includeProjectDates	query	optional	boolean	include minimum and maximum start/end dates for projects
includeCustomFields	query	optional	boolean	include custom fields
includeCounts	query	optional	boolean	include project related counts
includeCompletedStatus	query	optional	boolean	optional to include completed projects when filtering by project statuses “current,late”.
includeArchivedProjects	query	optional	boolean	include archived projects
hideObservedProjects	query	optional	boolean	hide projects where the logged-in user is just an observer
alwaysIncludeFiltering	query	optional	boolean	includes filters when project ids are provided
teamIds	query	optional	array	filter by projects that contain users associated with the team ids
selectedColumns	query	optional	array	select the columns to use in exports.
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include (not used when generating reports)
fields[workflows]	query	optional	array	—
fields[users]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[stages]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectcategories]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—
fields[projectBudgets]	query	optional	array	—
fields[portfolioColumns]	query	optional	array	—
fields[portfolioCards]	query	optional	array	—
fields[portfolioBoards]	query	optional	array	—
fields[industries]	query	optional	array	—
fields[customfields]	query	optional	array	—
fields[customfieldProjects]	query	optional	array	—
fields[countries]	query	optional	array	—
fields[companies]	query	optional	array	—
featuresEnabled	query	optional	array	filter by projects that have features enabled
excludeTagIds	query	optional	array	exclude by project tag ids

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/reporting/precanned/health/projects.csv

GET /projects/api/v3/reporting/precanned/health/projects.html Generate project report in HTML format

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

operationId: Projects_generateProjectReportHtml

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	updated after
searchTerm	query	optional	string	filter by project name
reportType	query	optional	string	define the type of the report
reportTimezone	query	optional	string	Optional to configure the report dates displayed in a timezone
reportFormat	query	optional	string	define the format of the report
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
minLastActivityDate	query	optional	string	filter by min last activity date
maxLastActivityDate	query	optional	string	filter by max last activity date
currencySymbol	query	optional	string	currency symbol for report export
userId	query	optional	integer	filter by user id
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
minBudgetCapacityUsedPercent	query	optional	integer	filter by minimum budget capacity used
maxBudgetCapacityUsedPercent	query	optional	integer	filter by maximum budget capacity used
useFormulaFields	query	optional	boolean	use formula fields
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchCompanies	query	optional	boolean	include companies in the search
searchByLetter	query	optional	boolean	search projects beginning with the search term character only when it contains a single character.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectsWithExplicitMembership	query	optional	boolean	only show projects with explicit membership
onlyProjectsThatCanLogTime	query	optional	boolean	can log time on projects
onlyArchivedProjects	query	optional	boolean	return only archived projects
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all excluded project tags
isReportDownload	query	optional	boolean	generate a report document
includeTentativeProjects	query	optional	boolean	include alongside normal projects, tentative ones
includeSubCategories	query	optional	boolean	include sub categories when filtering by ids
includeStats	query	optional	boolean	include project status counts for tasks columns billing events milestones
includeProjectUserInfo	query	optional	boolean	fetch user-specific data such as isStarred
includeProjectProfitability	query	optional	boolean	include project profitability in response
includeProjectDates	query	optional	boolean	include minimum and maximum start/end dates for projects
includeCustomFields	query	optional	boolean	include custom fields
includeCounts	query	optional	boolean	include project related counts
includeCompletedStatus	query	optional	boolean	optional to include completed projects when filtering by project statuses “current,late”.
includeArchivedProjects	query	optional	boolean	include archived projects
hideObservedProjects	query	optional	boolean	hide projects where the logged-in user is just an observer
alwaysIncludeFiltering	query	optional	boolean	includes filters when project ids are provided
teamIds	query	optional	array	filter by projects that contain users associated with the team ids
selectedColumns	query	optional	array	select the columns to use in exports.
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include (not used when generating reports)
fields[workflows]	query	optional	array	—
fields[users]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[stages]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectcategories]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—
fields[projectBudgets]	query	optional	array	—
fields[portfolioColumns]	query	optional	array	—
fields[portfolioCards]	query	optional	array	—
fields[portfolioBoards]	query	optional	array	—
fields[industries]	query	optional	array	—
fields[customfields]	query	optional	array	—
fields[customfieldProjects]	query	optional	array	—
fields[countries]	query	optional	array	—
fields[companies]	query	optional	array	—
featuresEnabled	query	optional	array	filter by projects that have features enabled
excludeTagIds	query	optional	array	exclude by project tag ids

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/reporting/precanned/health/projects.html

GET /projects/api/v3/reporting/precanned/health/projects.pdf Generate project report in PDF format

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

operationId: Projects_generateProjectReportPdf

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	updated after
searchTerm	query	optional	string	filter by project name
reportType	query	optional	string	define the type of the report
reportTimezone	query	optional	string	Optional to configure the report dates displayed in a timezone
reportFormat	query	optional	string	define the format of the report
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
minLastActivityDate	query	optional	string	filter by min last activity date
maxLastActivityDate	query	optional	string	filter by max last activity date
currencySymbol	query	optional	string	currency symbol for report export
userId	query	optional	integer	filter by user id
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
minBudgetCapacityUsedPercent	query	optional	integer	filter by minimum budget capacity used
maxBudgetCapacityUsedPercent	query	optional	integer	filter by maximum budget capacity used
useFormulaFields	query	optional	boolean	use formula fields
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchCompanies	query	optional	boolean	include companies in the search
searchByLetter	query	optional	boolean	search projects beginning with the search term character only when it contains a single character.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectsWithExplicitMembership	query	optional	boolean	only show projects with explicit membership
onlyProjectsThatCanLogTime	query	optional	boolean	can log time on projects
onlyArchivedProjects	query	optional	boolean	return only archived projects
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all excluded project tags
isReportDownload	query	optional	boolean	generate a report document
includeTentativeProjects	query	optional	boolean	include alongside normal projects, tentative ones
includeSubCategories	query	optional	boolean	include sub categories when filtering by ids
includeStats	query	optional	boolean	include project status counts for tasks columns billing events milestones
includeProjectUserInfo	query	optional	boolean	fetch user-specific data such as isStarred
includeProjectProfitability	query	optional	boolean	include project profitability in response
includeProjectDates	query	optional	boolean	include minimum and maximum start/end dates for projects
includeCustomFields	query	optional	boolean	include custom fields
includeCounts	query	optional	boolean	include project related counts
includeCompletedStatus	query	optional	boolean	optional to include completed projects when filtering by project statuses “current,late”.
includeArchivedProjects	query	optional	boolean	include archived projects
hideObservedProjects	query	optional	boolean	hide projects where the logged-in user is just an observer
alwaysIncludeFiltering	query	optional	boolean	includes filters when project ids are provided
teamIds	query	optional	array	filter by projects that contain users associated with the team ids
selectedColumns	query	optional	array	select the columns to use in exports.
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include (not used when generating reports)
fields[workflows]	query	optional	array	—
fields[users]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[stages]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectcategories]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—
fields[projectBudgets]	query	optional	array	—
fields[portfolioColumns]	query	optional	array	—
fields[portfolioCards]	query	optional	array	—
fields[portfolioBoards]	query	optional	array	—
fields[industries]	query	optional	array	—
fields[customfields]	query	optional	array	—
fields[customfieldProjects]	query	optional	array	—
fields[countries]	query	optional	array	—
fields[companies]	query	optional	array	—
featuresEnabled	query	optional	array	filter by projects that have features enabled
excludeTagIds	query	optional	array	exclude by project tag ids

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/reporting/precanned/health/projects.pdf

GET /projects/api/v3/reporting/precanned/health/projects.xlsx Generate project report in XLSX format

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

operationId: Projects_generateProjectReportXlsx

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	updated after
searchTerm	query	optional	string	filter by project name
reportType	query	optional	string	define the type of the report
reportTimezone	query	optional	string	Optional to configure the report dates displayed in a timezone
reportFormat	query	optional	string	define the format of the report
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
minLastActivityDate	query	optional	string	filter by min last activity date
maxLastActivityDate	query	optional	string	filter by max last activity date
currencySymbol	query	optional	string	currency symbol for report export
userId	query	optional	integer	filter by user id
pageSize	query	optional	integer	number of items in a page (not used when generating reports)
page	query	optional	integer	page number (not used when generating reports)
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
minBudgetCapacityUsedPercent	query	optional	integer	filter by minimum budget capacity used
maxBudgetCapacityUsedPercent	query	optional	integer	filter by maximum budget capacity used
useFormulaFields	query	optional	boolean	use formula fields
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchCompanies	query	optional	boolean	include companies in the search
searchByLetter	query	optional	boolean	search projects beginning with the search term character only when it contains a single character.
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectsWithExplicitMembership	query	optional	boolean	only show projects with explicit membership
onlyProjectsThatCanLogTime	query	optional	boolean	can log time on projects
onlyArchivedProjects	query	optional	boolean	return only archived projects
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all excluded project tags
isReportDownload	query	optional	boolean	generate a report document
includeTentativeProjects	query	optional	boolean	include alongside normal projects, tentative ones
includeSubCategories	query	optional	boolean	include sub categories when filtering by ids
includeStats	query	optional	boolean	include project status counts for tasks columns billing events milestones
includeProjectUserInfo	query	optional	boolean	fetch user-specific data such as isStarred
includeProjectProfitability	query	optional	boolean	include project profitability in response
includeProjectDates	query	optional	boolean	include minimum and maximum start/end dates for projects
includeCustomFields	query	optional	boolean	include custom fields
includeCounts	query	optional	boolean	include project related counts
includeCompletedStatus	query	optional	boolean	optional to include completed projects when filtering by project statuses “current,late”.
includeArchivedProjects	query	optional	boolean	include archived projects
hideObservedProjects	query	optional	boolean	hide projects where the logged-in user is just an observer
alwaysIncludeFiltering	query	optional	boolean	includes filters when project ids are provided
teamIds	query	optional	array	filter by projects that contain users associated with the team ids
selectedColumns	query	optional	array	select the columns to use in exports.
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include (not used when generating reports)
fields[workflows]	query	optional	array	—
fields[users]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[stages]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[projectcategories]	query	optional	array	—
fields[projectUpdates]	query	optional	array	—
fields[projectBudgets]	query	optional	array	—
fields[portfolioColumns]	query	optional	array	—
fields[portfolioCards]	query	optional	array	—
fields[portfolioBoards]	query	optional	array	—
fields[industries]	query	optional	array	—
fields[customfields]	query	optional	array	—
fields[customfieldProjects]	query	optional	array	—
fields[countries]	query	optional	array	—
fields[companies]	query	optional	array	—
featuresEnabled	query	optional	array	filter by projects that have features enabled
excludeTagIds	query	optional	array	exclude by project tag ids

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/reporting/precanned/health/projects.xlsx

Risks 3 endpoints

GET /projects/api/v3/projects/{projectId}/risks Get risks for a specific project

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

operationId: Risks_forProjectGet

Parameters

Name	In	Required	Type	Description
updatedAfterDate	query	optional	string	filter by risks updated after specified date (deprecated, use updatedAfter)
updatedAfter	query	optional	string	filter by risks updated after specified date
sortOrder	query	optional	string	sort order (deprecated, use orderMode)
sort	query	optional	string	sort by (deprecated, use orderBy)
searchTerm	query	optional	string	search term
reportFormat	query	optional	string	define the format of the report
orderMode	query	optional	string	sort order
orderBy	query	optional	string	sort by
projectId	path	required	integer	—
probabilityTo	query	optional	integer	filter by probability
probabilityFrom	query	optional	integer	filter by probability
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
impactTo	query	optional	integer	filter by impact
impactFrom	query	optional	integer	filter by impact
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showDeleted	query	optional	boolean	include deleted items
onlyStarredProjects	query	optional	boolean	filter by starred projects only
matchAllProjectTags	query	optional	boolean	enforce all tag ids must be matched
isReportDownload	query	optional	boolean	generate a report document
includeArchivedProjects	query	optional	boolean	include archived projects
impactSchedule	query	optional	boolean	filter by risks that impact schedule
impactPerformance	query	optional	boolean	filter by risks that impact performance
impactCost	query	optional	boolean	filter by risks that impact cost
statuses	query	optional	array	filter by risk statuses
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	list of project statuses
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	list of project health
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
include	query	optional	array	include
ids	query	optional	array	filter by specific ids
fields[users]	query	optional	array	—
fields[risks]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[companies]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/{projectId}/risks

PUT /projects/api/v3/projects/{projectId}/risks/copy Copies project risks

Copies the risk register from one project to another.

operationId: Risks_copyProjectRiskRegister

Parameters

Name	In	Required	Type	Description
projectId	path	required	integer	—

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

404

404 Not Found (no data)

PUT /projects/api/v3/projects/{projectId}/risks/copy

GET /projects/api/v3/risks.json Get all risks

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

operationId: Risks_getAll

Parameters

Name	In	Required	Type	Description
updatedAfterDate	query	optional	string	filter by risks updated after specified date (deprecated, use updatedAfter)
updatedAfter	query	optional	string	filter by risks updated after specified date
sortOrder	query	optional	string	sort order (deprecated, use orderMode)
sort	query	optional	string	sort by (deprecated, use orderBy)
searchTerm	query	optional	string	search term
reportFormat	query	optional	string	define the format of the report
orderMode	query	optional	string	sort order
orderBy	query	optional	string	sort by
probabilityTo	query	optional	integer	filter by probability
probabilityFrom	query	optional	integer	filter by probability
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
impactTo	query	optional	integer	filter by impact
impactFrom	query	optional	integer	filter by impact
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showDeleted	query	optional	boolean	include deleted items
onlyStarredProjects	query	optional	boolean	filter by starred projects only
matchAllProjectTags	query	optional	boolean	enforce all tag ids must be matched
isReportDownload	query	optional	boolean	generate a report document
includeArchivedProjects	query	optional	boolean	include archived projects
impactSchedule	query	optional	boolean	filter by risks that impact schedule
impactPerformance	query	optional	boolean	filter by risks that impact performance
impactCost	query	optional	boolean	filter by risks that impact cost
statuses	query	optional	array	filter by risk statuses
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	list of project statuses
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	list of project health
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
include	query	optional	array	include
ids	query	optional	array	filter by specific ids
fields[users]	query	optional	array	—
fields[risks]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[companies]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/risks.json

Summary 2 endpoints

GET /projects/api/v3/projects/{projectId}/summary.json Get project summary dashboard

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

operationId: Summary_getProjectSummaryDashboardByProjectCustomFields

Parameters

Name	In	Required	Type	Description
until	query	optional	string	used to limit the since counters to a specific period
timeRangeStart	query	optional	string	filter by start datetime
timeRangeEnd	query	optional	string	filter by end datetime
timeRange	query	optional	string	filter by time range. It will be ignored if timeRangeStart and timeRangeEnd were informed.
status	query	optional	string	project status (deprecated, use projectStatuses)
projectStatus	query	optional	string	project status
projectId	path	required	integer	—
eventsDaysAhead	query	optional	integer	number of days remaining to event’s start
useStartDatesForTodaysTasks	query	optional	boolean	enforce today is considered as start date for today’s tasks
unreadMessagesMineOnly	query	optional	boolean	filter by my unread messages only
unreadCommentsMineOnly	query	optional	boolean	filter by my unread comments only
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectEvents	query	optional	boolean	filter only project events
matchAllTags	query	optional	boolean	enforce all tag ids must be matched (deprecated, use matchAllProjectTags)
matchAllProjectTags	query	optional	boolean	enforce all tag ids must be matched
includeAssigneeTeams	query	optional	boolean	include teams related to the taskAssigneeUserIds
includeArchivedProjects	query	optional	boolean	include archived projects
eventsAttendingOnly	query	optional	boolean	count only events that the users are attending
applyTaskAssigneeUsersToSince	query	optional	boolean	the since section will only use taskAssigneeUserIds if this flag is true (keeps backward compatibility)
applySinceOnUnread	query	optional	boolean	when enabled unread counters will respect the time range period.
userIds	query	optional	array	filter by user ids
timeLoggedByUserIds	query	optional	array	filter by user ids who time logged
taskAssigneeUserIds	query	optional	array	filter by user ids with tasks assigned
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	project statuses
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	project healths 0: not set 1: bad 2: ok 3: good
projectHealth	query	optional	array	project health (deprecated, use projectHealths) 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
milestoneAssigneeUserIds	query	optional	array	filter by user ids with milestones assigned
health	query	optional	array	project healths (deprecated, use projectHealths) 0: not set 1: bad 2: ok 3: good
filterTagIds	query	optional	array	filter by project tag ids (deprecated, use projectTagIds)
fields[unread]	query	optional	array	—
fields[time]	query	optional	array	—
fields[tasks]	query	optional	array	sparse fields
fields[since]	query	optional	array	—
fields[risks]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[health]	query	optional	array	0: not set 1: bad 2: ok 3: good
fields[events]	query	optional	array	—
fields[columns]	query	optional	array	—
companyIds	query	optional	array	filter by company ids (deprecated, use projectCompanyIds)
assigneeUserIds	query	optional	array	filter by user ids with tasks or milestones assigned

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/{projectId}/summary.json

GET /projects/api/v3/summary.json Get installation summary dashboard

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

operationId: Summary_dashboardDataByProjectCustomFields

Parameters

Name	In	Required	Type	Description
until	query	optional	string	used to limit the since counters to a specific period
timeRangeStart	query	optional	string	filter by start datetime
timeRangeEnd	query	optional	string	filter by end datetime
timeRange	query	optional	string	filter by time range. It will be ignored if timeRangeStart and timeRangeEnd are provided.
status	query	optional	string	project status (deprecated, use projectStatuses)
projectStatus	query	optional	string	project status
eventsDaysAhead	query	optional	integer	number of days remaining to event’s start
useStartDatesForTodaysTasks	query	optional	boolean	enforce today is considered as start date for today’s tasks
unreadMessagesMineOnly	query	optional	boolean	filter by my unread messages only
unreadCommentsMineOnly	query	optional	boolean	filter by my unread comments only
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyProjectEvents	query	optional	boolean	filter only project events
matchAllTags	query	optional	boolean	enforce all tag ids must be matched (deprecated, use matchAllProjectTags)
matchAllProjectTags	query	optional	boolean	enforce all tag ids must be matched
includeAssigneeTeams	query	optional	boolean	include teams related to the taskAssigneeUserIds
includeArchivedProjects	query	optional	boolean	include archived projects
eventsAttendingOnly	query	optional	boolean	count only events that the users are attending
applyTaskAssigneeUsersToSince	query	optional	boolean	the since section will only use taskAssigneeUserIds if this flag is true (keeps backward compatibility)
applySinceOnUnread	query	optional	boolean	when enabled unread counters will respect the time range period.
userIds	query	optional	array	filter by user ids
timeLoggedByUserIds	query	optional	array	filter by user ids who time logged
taskAssigneeUserIds	query	optional	array	filter by user ids with tasks assigned
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	project statuses
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	project healths 0: not set 1: bad 2: ok 3: good
projectHealth	query	optional	array	project healths (deprecated, use projectHealths) 0: not set 1: bad 2: ok 3: good
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
milestoneAssigneeUserIds	query	optional	array	filter by user ids with milestones assigned
filterTagIds	query	optional	array	filter by project tag ids (deprecated, use projectTagIds)
fields[unread]	query	optional	array	—
fields[time]	query	optional	array	—
fields[tasks]	query	optional	array	sparse fields
fields[since]	query	optional	array	—
fields[risks]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[health]	query	optional	array	0: not set 1: bad 2: ok 3: good
fields[events]	query	optional	array	—
fields[columns]	query	optional	array	—
companyIds	query	optional	array	filter by company ids (deprecated, use projectCompanyIds)
assigneeUserIds	query	optional	array	filter by user ids with tasks or milestones assigned

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/summary.json

Tags 6 endpoints

GET /projects/api/v3/tags.json Get all tags

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

operationId: Tags_getAll

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	search for tags updated after the provided date
searchTerm	query	optional	string	filter by search term
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
itemType	query	optional	string	filter by item type
filter	query	optional	string	mode used when filtering the tags
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
withCounters	query	optional	boolean	include in the response the number of items that use the tag
skipSpecial	query	optional	boolean	do not include in the response special tags
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
searchRightOnly	query	optional	boolean	search term will be placed as a prefix to match the tag names
skipIds	query	optional	array	skip from the result tags with the defined ids
projectIds	query	optional	array	filter by projects
ids	query	optional	array	filter by ids
fields[tags]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/tags.json

POST /projects/api/v3/tags.json Create a single tag

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).

operationId: Tags_createTag

Request Body

application/json

schema tag.Request

Property	Type	Required
tag	object	optional
└ name	string	optional
└ color	string	optional
└ projectId	integer	optional

Responses

200

200 OK

201

201 Created

400

400 Bad Request

403

403 Forbidden

409

409 Conflict

POST /projects/api/v3/tags.json

POST /projects/api/v3/tags/bulk/delete.json Delete many tags at once

Removes many tags at once.

operationId: Tags_deleteManyTags

Request Body

required

application/json

schema tag.BulkDeleteRequest

Property	Type	Required
tagIds	array	optional
tagNames	array	optional

Responses

204

204 No Content (no data)

400

400 Bad Request

403

403 Forbidden

404

404 Not Found (no data)

POST /projects/api/v3/tags/bulk/delete.json

DELETE /projects/api/v3/tags/{tagId}.json Deletes a tag

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

operationId: Tags_removeTag

Parameters

Name	In	Required	Type	Description
tagId	path	required	integer	—

Responses

204

204 No Content (no data)

400

400 Bad Request

403

403 Forbidden

404

404 Not Found (no data)

DELETE /projects/api/v3/tags/{tagId}.json

GET /projects/api/v3/tags/{tagId}.json Get details of an individual tag

Return a specific tag.

operationId: Tags_getTagDetails

Parameters

Name	In	Required	Type	Description
tagId	path	required	integer	—

Responses

200

200 OK

400

400 Bad Request

404

404 Not Found (no data)

GET /projects/api/v3/tags/{tagId}.json

PATCH /projects/api/v3/tags/{tagId}.json Update a single tag

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).

operationId: Tags_updateTag

Parameters

Name	In	Required	Type	Description
tagId	path	required	integer	—

Request Body

application/json

schema tag.Request

Property	Type	Required
tag	object	optional
└ name	string	optional
└ color	string	optional
└ projectId	integer	optional

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

404

404 Not Found (no data)

409

409 Conflict

PATCH /projects/api/v3/tags/{tagId}.json

Taskcomments 1 endpoints

GET /projects/api/v3/tasks/{taskId}/comments.json Get a list of comments for a task

operationId: TaskComments_getList

Parameters

Name	In	Required	Type	Description
updatedAfterDate	query	optional	string	filter by updated after date (deprecated, use updatedAfter)
updatedAfter	query	optional	string	filter by updated after date
searchTerm	query	optional	string	filter by comment content (like v1 filterText param)
publishedStartDate	query	optional	string	filter by published after date
publishedEndDate	query	optional	string	filter by published before date
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
commentStatus	query	optional	string	filter by commment status
taskId	path	required	integer	—
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
strictHTML	query	optional	boolean	use strict html filtering fto content
getReactionsCount	query	optional	boolean	get reactions count
userIds	query	optional	array	filter by user ids
notifiedUserIds	query	optional	array	filter by users who got notified for the comments
include	query	optional	array	include
fields[users]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

404

404 Not Found (no data)

GET /projects/api/v3/tasks/{taskId}/comments.json

Tasklists 8 endpoints

GET /projects/api/v3/projects/{projectId}/tasklists Get tasklists in a project

operationId: TaskLists_getInProject

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	filter by updated after date
searchTerm	query	optional	string	filter by search term
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
projectId	path	required	integer	—
projectBudgetId	query	optional	integer	filter the task list budget by its parent project budget id, if none is provided it weill default to the current active budget.
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
useFormulaFields	query	optional	boolean	use formula fields
sortActiveListsFirst	query	optional	boolean	sort active lists first
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showPrivate	query	optional	boolean	include private items
showDeleted	query	optional	boolean	include deleted items
showCompleted	query	optional	boolean	include completed items
isReportDownload	query	optional	boolean	this means use the tasklist report endpoint, which has totally different query params
includeArchivedProjects	query	optional	boolean	include archived projects
getEmptyLists	query	optional	boolean	include empty lists
completedOnly	query	optional	boolean	include only completed items
projectIds	query	optional	array	filter by project ids
projectCompanyIds	query	optional	array	filter by project company ids
include	query	optional	array	include
ids	query	optional	array	filter by ids
fields[users]	query	optional	array	—
fields[teams]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[lockdowns]	query	optional	array	—
fields[companies]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/{projectId}/tasklists

GET /projects/api/v3/projects/{projectId}/tasklists.csv Generate tasklist report in CSV format

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.

operationId: TaskLists_generateCsvReport

Parameters

Name	In	Required	Type	Description
taskDate	query	optional	string	filter by task date
startDate	query	optional	string	filter by start datetime
reportFormat	query	optional	string	define the format of the report
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
endDate	query	optional	string	filter by end datetime
commentsOrderMode	query	optional	string	order mode of the comments
tasklistId	query	optional	integer	filter by task list
projectId	path	required	integer	—
projectId	query	optional	integer	filter by project
useFormulaFields	query	optional	boolean	use formula fields
onlyCompletedTasks	query	optional	boolean	only completed tasks
isReportDownload	query	optional	boolean	generate a report document
includeTime	query	optional	boolean	include time
includeTags	query	optional	boolean	include tags
includePrivateItems	query	optional	boolean	include private items
includeLateTasks	query	optional	boolean	include late tasks
includeEstimatedTime	query	optional	boolean	include estimated time
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeComments	query	optional	boolean	include comments
includeCommentAvatars	query	optional	boolean	include comment avatars
includeColumns	query	optional	boolean	include columns
includeAnytimeTasks	query	optional	boolean	include anytime tasks
includeAllComments	query	optional	boolean	include all comments
ignoreStartDates	query	optional	boolean	ignore task start dates
groupByTasklists	query	optional	boolean	group by task lists
tags	query	optional	array	filter by tag names
tagIds	query	optional	array	filter by tag ids
assignedToUserIds	query	optional	array	filter by assigned user ids
assignedToTeamIds	query	optional	array	filter by assigned team ids
assignedToCompanyIds	query	optional	array	filter by assigned company ids

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/{projectId}/tasklists.csv

GET /projects/api/v3/projects/{projectId}/tasklists.html Generate tasklist report in HTML format

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.

operationId: TaskLists_generateHtmlReport

Parameters

Name	In	Required	Type	Description
taskDate	query	optional	string	filter by task date
startDate	query	optional	string	filter by start datetime
reportFormat	query	optional	string	define the format of the report
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
endDate	query	optional	string	filter by end datetime
commentsOrderMode	query	optional	string	order mode of the comments
tasklistId	query	optional	integer	filter by task list
projectId	path	required	integer	—
projectId	query	optional	integer	filter by project
useFormulaFields	query	optional	boolean	use formula fields
onlyCompletedTasks	query	optional	boolean	only completed tasks
isReportDownload	query	optional	boolean	generate a report document
includeTime	query	optional	boolean	include time
includeTags	query	optional	boolean	include tags
includePrivateItems	query	optional	boolean	include private items
includeLateTasks	query	optional	boolean	include late tasks
includeEstimatedTime	query	optional	boolean	include estimated time
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeComments	query	optional	boolean	include comments
includeCommentAvatars	query	optional	boolean	include comment avatars
includeColumns	query	optional	boolean	include columns
includeAnytimeTasks	query	optional	boolean	include anytime tasks
includeAllComments	query	optional	boolean	include all comments
ignoreStartDates	query	optional	boolean	ignore task start dates
groupByTasklists	query	optional	boolean	group by task lists
tags	query	optional	array	filter by tag names
tagIds	query	optional	array	filter by tag ids
assignedToUserIds	query	optional	array	filter by assigned user ids
assignedToTeamIds	query	optional	array	filter by assigned team ids
assignedToCompanyIds	query	optional	array	filter by assigned company ids

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/{projectId}/tasklists.html

GET /projects/api/v3/projects/{projectId}/tasklists.pdf Generate tasklist report in PDF format

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.

operationId: TaskLists_generatePdfReport

Parameters

Name	In	Required	Type	Description
taskDate	query	optional	string	filter by task date
startDate	query	optional	string	filter by start datetime
reportFormat	query	optional	string	define the format of the report
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
endDate	query	optional	string	filter by end datetime
commentsOrderMode	query	optional	string	order mode of the comments
tasklistId	query	optional	integer	filter by task list
projectId	path	required	integer	—
projectId	query	optional	integer	filter by project
useFormulaFields	query	optional	boolean	use formula fields
onlyCompletedTasks	query	optional	boolean	only completed tasks
isReportDownload	query	optional	boolean	generate a report document
includeTime	query	optional	boolean	include time
includeTags	query	optional	boolean	include tags
includePrivateItems	query	optional	boolean	include private items
includeLateTasks	query	optional	boolean	include late tasks
includeEstimatedTime	query	optional	boolean	include estimated time
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeComments	query	optional	boolean	include comments
includeCommentAvatars	query	optional	boolean	include comment avatars
includeColumns	query	optional	boolean	include columns
includeAnytimeTasks	query	optional	boolean	include anytime tasks
includeAllComments	query	optional	boolean	include all comments
ignoreStartDates	query	optional	boolean	ignore task start dates
groupByTasklists	query	optional	boolean	group by task lists
tags	query	optional	array	filter by tag names
tagIds	query	optional	array	filter by tag ids
assignedToUserIds	query	optional	array	filter by assigned user ids
assignedToTeamIds	query	optional	array	filter by assigned team ids
assignedToCompanyIds	query	optional	array	filter by assigned company ids

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/{projectId}/tasklists.pdf

GET /projects/api/v3/projects/{projectId}/tasklists.xlsx Generate tasklist report in XLSX format

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.

operationId: TaskLists_generateXlsxReport

Parameters

Name	In	Required	Type	Description
taskDate	query	optional	string	filter by task date
startDate	query	optional	string	filter by start datetime
reportFormat	query	optional	string	define the format of the report
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
endDate	query	optional	string	filter by end datetime
commentsOrderMode	query	optional	string	order mode of the comments
tasklistId	query	optional	integer	filter by task list
projectId	path	required	integer	—
projectId	query	optional	integer	filter by project
useFormulaFields	query	optional	boolean	use formula fields
onlyCompletedTasks	query	optional	boolean	only completed tasks
isReportDownload	query	optional	boolean	generate a report document
includeTime	query	optional	boolean	include time
includeTags	query	optional	boolean	include tags
includePrivateItems	query	optional	boolean	include private items
includeLateTasks	query	optional	boolean	include late tasks
includeEstimatedTime	query	optional	boolean	include estimated time
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeComments	query	optional	boolean	include comments
includeCommentAvatars	query	optional	boolean	include comment avatars
includeColumns	query	optional	boolean	include columns
includeAnytimeTasks	query	optional	boolean	include anytime tasks
includeAllComments	query	optional	boolean	include all comments
ignoreStartDates	query	optional	boolean	ignore task start dates
groupByTasklists	query	optional	boolean	group by task lists
tags	query	optional	array	filter by tag names
tagIds	query	optional	array	filter by tag ids
assignedToUserIds	query	optional	array	filter by assigned user ids
assignedToTeamIds	query	optional	array	filter by assigned team ids
assignedToCompanyIds	query	optional	array	filter by assigned company ids

Responses

200

200 OK (no data)

400

400 Bad Request

403

403 Forbidden

GET /projects/api/v3/projects/{projectId}/tasklists.xlsx

GET /projects/api/v3/tasklists Get all tasklists

operationId: TaskLists_getAll

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	filter by updated after date
searchTerm	query	optional	string	filter by search term
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
projectBudgetId	query	optional	integer	filter the task list budget by its parent project budget id, if none is provided it weill default to the current active budget.
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
useFormulaFields	query	optional	boolean	use formula fields
sortActiveListsFirst	query	optional	boolean	sort active lists first
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showPrivate	query	optional	boolean	include private items
showDeleted	query	optional	boolean	include deleted items
showCompleted	query	optional	boolean	include completed items
isReportDownload	query	optional	boolean	this means use the tasklist report endpoint, which has totally different query params
includeArchivedProjects	query	optional	boolean	include archived projects
getEmptyLists	query	optional	boolean	include empty lists
completedOnly	query	optional	boolean	include only completed items
projectIds	query	optional	array	filter by project ids
projectCompanyIds	query	optional	array	filter by project company ids
include	query	optional	array	include
ids	query	optional	array	filter by ids
fields[users]	query	optional	array	—
fields[teams]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[lockdowns]	query	optional	array	—
fields[companies]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/tasklists

GET /projects/api/v3/tasklists/{tasklistId} Get specific tasklist

operationId: TaskLists_getSpecificTasklist

Parameters

Name	In	Required	Type	Description
updatedAfter	query	optional	string	filter by updated after date
searchTerm	query	optional	string	filter by search term
projectType	query	optional	string	filter by project type
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
tasklistId	path	required	integer	—
projectBudgetId	query	optional	integer	filter the task list budget by its parent project budget id, if none is provided it weill default to the current active budget.
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
useFormulaFields	query	optional	boolean	use formula fields
sortActiveListsFirst	query	optional	boolean	sort active lists first
skipCounts	query	optional	boolean	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
showPrivate	query	optional	boolean	include private items
showDeleted	query	optional	boolean	include deleted items
showCompleted	query	optional	boolean	include completed items
isReportDownload	query	optional	boolean	this means use the tasklist report endpoint, which has totally different query params
includeArchivedProjects	query	optional	boolean	include archived projects
getEmptyLists	query	optional	boolean	include empty lists
completedOnly	query	optional	boolean	include only completed items
projectIds	query	optional	array	filter by project ids
projectCompanyIds	query	optional	array	filter by project company ids
include	query	optional	array	include
ids	query	optional	array	filter by ids
fields[users]	query	optional	array	—
fields[teams]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[lockdowns]	query	optional	array	—
fields[companies]	query	optional	array	—

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/tasklists/{tasklistId}

DELETE /projects/api/v3/tasklists/{tasklistId}.json Delete an existing tasklist.

operationId: Tasklists_deleteTasklist

Parameters

Name	In	Required	Type	Description
tasklistId	path	required	integer	—

Responses

204

204 No Content (no data)

400

400 Bad Request

403

403 Forbidden

404

404 Not Found (no data)

DELETE /projects/api/v3/tasklists/{tasklistId}.json

Tasks 5 endpoints

GET /projects/api/v3/projects/{projectId}/tasks.json Get a specific project's tasks.

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

operationId: Tasks_getSpecificProjectTasksFilteredByCustomFields

Parameters

Name	In	Required	Type	Description
updatedBefore	query	optional	string	filter by updated before date
updatedAfter	query	optional	string	filter by updated after date
today	query	optional	string	filter by today
taskFilter	query	optional	string	filter by a taskFilter
startDate	query	optional	string	filter on start date
searchTerm	query	optional	string	filter by search term
reportType	query	optional	string	define the type of the report
reportFormat	query	optional	string	define the format of the report
priority	query	optional	string	filter by task priority
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
endDate	query	optional	string	filter on end date
dueBefore	query	optional	string	filter before a due date
dueAfter	query	optional	string	filter after a due date
deletedAfter	query	optional	string	filter on deleted after date
createdFilter	query	optional	string	filter by created filter
createdDateCode	query	optional	string	filter by created date code
createdBefore	query	optional	string	filter by created before date
createdAfter	query	optional	string	filter by created after date
completedBefore	query	optional	string	filter by completed before date
completedAfter	query	optional	string	filter by completed after date
updatedByUserId	query	optional	integer	filter by updated user id
projectId	path	required	integer	—
parentTaskId	query	optional	integer	filter by parent task ids
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
includeTaskId	query	optional	integer	include task id
filterId	query	optional	integer	provide a user saved filter ID
completedByUserId	query	optional	integer	filter by completed user id
useTaskDateRange	query	optional	boolean	use daterange logic from table when getting the tasks
useStartDatesForTodaysTasks	query	optional	boolean	use start dates for todays tasks
useFormulaFields	query	optional	boolean	use formula fields
useAllProjects	query	optional	boolean	filter on all projects
sortActiveFirst	query	optional	boolean	sort active tasks first
showDeleted	query	optional	boolean	include deleted items
showCompletedLists	query	optional	boolean	include tasks from completed lists
searchCompaniesTeams	query	optional	boolean	include companies and teams in the search term
searchAssignees	query	optional	boolean	include assignees in the search
onlyUntaggedTasks	query	optional	boolean	only untagged tasks
onlyUnplanned	query	optional	boolean	only return tasks that are unplanned. Not assigned, no due date or missing estimated time.
onlyTasksWithUnreadComments	query	optional	boolean	filter by only tasks with unread comments
onlyTasksWithTickets	query	optional	boolean	filter by only tasks with tickets
onlyTasksWithEstimatedTime	query	optional	boolean	only return tasks with estimated time
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyAdminProjects	query	optional	boolean	only include tasks from projects where the user is strictly a project admin. site admins have visibility to all projects.
nestSubTasks	query	optional	boolean	nest sub tasks
matchAllTags	query	optional	boolean	match all tags
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all exclude tags
isReportDownload	query	optional	boolean	generate a report export.
includeUpdate	query	optional	boolean	include tasks latest update action
includeUntaggedTasks	query	optional	boolean	include untagged tasks
includeTomorrow	query	optional	boolean	filter by include tomorrow
includeToday	query	optional	boolean	filter by include today
includeTeamUserIds	query	optional	boolean	include members of the given teams
includeTasksWithoutDueDates	query	optional	boolean	include tasks without due dates
includeTasksWithCards	query	optional	boolean	include tasks with cards
includeTasksFromDeletedLists	query	optional	boolean	include tasks from deleted lists
includeRelatedTasks	query	optional	boolean	include ids of completed and active subtasks, dependencies, predecessors
includePrivateItems	query	optional	boolean	include private items
includeOverdueTasks	query	optional	boolean	include overdue tasks
includeOriginalDueDate	query	optional	boolean	include original due date of a task
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeCompanyUserIds	query	optional	boolean	include members of the given companies
includeCommentStats	query	optional	boolean	include number of unread and read comments for each task
includeBlocked	query	optional	boolean	filter by include blocked
includeAttachmentCommentStats	query	optional	boolean	include number of unread and read comments for each file attachment
includeAssigneeTeams	query	optional	boolean	include teams related to the responsible user ids
includeAssigneeCompanies	query	optional	boolean	include companies related to the responsible user ids
includeArchivedProjects	query	optional	boolean	include archived projects
includeAllComments	query	optional	boolean	include all comments
groupByTasklist	query	optional	boolean	group by tasklist
groupByTaskgroup	query	optional	boolean	group by taskgroup
getSubTasks	query	optional	boolean	get sub tasks
getFiles	query	optional	boolean	get files
fallbackToMilestoneDueDate	query	optional	boolean	set due date as milestone due date if due date is null and there’s a related milestone
extractTemplateRoleName	query	optional	boolean	For tasks created in a project template it’s possible to assign a role instead of people, companies or teams. This role is then stored with the task name as a prefix. When this flag is enabled it will extract the role name and return it inside a special field.
excludeAssigneeNotOnProjectTeams	query	optional	boolean	exclude assignee not on project teams
completedOnly	query	optional	boolean	only completed tasks
checkForReminders	query	optional	boolean	check if task has reminders
allowAssigneesOutsideProject	query	optional	boolean	when filtering by assigned or unassagned tasks, include assignees that are not in the project.
tasksSelectedColumns	query	optional	array	customise the report by selecting columns to be displayed for tasks report
tasklistIds	query	optional	array	filter by tasklist ids
taskgroupIds	query	optional	array	filter by taskgroup ids
taskIncludedSet	query	optional	array	filter by task included set
tags	query	optional	array	filter by tag values
tagIds	query	optional	array	filter by tag ids
status	query	optional	array	filter by list of task status
skipCRMDealIds	query	optional	array	skip crm deal ids
selectedColumns	query	optional	array	customise the report by selecting columns to be displayed for planned vs actual.
responsiblePartyIds	query	optional	array	filter by responsible party ids
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectFeaturesEnabled	query	optional	array	filter by projects that have features enabled
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include
ids	query	optional	array	filter by task ids
followedByUserIds	query	optional	array	filter by followed by user ids
filterBoardColumnIds	query	optional	array	filter by board column ids
fields[users]	query	optional	array	—
fields[timers]	query	optional	array	—
fields[teams]	query	optional	array	—
fields[tasks]	query	optional	array	—
fields[tasklists]	query	optional	array	—
fields[taskgroups]	query	optional	array	—
fields[taskSequences]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[lockdowns]	query	optional	array	—
fields[files]	query	optional	array	—
fields[companies]	query	optional	array	—
fields[comments]	query	optional	array	—
fields[columns]	query	optional	array	—
fields[cards]	query	optional	array	—
fields[ProjectPermissions]	query	optional	array	—
expandedIds	query	optional	array	the ids of the expanded tasks
excludeTagIds	query	optional	array	filter by excluded tag ids
crmDealIds	query	optional	array	filter by crm deal ids
createdByUserIds	query	optional	array	filter by creator user ids
assigneeTeamIds	query	optional	array	filter by assignee team ids
assigneeCompanyIds	query	optional	array	filter by assignee company ids
CustomFields	query	optional	array	filter by custom fields

Responses

200

200 OK

400

400 Bad Request

GET /projects/api/v3/projects/{projectId}/tasks.json

GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.csv Generate plannedvsactual report in CSV format

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.

operationId: Tasks_generatePlannedVsActualReportCsv

Parameters

Name	In	Required	Type	Description
updatedBefore	query	optional	string	filter by updated before date
updatedAfter	query	optional	string	filter by updated after date
today	query	optional	string	filter by today
taskFilter	query	optional	string	filter by a taskFilter
startDate	query	optional	string	filter on start date
searchTerm	query	optional	string	filter by search term
reportType	query	optional	string	define the type of the report
reportFormat	query	optional	string	define the format of the report
priority	query	optional	string	filter by task priority
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
endDate	query	optional	string	filter on end date
dueBefore	query	optional	string	filter before a due date
dueAfter	query	optional	string	filter after a due date
deletedAfter	query	optional	string	filter on deleted after date
createdFilter	query	optional	string	filter by created filter
createdDateCode	query	optional	string	filter by created date code
createdBefore	query	optional	string	filter by created before date
createdAfter	query	optional	string	filter by created after date
completedBefore	query	optional	string	filter by completed before date
completedAfter	query	optional	string	filter by completed after date
updatedByUserId	query	optional	integer	filter by updated user id
parentTaskId	query	optional	integer	filter by parent task ids
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
includeTaskId	query	optional	integer	include task id
filterId	query	optional	integer	provide a user saved filter ID
completedByUserId	query	optional	integer	filter by completed user id
useTaskDateRange	query	optional	boolean	use daterange logic from table when getting the tasks
useStartDatesForTodaysTasks	query	optional	boolean	use start dates for todays tasks
useFormulaFields	query	optional	boolean	use formula fields
useAllProjects	query	optional	boolean	filter on all projects
sortActiveFirst	query	optional	boolean	sort active tasks first
showDeleted	query	optional	boolean	include deleted items
showCompletedLists	query	optional	boolean	include tasks from completed lists
searchCompaniesTeams	query	optional	boolean	include companies and teams in the search term
searchAssignees	query	optional	boolean	include assignees in the search
onlyUntaggedTasks	query	optional	boolean	only untagged tasks
onlyUnplanned	query	optional	boolean	only return tasks that are unplanned. Not assigned, no due date or missing estimated time.
onlyTasksWithUnreadComments	query	optional	boolean	filter by only tasks with unread comments
onlyTasksWithTickets	query	optional	boolean	filter by only tasks with tickets
onlyTasksWithEstimatedTime	query	optional	boolean	only return tasks with estimated time
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyAdminProjects	query	optional	boolean	only include tasks from projects where the user is strictly a project admin. site admins have visibility to all projects.
nestSubTasks	query	optional	boolean	nest sub tasks
matchAllTags	query	optional	boolean	match all tags
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all exclude tags
isReportDownload	query	optional	boolean	generate a report export.
includeUpdate	query	optional	boolean	include tasks latest update action
includeUntaggedTasks	query	optional	boolean	include untagged tasks
includeTomorrow	query	optional	boolean	filter by include tomorrow
includeToday	query	optional	boolean	filter by include today
includeTeamUserIds	query	optional	boolean	include members of the given teams
includeTasksWithoutDueDates	query	optional	boolean	include tasks without due dates
includeTasksWithCards	query	optional	boolean	include tasks with cards
includeTasksFromDeletedLists	query	optional	boolean	include tasks from deleted lists
includeRelatedTasks	query	optional	boolean	include ids of completed and active subtasks, dependencies, predecessors
includePrivateItems	query	optional	boolean	include private items
includeOverdueTasks	query	optional	boolean	include overdue tasks
includeOriginalDueDate	query	optional	boolean	include original due date of a task
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeCompanyUserIds	query	optional	boolean	include members of the given companies
includeCommentStats	query	optional	boolean	include number of unread and read comments for each task
includeBlocked	query	optional	boolean	filter by include blocked
includeAttachmentCommentStats	query	optional	boolean	include number of unread and read comments for each file attachment
includeAssigneeTeams	query	optional	boolean	include teams related to the responsible user ids
includeAssigneeCompanies	query	optional	boolean	include companies related to the responsible user ids
includeArchivedProjects	query	optional	boolean	include archived projects
includeAllComments	query	optional	boolean	include all comments
groupByTasklist	query	optional	boolean	group by tasklist
groupByTaskgroup	query	optional	boolean	group by taskgroup
getSubTasks	query	optional	boolean	get sub tasks
getFiles	query	optional	boolean	get files
fallbackToMilestoneDueDate	query	optional	boolean	set due date as milestone due date if due date is null and there’s a related milestone
extractTemplateRoleName	query	optional	boolean	For tasks created in a project template it’s possible to assign a role instead of people, companies or teams. This role is then stored with the task name as a prefix. When this flag is enabled it will extract the role name and return it inside a special field.
excludeAssigneeNotOnProjectTeams	query	optional	boolean	exclude assignee not on project teams
completedOnly	query	optional	boolean	only completed tasks
checkForReminders	query	optional	boolean	check if task has reminders
allowAssigneesOutsideProject	query	optional	boolean	when filtering by assigned or unassagned tasks, include assignees that are not in the project.
tasksSelectedColumns	query	optional	array	customise the report by selecting columns to be displayed for tasks report
tasklistIds	query	optional	array	filter by tasklist ids
taskgroupIds	query	optional	array	filter by taskgroup ids
taskIncludedSet	query	optional	array	filter by task included set
tags	query	optional	array	filter by tag values
tagIds	query	optional	array	filter by tag ids
status	query	optional	array	filter by list of task status
skipCRMDealIds	query	optional	array	skip crm deal ids
selectedColumns	query	optional	array	customise the report by selecting columns to be displayed for planned vs actual.
responsiblePartyIds	query	optional	array	filter by responsible party ids
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectFeaturesEnabled	query	optional	array	filter by projects that have features enabled
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include
ids	query	optional	array	filter by task ids
followedByUserIds	query	optional	array	filter by followed by user ids
filterBoardColumnIds	query	optional	array	filter by board column ids
fields[users]	query	optional	array	—
fields[timers]	query	optional	array	—
fields[teams]	query	optional	array	—
fields[tasks]	query	optional	array	—
fields[tasklists]	query	optional	array	—
fields[taskgroups]	query	optional	array	—
fields[taskSequences]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[lockdowns]	query	optional	array	—
fields[files]	query	optional	array	—
fields[companies]	query	optional	array	—
fields[comments]	query	optional	array	—
fields[columns]	query	optional	array	—
fields[cards]	query	optional	array	—
fields[ProjectPermissions]	query	optional	array	—
expandedIds	query	optional	array	the ids of the expanded tasks
excludeTagIds	query	optional	array	filter by excluded tag ids
crmDealIds	query	optional	array	filter by crm deal ids
createdByUserIds	query	optional	array	filter by creator user ids
assigneeTeamIds	query	optional	array	filter by assignee team ids
assigneeCompanyIds	query	optional	array	filter by assignee company ids
CustomFields	query	optional	array	filter by custom fields

Responses

200

200 OK (no data)

400

400 Bad Request

GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.csv

GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.html Generate plannedvsactual report in HTML format

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.

operationId: Tasks_generatePlannedVsActualReportHtml

Parameters

Name	In	Required	Type	Description
updatedBefore	query	optional	string	filter by updated before date
updatedAfter	query	optional	string	filter by updated after date
today	query	optional	string	filter by today
taskFilter	query	optional	string	filter by a taskFilter
startDate	query	optional	string	filter on start date
searchTerm	query	optional	string	filter by search term
reportType	query	optional	string	define the type of the report
reportFormat	query	optional	string	define the format of the report
priority	query	optional	string	filter by task priority
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
endDate	query	optional	string	filter on end date
dueBefore	query	optional	string	filter before a due date
dueAfter	query	optional	string	filter after a due date
deletedAfter	query	optional	string	filter on deleted after date
createdFilter	query	optional	string	filter by created filter
createdDateCode	query	optional	string	filter by created date code
createdBefore	query	optional	string	filter by created before date
createdAfter	query	optional	string	filter by created after date
completedBefore	query	optional	string	filter by completed before date
completedAfter	query	optional	string	filter by completed after date
updatedByUserId	query	optional	integer	filter by updated user id
parentTaskId	query	optional	integer	filter by parent task ids
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
includeTaskId	query	optional	integer	include task id
filterId	query	optional	integer	provide a user saved filter ID
completedByUserId	query	optional	integer	filter by completed user id
useTaskDateRange	query	optional	boolean	use daterange logic from table when getting the tasks
useStartDatesForTodaysTasks	query	optional	boolean	use start dates for todays tasks
useFormulaFields	query	optional	boolean	use formula fields
useAllProjects	query	optional	boolean	filter on all projects
sortActiveFirst	query	optional	boolean	sort active tasks first
showDeleted	query	optional	boolean	include deleted items
showCompletedLists	query	optional	boolean	include tasks from completed lists
searchCompaniesTeams	query	optional	boolean	include companies and teams in the search term
searchAssignees	query	optional	boolean	include assignees in the search
onlyUntaggedTasks	query	optional	boolean	only untagged tasks
onlyUnplanned	query	optional	boolean	only return tasks that are unplanned. Not assigned, no due date or missing estimated time.
onlyTasksWithUnreadComments	query	optional	boolean	filter by only tasks with unread comments
onlyTasksWithTickets	query	optional	boolean	filter by only tasks with tickets
onlyTasksWithEstimatedTime	query	optional	boolean	only return tasks with estimated time
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyAdminProjects	query	optional	boolean	only include tasks from projects where the user is strictly a project admin. site admins have visibility to all projects.
nestSubTasks	query	optional	boolean	nest sub tasks
matchAllTags	query	optional	boolean	match all tags
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all exclude tags
isReportDownload	query	optional	boolean	generate a report export.
includeUpdate	query	optional	boolean	include tasks latest update action
includeUntaggedTasks	query	optional	boolean	include untagged tasks
includeTomorrow	query	optional	boolean	filter by include tomorrow
includeToday	query	optional	boolean	filter by include today
includeTeamUserIds	query	optional	boolean	include members of the given teams
includeTasksWithoutDueDates	query	optional	boolean	include tasks without due dates
includeTasksWithCards	query	optional	boolean	include tasks with cards
includeTasksFromDeletedLists	query	optional	boolean	include tasks from deleted lists
includeRelatedTasks	query	optional	boolean	include ids of completed and active subtasks, dependencies, predecessors
includePrivateItems	query	optional	boolean	include private items
includeOverdueTasks	query	optional	boolean	include overdue tasks
includeOriginalDueDate	query	optional	boolean	include original due date of a task
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeCompanyUserIds	query	optional	boolean	include members of the given companies
includeCommentStats	query	optional	boolean	include number of unread and read comments for each task
includeBlocked	query	optional	boolean	filter by include blocked
includeAttachmentCommentStats	query	optional	boolean	include number of unread and read comments for each file attachment
includeAssigneeTeams	query	optional	boolean	include teams related to the responsible user ids
includeAssigneeCompanies	query	optional	boolean	include companies related to the responsible user ids
includeArchivedProjects	query	optional	boolean	include archived projects
includeAllComments	query	optional	boolean	include all comments
groupByTasklist	query	optional	boolean	group by tasklist
groupByTaskgroup	query	optional	boolean	group by taskgroup
getSubTasks	query	optional	boolean	get sub tasks
getFiles	query	optional	boolean	get files
fallbackToMilestoneDueDate	query	optional	boolean	set due date as milestone due date if due date is null and there’s a related milestone
extractTemplateRoleName	query	optional	boolean	For tasks created in a project template it’s possible to assign a role instead of people, companies or teams. This role is then stored with the task name as a prefix. When this flag is enabled it will extract the role name and return it inside a special field.
excludeAssigneeNotOnProjectTeams	query	optional	boolean	exclude assignee not on project teams
completedOnly	query	optional	boolean	only completed tasks
checkForReminders	query	optional	boolean	check if task has reminders
allowAssigneesOutsideProject	query	optional	boolean	when filtering by assigned or unassagned tasks, include assignees that are not in the project.
tasksSelectedColumns	query	optional	array	customise the report by selecting columns to be displayed for tasks report
tasklistIds	query	optional	array	filter by tasklist ids
taskgroupIds	query	optional	array	filter by taskgroup ids
taskIncludedSet	query	optional	array	filter by task included set
tags	query	optional	array	filter by tag values
tagIds	query	optional	array	filter by tag ids
status	query	optional	array	filter by list of task status
skipCRMDealIds	query	optional	array	skip crm deal ids
selectedColumns	query	optional	array	customise the report by selecting columns to be displayed for planned vs actual.
responsiblePartyIds	query	optional	array	filter by responsible party ids
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectFeaturesEnabled	query	optional	array	filter by projects that have features enabled
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include
ids	query	optional	array	filter by task ids
followedByUserIds	query	optional	array	filter by followed by user ids
filterBoardColumnIds	query	optional	array	filter by board column ids
fields[users]	query	optional	array	—
fields[timers]	query	optional	array	—
fields[teams]	query	optional	array	—
fields[tasks]	query	optional	array	—
fields[tasklists]	query	optional	array	—
fields[taskgroups]	query	optional	array	—
fields[taskSequences]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[lockdowns]	query	optional	array	—
fields[files]	query	optional	array	—
fields[companies]	query	optional	array	—
fields[comments]	query	optional	array	—
fields[columns]	query	optional	array	—
fields[cards]	query	optional	array	—
fields[ProjectPermissions]	query	optional	array	—
expandedIds	query	optional	array	the ids of the expanded tasks
excludeTagIds	query	optional	array	filter by excluded tag ids
crmDealIds	query	optional	array	filter by crm deal ids
createdByUserIds	query	optional	array	filter by creator user ids
assigneeTeamIds	query	optional	array	filter by assignee team ids
assigneeCompanyIds	query	optional	array	filter by assignee company ids
CustomFields	query	optional	array	filter by custom fields

Responses

200

200 OK (no data)

400

400 Bad Request

GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.html

GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.pdf Generate plannedvsactual report in PDF format

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.

operationId: Tasks_generatePlannedVsActualPdf

Parameters

Name	In	Required	Type	Description
updatedBefore	query	optional	string	filter by updated before date
updatedAfter	query	optional	string	filter by updated after date
today	query	optional	string	filter by today
taskFilter	query	optional	string	filter by a taskFilter
startDate	query	optional	string	filter on start date
searchTerm	query	optional	string	filter by search term
reportType	query	optional	string	define the type of the report
reportFormat	query	optional	string	define the format of the report
priority	query	optional	string	filter by task priority
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
endDate	query	optional	string	filter on end date
dueBefore	query	optional	string	filter before a due date
dueAfter	query	optional	string	filter after a due date
deletedAfter	query	optional	string	filter on deleted after date
createdFilter	query	optional	string	filter by created filter
createdDateCode	query	optional	string	filter by created date code
createdBefore	query	optional	string	filter by created before date
createdAfter	query	optional	string	filter by created after date
completedBefore	query	optional	string	filter by completed before date
completedAfter	query	optional	string	filter by completed after date
updatedByUserId	query	optional	integer	filter by updated user id
parentTaskId	query	optional	integer	filter by parent task ids
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
includeTaskId	query	optional	integer	include task id
filterId	query	optional	integer	provide a user saved filter ID
completedByUserId	query	optional	integer	filter by completed user id
useTaskDateRange	query	optional	boolean	use daterange logic from table when getting the tasks
useStartDatesForTodaysTasks	query	optional	boolean	use start dates for todays tasks
useFormulaFields	query	optional	boolean	use formula fields
useAllProjects	query	optional	boolean	filter on all projects
sortActiveFirst	query	optional	boolean	sort active tasks first
showDeleted	query	optional	boolean	include deleted items
showCompletedLists	query	optional	boolean	include tasks from completed lists
searchCompaniesTeams	query	optional	boolean	include companies and teams in the search term
searchAssignees	query	optional	boolean	include assignees in the search
onlyUntaggedTasks	query	optional	boolean	only untagged tasks
onlyUnplanned	query	optional	boolean	only return tasks that are unplanned. Not assigned, no due date or missing estimated time.
onlyTasksWithUnreadComments	query	optional	boolean	filter by only tasks with unread comments
onlyTasksWithTickets	query	optional	boolean	filter by only tasks with tickets
onlyTasksWithEstimatedTime	query	optional	boolean	only return tasks with estimated time
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyAdminProjects	query	optional	boolean	only include tasks from projects where the user is strictly a project admin. site admins have visibility to all projects.
nestSubTasks	query	optional	boolean	nest sub tasks
matchAllTags	query	optional	boolean	match all tags
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all exclude tags
isReportDownload	query	optional	boolean	generate a report export.
includeUpdate	query	optional	boolean	include tasks latest update action
includeUntaggedTasks	query	optional	boolean	include untagged tasks
includeTomorrow	query	optional	boolean	filter by include tomorrow
includeToday	query	optional	boolean	filter by include today
includeTeamUserIds	query	optional	boolean	include members of the given teams
includeTasksWithoutDueDates	query	optional	boolean	include tasks without due dates
includeTasksWithCards	query	optional	boolean	include tasks with cards
includeTasksFromDeletedLists	query	optional	boolean	include tasks from deleted lists
includeRelatedTasks	query	optional	boolean	include ids of completed and active subtasks, dependencies, predecessors
includePrivateItems	query	optional	boolean	include private items
includeOverdueTasks	query	optional	boolean	include overdue tasks
includeOriginalDueDate	query	optional	boolean	include original due date of a task
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeCompanyUserIds	query	optional	boolean	include members of the given companies
includeCommentStats	query	optional	boolean	include number of unread and read comments for each task
includeBlocked	query	optional	boolean	filter by include blocked
includeAttachmentCommentStats	query	optional	boolean	include number of unread and read comments for each file attachment
includeAssigneeTeams	query	optional	boolean	include teams related to the responsible user ids
includeAssigneeCompanies	query	optional	boolean	include companies related to the responsible user ids
includeArchivedProjects	query	optional	boolean	include archived projects
includeAllComments	query	optional	boolean	include all comments
groupByTasklist	query	optional	boolean	group by tasklist
groupByTaskgroup	query	optional	boolean	group by taskgroup
getSubTasks	query	optional	boolean	get sub tasks
getFiles	query	optional	boolean	get files
fallbackToMilestoneDueDate	query	optional	boolean	set due date as milestone due date if due date is null and there’s a related milestone
extractTemplateRoleName	query	optional	boolean	For tasks created in a project template it’s possible to assign a role instead of people, companies or teams. This role is then stored with the task name as a prefix. When this flag is enabled it will extract the role name and return it inside a special field.
excludeAssigneeNotOnProjectTeams	query	optional	boolean	exclude assignee not on project teams
completedOnly	query	optional	boolean	only completed tasks
checkForReminders	query	optional	boolean	check if task has reminders
allowAssigneesOutsideProject	query	optional	boolean	when filtering by assigned or unassagned tasks, include assignees that are not in the project.
tasksSelectedColumns	query	optional	array	customise the report by selecting columns to be displayed for tasks report
tasklistIds	query	optional	array	filter by tasklist ids
taskgroupIds	query	optional	array	filter by taskgroup ids
taskIncludedSet	query	optional	array	filter by task included set
tags	query	optional	array	filter by tag values
tagIds	query	optional	array	filter by tag ids
status	query	optional	array	filter by list of task status
skipCRMDealIds	query	optional	array	skip crm deal ids
selectedColumns	query	optional	array	customise the report by selecting columns to be displayed for planned vs actual.
responsiblePartyIds	query	optional	array	filter by responsible party ids
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectFeaturesEnabled	query	optional	array	filter by projects that have features enabled
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include
ids	query	optional	array	filter by task ids
followedByUserIds	query	optional	array	filter by followed by user ids
filterBoardColumnIds	query	optional	array	filter by board column ids
fields[users]	query	optional	array	—
fields[timers]	query	optional	array	—
fields[teams]	query	optional	array	—
fields[tasks]	query	optional	array	—
fields[tasklists]	query	optional	array	—
fields[taskgroups]	query	optional	array	—
fields[taskSequences]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[lockdowns]	query	optional	array	—
fields[files]	query	optional	array	—
fields[companies]	query	optional	array	—
fields[comments]	query	optional	array	—
fields[columns]	query	optional	array	—
fields[cards]	query	optional	array	—
fields[ProjectPermissions]	query	optional	array	—
expandedIds	query	optional	array	the ids of the expanded tasks
excludeTagIds	query	optional	array	filter by excluded tag ids
crmDealIds	query	optional	array	filter by crm deal ids
createdByUserIds	query	optional	array	filter by creator user ids
assigneeTeamIds	query	optional	array	filter by assignee team ids
assigneeCompanyIds	query	optional	array	filter by assignee company ids
CustomFields	query	optional	array	filter by custom fields

Responses

200

200 OK (no data)

400

400 Bad Request

GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.pdf

GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.xlsx Generate plannedvsactual report in XLSX format

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.

operationId: Tasks_generatePlannedVsActualXlsx

Parameters

Name	In	Required	Type	Description
updatedBefore	query	optional	string	filter by updated before date
updatedAfter	query	optional	string	filter by updated after date
today	query	optional	string	filter by today
taskFilter	query	optional	string	filter by a taskFilter
startDate	query	optional	string	filter on start date
searchTerm	query	optional	string	filter by search term
reportType	query	optional	string	define the type of the report
reportFormat	query	optional	string	define the format of the report
priority	query	optional	string	filter by task priority
orderMode	query	optional	string	order mode
orderBy	query	optional	string	order by
notCompletedBefore	query	optional	string	filter by projects that have not been completed before the given date
endDate	query	optional	string	filter on end date
dueBefore	query	optional	string	filter before a due date
dueAfter	query	optional	string	filter after a due date
deletedAfter	query	optional	string	filter on deleted after date
createdFilter	query	optional	string	filter by created filter
createdDateCode	query	optional	string	filter by created date code
createdBefore	query	optional	string	filter by created before date
createdAfter	query	optional	string	filter by created after date
completedBefore	query	optional	string	filter by completed before date
completedAfter	query	optional	string	filter by completed after date
updatedByUserId	query	optional	integer	filter by updated user id
parentTaskId	query	optional	integer	filter by parent task ids
pageSize	query	optional	integer	number of items in a page
page	query	optional	integer	page number
orderByCustomFieldId	query	optional	integer	order by custom field id when orderBy is equal to customfield
includeTaskId	query	optional	integer	include task id
filterId	query	optional	integer	provide a user saved filter ID
completedByUserId	query	optional	integer	filter by completed user id
useTaskDateRange	query	optional	boolean	use daterange logic from table when getting the tasks
useStartDatesForTodaysTasks	query	optional	boolean	use start dates for todays tasks
useFormulaFields	query	optional	boolean	use formula fields
useAllProjects	query	optional	boolean	filter on all projects
sortActiveFirst	query	optional	boolean	sort active tasks first
showDeleted	query	optional	boolean	include deleted items
showCompletedLists	query	optional	boolean	include tasks from completed lists
searchCompaniesTeams	query	optional	boolean	include companies and teams in the search term
searchAssignees	query	optional	boolean	include assignees in the search
onlyUntaggedTasks	query	optional	boolean	only untagged tasks
onlyUnplanned	query	optional	boolean	only return tasks that are unplanned. Not assigned, no due date or missing estimated time.
onlyTasksWithUnreadComments	query	optional	boolean	filter by only tasks with unread comments
onlyTasksWithTickets	query	optional	boolean	filter by only tasks with tickets
onlyTasksWithEstimatedTime	query	optional	boolean	only return tasks with estimated time
onlyStarredProjects	query	optional	boolean	filter by starred projects only
onlyAdminProjects	query	optional	boolean	only include tasks from projects where the user is strictly a project admin. site admins have visibility to all projects.
nestSubTasks	query	optional	boolean	nest sub tasks
matchAllTags	query	optional	boolean	match all tags
matchAllProjectTags	query	optional	boolean	match all project tags
matchAllExcludedTags	query	optional	boolean	match all exclude tags
isReportDownload	query	optional	boolean	generate a report export.
includeUpdate	query	optional	boolean	include tasks latest update action
includeUntaggedTasks	query	optional	boolean	include untagged tasks
includeTomorrow	query	optional	boolean	filter by include tomorrow
includeToday	query	optional	boolean	filter by include today
includeTeamUserIds	query	optional	boolean	include members of the given teams
includeTasksWithoutDueDates	query	optional	boolean	include tasks without due dates
includeTasksWithCards	query	optional	boolean	include tasks with cards
includeTasksFromDeletedLists	query	optional	boolean	include tasks from deleted lists
includeRelatedTasks	query	optional	boolean	include ids of completed and active subtasks, dependencies, predecessors
includePrivateItems	query	optional	boolean	include private items
includeOverdueTasks	query	optional	boolean	include overdue tasks
includeOriginalDueDate	query	optional	boolean	include original due date of a task
includeCustomFields	query	optional	boolean	include custom fields
includeCompletedTasks	query	optional	boolean	include completed tasks
includeCompanyUserIds	query	optional	boolean	include members of the given companies
includeCommentStats	query	optional	boolean	include number of unread and read comments for each task
includeBlocked	query	optional	boolean	filter by include blocked
includeAttachmentCommentStats	query	optional	boolean	include number of unread and read comments for each file attachment
includeAssigneeTeams	query	optional	boolean	include teams related to the responsible user ids
includeAssigneeCompanies	query	optional	boolean	include companies related to the responsible user ids
includeArchivedProjects	query	optional	boolean	include archived projects
includeAllComments	query	optional	boolean	include all comments
groupByTasklist	query	optional	boolean	group by tasklist
groupByTaskgroup	query	optional	boolean	group by taskgroup
getSubTasks	query	optional	boolean	get sub tasks
getFiles	query	optional	boolean	get files
fallbackToMilestoneDueDate	query	optional	boolean	set due date as milestone due date if due date is null and there’s a related milestone
extractTemplateRoleName	query	optional	boolean	For tasks created in a project template it’s possible to assign a role instead of people, companies or teams. This role is then stored with the task name as a prefix. When this flag is enabled it will extract the role name and return it inside a special field.
excludeAssigneeNotOnProjectTeams	query	optional	boolean	exclude assignee not on project teams
completedOnly	query	optional	boolean	only completed tasks
checkForReminders	query	optional	boolean	check if task has reminders
allowAssigneesOutsideProject	query	optional	boolean	when filtering by assigned or unassagned tasks, include assignees that are not in the project.
tasksSelectedColumns	query	optional	array	customise the report by selecting columns to be displayed for tasks report
tasklistIds	query	optional	array	filter by tasklist ids
taskgroupIds	query	optional	array	filter by taskgroup ids
taskIncludedSet	query	optional	array	filter by task included set
tags	query	optional	array	filter by tag values
tagIds	query	optional	array	filter by tag ids
status	query	optional	array	filter by list of task status
skipCRMDealIds	query	optional	array	skip crm deal ids
selectedColumns	query	optional	array	customise the report by selecting columns to be displayed for planned vs actual.
responsiblePartyIds	query	optional	array	filter by responsible party ids
projectTagIds	query	optional	array	filter by project tag ids
projectStatuses	query	optional	array	filter by project status
projectOwnerIds	query	optional	array	filter by project owner ids
projectIds	query	optional	array	filter by project ids
projectHealths	query	optional	array	filter by project healths 0: not set 1: bad 2: ok 3: good
projectFeaturesEnabled	query	optional	array	filter by projects that have features enabled
projectCompanyIds	query	optional	array	filter by company ids
projectCategoryIds	query	optional	array	filter by project category ids
includeCustomFieldIds	query	optional	array	include specific custom fields
include	query	optional	array	include
ids	query	optional	array	filter by task ids
followedByUserIds	query	optional	array	filter by followed by user ids
filterBoardColumnIds	query	optional	array	filter by board column ids
fields[users]	query	optional	array	—
fields[timers]	query	optional	array	—
fields[teams]	query	optional	array	—
fields[tasks]	query	optional	array	—
fields[tasklists]	query	optional	array	—
fields[taskgroups]	query	optional	array	—
fields[taskSequences]	query	optional	array	—
fields[tags]	query	optional	array	—
fields[projects]	query	optional	array	—
fields[milestones]	query	optional	array	—
fields[lockdowns]	query	optional	array	—
fields[files]	query	optional	array	—
fields[companies]	query	optional	array	—
fields[comments]	query	optional	array	—
fields[columns]	query	optional	array	—
fields[cards]	query	optional	array	—
fields[ProjectPermissions]	query	optional	array	—
expandedIds	query	optional	array	the ids of the expanded tasks
excludeTagIds	query	optional	array	filter by excluded tag ids
crmDealIds	query	optional	array	filter by crm deal ids
createdByUserIds	query	optional	array	filter by creator user ids
assigneeTeamIds	query	optional	array	filter by assignee team ids
assigneeCompanyIds	query	optional	array	filter by assignee company ids
CustomFields	query	optional	array	filter by custom fields

Responses

200

200 OK (no data)

400

400 Bad Request

GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.xlsx

Load more endpoints