Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://{site_name}.teamwork.com
/projects/api/v3/latestactivity.json
Lists the latest activity across all projects ordered chronologically. When
you log into Teamwork you will see all the recent activity. This corresponds
to that view in Teamwork. There are parameters you can send in to filter your
results.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| startDate | query | optional | string | filter by start datetime |
| sort | query | optional | string | sort by (deprecated, use orderBy) |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | sort by |
| endDate | query | optional | string | filter by end datetime |
| projectId | query | optional | integer | filter by project id (deprecated, use projectIds) |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| maxId | query | optional | integer | activity id offset |
| catchupFromId | query | optional | integer | limit results from previous id |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyProjectsWithExplicitMembership | query | optional | boolean | only projects with explicit membership |
| matchAllProjectTags | query | optional | boolean | enforce all tag ids must be matched |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| groupCommentActivityType | query | optional | boolean | group all activities on comments |
| userIds | query | optional | array | filter by user ids |
| 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 |
| 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 |
| fields[users] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| fields[activities] | query | optional | array | — |
| activityTypes | query | optional | array | filter by activity types |
200 OK
400 Bad Request
GET /projects/api/v3/latestactivity.json
/projects/api/v3/projects/{projectId}/latestactivity
Lists the latest activity for a specific project. When you access a project
you will see all the recent activity. This corresponds to that view in
Teamwork. There is some parameters you can send in to filter your results.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| startDate | query | optional | string | filter by start datetime |
| sort | query | optional | string | sort by (deprecated, use orderBy) |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | sort by |
| endDate | query | optional | string | filter by end datetime |
| projectId | path | required | integer | — |
| projectId | query | optional | integer | filter by project id (deprecated, use projectIds) |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| maxId | query | optional | integer | activity id offset |
| catchupFromId | query | optional | integer | limit results from previous id |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyProjectsWithExplicitMembership | query | optional | boolean | only projects with explicit membership |
| matchAllProjectTags | query | optional | boolean | enforce all tag ids must be matched |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| groupCommentActivityType | query | optional | boolean | group all activities on comments |
| userIds | query | optional | array | filter by user ids |
| 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 |
| 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 |
| fields[users] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| fields[activities] | query | optional | array | — |
| activityTypes | query | optional | array | filter by activity types |
200 OK
400 Bad Request
GET /projects/api/v3/projects/{projectId}/latestactivity
/projects/api/v3/projects/budgets/:id/tasklists/budgets.json
Get a list of tasklist budgets information.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| projectBudgetId | query | optional | integer | parent project budget id |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| include | query | optional | array | include |
| fields[tasklists] | query | optional | array | — |
| fields[tasklistBudgetNotifications] | query | optional | array | — |
| fields[projectBudgets] | query | optional | array | — |
200 OK
400 Bad Request
GET /projects/api/v3/projects/budgets/:id/tasklists/budgets.json
/projects/api/v3/calendar/events.csv
Generates an agenda report in CSV format containing all the events for the
provided filters.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| startDate | query | optional | string | events that happen after this date |
| reportFormat | query | optional | string | define the format of the report |
| endDate | query | optional | string | events that happen before this date |
| withTasks | query | optional | boolean | include tasks |
| withMilestones | query | optional | boolean | include milestones |
| withEvents | query | optional | boolean | include events |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTags | query | optional | boolean | should include tags |
| attendingOnly | query | optional | boolean | when filtering events with targetUserIDs, display only when attending the event |
| typeIDs | query | optional | array | filter calendar events to show only the ones in typeIDs |
| targetUserIDs | query | optional | array | filter to show only events for the provided user |
| targetProjectIDs | query | optional | array | filter to show only events for the provided projects |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/calendar/events.csv
/projects/api/v3/calendar/events.html
Generates an agenda report in HTML format containing all the events for the
provided filters.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| startDate | query | optional | string | events that happen after this date |
| reportFormat | query | optional | string | define the format of the report |
| endDate | query | optional | string | events that happen before this date |
| withTasks | query | optional | boolean | include tasks |
| withMilestones | query | optional | boolean | include milestones |
| withEvents | query | optional | boolean | include events |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTags | query | optional | boolean | should include tags |
| attendingOnly | query | optional | boolean | when filtering events with targetUserIDs, display only when attending the event |
| typeIDs | query | optional | array | filter calendar events to show only the ones in typeIDs |
| targetUserIDs | query | optional | array | filter to show only events for the provided user |
| targetProjectIDs | query | optional | array | filter to show only events for the provided projects |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/calendar/events.html
/projects/api/v3/calendar/events.pdf
Generates an agenda report in PDF format containing all the events for the
provided filters.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| startDate | query | optional | string | events that happen after this date |
| reportFormat | query | optional | string | define the format of the report |
| endDate | query | optional | string | events that happen before this date |
| withTasks | query | optional | boolean | include tasks |
| withMilestones | query | optional | boolean | include milestones |
| withEvents | query | optional | boolean | include events |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTags | query | optional | boolean | should include tags |
| attendingOnly | query | optional | boolean | when filtering events with targetUserIDs, display only when attending the event |
| typeIDs | query | optional | array | filter calendar events to show only the ones in typeIDs |
| targetUserIDs | query | optional | array | filter to show only events for the provided user |
| targetProjectIDs | query | optional | array | filter to show only events for the provided projects |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/calendar/events.pdf
/projects/api/v3/calendar/events.xlsx
Generates an agenda report in XLSX format containing all the events for the
provided filters.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| startDate | query | optional | string | events that happen after this date |
| reportFormat | query | optional | string | define the format of the report |
| endDate | query | optional | string | events that happen before this date |
| withTasks | query | optional | boolean | include tasks |
| withMilestones | query | optional | boolean | include milestones |
| withEvents | query | optional | boolean | include events |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTags | query | optional | boolean | should include tags |
| attendingOnly | query | optional | boolean | when filtering events with targetUserIDs, display only when attending the event |
| typeIDs | query | optional | array | filter calendar events to show only the ones in typeIDs |
| targetUserIDs | query | optional | array | filter to show only events for the provided user |
| targetProjectIDs | query | optional | array | filter to show only events for the provided projects |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/calendar/events.xlsx
/projects/api/v3/projectcategories.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| searchTerm | query | optional | string | filter by name |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only. |
| projectStatuses | query | optional | array | filter by project statuses. |
| ids | query | optional | array | filter by specific ids |
| fields[projectcategories] | query | optional | array | — |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projectcategories.json
/projects/api/v3/projectcategories/{categoryId}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| searchTerm | query | optional | string | filter by name |
| categoryId | path | required | integer | — |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only. |
| projectStatuses | query | optional | array | filter by project statuses. |
| ids | query | optional | array | filter by specific ids |
| fields[projectcategories] | query | optional | array | — |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projectcategories/{categoryId}.json
/projects/api/v3/projects/teamwork/categories.json
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/teamwork/categories.json
/projects/api/v3/companies.json
Retrieve all companies for the provided filters.
On this endpoint you can filter by custom fields. The syntax for the
query parameter is the following:
customField[id][op]=value
Where:
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:
| 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 company name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| firstLetter | query | optional | string | filter by first letter of company name |
| createdAfterDate | query | optional | string | filter by created after date (deprecated, use createdAfter) |
| createdAfter | query | optional | string | filter by created after date |
| budgetRanges | query | optional | string | budget distribution ranges |
| 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 |
| useFormulaFields | query | optional | boolean | use formula fields |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| searchClientManagers | query | optional | boolean | include client managers in the search |
| returnLetters | query | optional | boolean | return unfiltered company initial letter counts |
| onlyUntaggedCompanies | query | optional | boolean | only untagged companies |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllExcludedTags | query | optional | boolean | match all exclude tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUntaggedCompanies | query | optional | boolean | include untagged companies |
| includeProfitability | query | optional | boolean | include profitability data for each client |
| includeCustomFields | query | optional | boolean | include custom fields |
| includeBudgetDistribution | query | optional | boolean | include budget distribution data |
| getStats | query | optional | boolean | include stats of company tasks and projects |
| getEmoji | query | optional | boolean | parse emojis to unicode |
| fullProfile | query | optional | boolean | include full profile |
| excludeOwnerCompany | query | optional | boolean | exclude the owner company |
| tagIds | query | optional | array | filter by tag ids |
| selectedColumns | query | optional | array | customise the report by selecting columns |
| projectStatuses | query | optional | array | filter by project statuses |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[users] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[industries] | query | optional | array | — |
| fields[countries] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| excludeTagIds | query | optional | array | filter by excluded tag ids |
| excludeIds | query | optional | array | exclude by company ids |
| clientManagedByUserIds | query | optional | array | filter by client manager user ids |
| CustomFields | query | optional | array | filter by custom fields |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/companies.json
/projects/api/v3/companies/{companyId}.json
Retrieves a company by id.
| 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 company name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| firstLetter | query | optional | string | filter by first letter of company name |
| createdAfterDate | query | optional | string | filter by created after date (deprecated, use createdAfter) |
| createdAfter | query | optional | string | filter by created after date |
| budgetRanges | query | optional | string | budget distribution ranges |
| 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 |
| companyId | path | required | integer | — |
| useFormulaFields | query | optional | boolean | use formula fields |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| searchClientManagers | query | optional | boolean | include client managers in the search |
| returnLetters | query | optional | boolean | return unfiltered company initial letter counts |
| onlyUntaggedCompanies | query | optional | boolean | only untagged companies |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllExcludedTags | query | optional | boolean | match all exclude tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUntaggedCompanies | query | optional | boolean | include untagged companies |
| includeProfitability | query | optional | boolean | include profitability data for each client |
| includeCustomFields | query | optional | boolean | include custom fields |
| includeBudgetDistribution | query | optional | boolean | include budget distribution data |
| getStats | query | optional | boolean | include stats of company tasks and projects |
| getEmoji | query | optional | boolean | parse emojis to unicode |
| fullProfile | query | optional | boolean | include full profile |
| excludeOwnerCompany | query | optional | boolean | exclude the owner company |
| tagIds | query | optional | array | filter by tag ids |
| selectedColumns | query | optional | array | customise the report by selecting columns |
| projectStatuses | query | optional | array | filter by project statuses |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[users] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[industries] | query | optional | array | — |
| fields[countries] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| excludeTagIds | query | optional | array | filter by excluded tag ids |
| excludeIds | query | optional | array | exclude by company ids |
| clientManagedByUserIds | query | optional | array | filter by client manager user ids |
| CustomFields | query | optional | array | filter by custom fields |
200 OK
400 Bad Request
403 Forbidden
404 Not Found
GET /projects/api/v3/companies/{companyId}.json
/projects/api/v3/companies/{companyId}/customfields.json
Return all custom field values from a specific company.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| searchTerm | query | optional | string | filter by custom field value |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| companyId | path | required | integer | — |
| companyId | query | optional | integer | filter by company id |
| useFormulaFields | query | optional | boolean | use formula fields |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| include | query | optional | array | include |
| fields[projects] | query | optional | array | — |
| fields[customfields] | query | optional | array | — |
| customFieldIds | query | optional | array | filter by custom field ids |
200 OK
400 Bad Request
GET /projects/api/v3/companies/{companyId}/customfields.json
/projects/api/v3/companies/{companyId}/customfields/{customFieldId}.json
Return a specific custom field value from a company.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| customFieldId | path | required | integer | — |
| companyId | path | required | integer | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/companies/{companyId}/customfields/{customFieldId}.json
/projects/api/v3/customfields.json
Return all custom fields for the provided filters.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| searchTerm | query | optional | string | filter by custom field name |
| projectStatuses | query | optional | string | filter by project statuses |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| name | query | optional | string | filter by name |
| projectId | query | optional | integer | filter by project id |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| useFormulaFields | query | optional | boolean | use formula fields |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlySiteLevel | query | optional | boolean | only return site-level custom fields |
| onlyProjectLevel | query | optional | boolean | only return custom fields for project-level in the response |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| includeSiteLevel | query | optional | boolean | include custom fields for site-level in the response |
| projectTagIds | query | optional | array | filter by project tag ids |
| 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 |
| 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 custom field ids |
| fields[users] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| entities | query | optional | array | filter by entities |
200 OK
400 Bad Request
GET /projects/api/v3/customfields.json
/projects/api/v3/customfields/{customFieldId}.json
This returns all details about an individual custom field.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| searchTerm | query | optional | string | filter by custom field name |
| projectStatuses | query | optional | string | filter by project statuses |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| name | query | optional | string | filter by name |
| projectId | query | optional | integer | filter by project id |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| customFieldId | path | required | integer | — |
| useFormulaFields | query | optional | boolean | use formula fields |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlySiteLevel | query | optional | boolean | only return site-level custom fields |
| onlyProjectLevel | query | optional | boolean | only return custom fields for project-level in the response |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| includeSiteLevel | query | optional | boolean | include custom fields for site-level in the response |
| projectTagIds | query | optional | array | filter by project tag ids |
| 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 |
| 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 custom field ids |
| fields[users] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| entities | query | optional | array | filter by entities |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/customfields/{customFieldId}.json
/projects/api/v3/projects/{projectId}/customfields.json
Return all custom field values from a specific project.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| searchTerm | query | optional | string | filter by custom field value |
| projectId | 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 |
| useFormulaFields | query | optional | boolean | use formula fields |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| include | query | optional | array | include |
| fields[projects] | query | optional | array | — |
| fields[customfields] | query | optional | array | — |
| customFieldIds | query | optional | array | filter by custom field ids |
200 OK
400 Bad Request
GET /projects/api/v3/projects/{projectId}/customfields.json
/projects/api/v3/projects/{projectId}/customfields/{customFieldId}.json
Return a specific custom field value from a project.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectId | path | required | integer | — |
| customFieldId | path | required | integer | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/projects/{projectId}/customfields/{customFieldId}.json
/projects/api/v3/tasks/{taskId}/customfields.json
Return all custom field values from a specific task.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| searchTerm | query | optional | string | filter by custom field value |
| taskId | path | required | integer | — |
| taskId | query | optional | integer | filter by task id |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| useFormulaFields | query | optional | boolean | use formula fields |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| include | query | optional | array | include |
| fields[projects] | query | optional | array | — |
| fields[customfields] | query | optional | array | — |
| customFieldIds | query | optional | array | filter by custom field ids |
200 OK
400 Bad Request
GET /projects/api/v3/tasks/{taskId}/customfields.json
/projects/api/v3/tasks/{taskId}/customfields/{customFieldId}.json
Return a specific custom field value from a task.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| taskId | path | required | integer | — |
| customFieldId | path | required | integer | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/tasks/{taskId}/customfields/{customFieldId}.json
/projects/api/v3/dashboards.json
Return all dashboards that the logged-in user can access. Dashboards contains
panels that are used to summarize many activities from the installation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| userId | query | optional | integer | filter by user id |
| projectId | query | optional | integer | filter by project id |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| showDeleted | query | optional | boolean | include deleted items |
| emoji | query | optional | boolean | parse emoji alias to unicode |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[dashboards] | query | optional | array | — |
| fields[dashboardSettings] | query | optional | array | — |
| fields[dashboardPanels] | query | optional | array | — |
| fields[dashboardPanelSettings] | query | optional | array | — |
| dashboardIds | query | optional | array | filter by user dashboard ids |
200 OK
400 Bad Request
GET /projects/api/v3/dashboards.json
/projects/api/v3/features.json
Return all features accessible to the current installation.
200 OK
400 Bad Request
GET /projects/api/v3/features.json
/projects/api/v3/files/{fileId}/comments.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| fileId | path | required | integer | — |
200 OK
400 Bad Request
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/files/{fileId}/comments.json
/projects/api/v3/fileversions/{id}/comments.json
| 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 |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| id | path | required | integer | — |
| 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 | — |
200 OK
400 Bad Request
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/fileversions/{id}/comments.json
/projects/api/v3/forms.json
Return a list of all forms.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token.state | query | optional | string | query by token state |
| searchTerm | query | optional | string | filter by form name |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| hostObject.type | query | optional | string | query by hostObject type |
| content.state | query | optional | string | query by form state |
| userId | query | optional | integer | filter by user id |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| hostObject.id | query | optional | integer | filter by host id |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| onlyProjectsWithExplicitMembership | query | optional | boolean | filter only by project with direct membership |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| projectIds | query | optional | array | filter by project ids |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[forms] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
200 OK
400 Bad Request
GET /projects/api/v3/forms.json
/projects/api/v3/forms/{formId}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| formId | path | required | integer | — |
200 OK
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/forms/{formId}.json
/projects/api/v3/forms/{formId}/draft.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| formId | path | required | integer | — |
200 OK
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/forms/{formId}/draft.json
/projects/api/v3/forms/public/{token}.json
This endpoint does not require authentication.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| token.state | query | optional | string | query by token state |
| searchTerm | query | optional | string | filter by form name |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| hostObject.type | query | optional | string | query by hostObject type |
| content.state | query | optional | string | query by form state |
| userId | query | optional | integer | filter by user id |
| token | path | required | integer | — |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| hostObject.id | query | optional | integer | filter by host id |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| onlyProjectsWithExplicitMembership | query | optional | boolean | filter only by project with direct membership |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| projectIds | query | optional | array | filter by project ids |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[forms] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
200 OK
404 Not Found (no data)
GET /projects/api/v3/forms/public/{token}.json
/projects/api/v3/importer/stats.json
This endpoint returns info about a set of importers. This includes whether
they are individually running or not, what’s their status and a flag to
represent if any importer is running. The endpoint looks up redis for this
information. Using the parameter resetImporters this information can be
deleted in redis to reset it.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| resetImporters | query | optional | boolean | reset importers |
200 OK
400 Bad Request
GET /projects/api/v3/importer/stats.json
/projects/api/v3/messages.json
Retrieve all messages for the provided filters.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| searchTerm | query | optional | string | filter by message name and body |
| projectType | query | optional | string | filter by project type |
| projectStatuses | query | optional | string | filter by project statuses |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| createdBefore | query | optional | string | filter by created before date |
| createdAfter | query | optional | string | filter by created after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| updatedAfterIncludesReplies | query | optional | boolean | consider reply dates when using updatedAfter |
| unreadOnly | query | optional | boolean | show unread messages only |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| includeDeleted | query | optional | boolean | include deleted messages |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| getEmoji | query | optional | boolean | parse emojis to unicode |
| formatMarkdown | query | optional | boolean | — |
| archivedOnly | query | optional | boolean | show archived messages only |
| userIds | query | optional | array | filter by user ids |
| tagIds | query | optional | array | filter by tag ids |
| projectTagIds | query | optional | array | filter by project tag ids |
| 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 |
| projectCompanyIds | query | optional | array | filter by company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| notifiedUserIds | query | optional | array | filter by users who got notified for the messages |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[projects] | query | optional | array | — |
| fields[messageReplies] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/messages.json
/projects/api/v3/messages/{messageId}.json
Retrieves a message by id.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| searchTerm | query | optional | string | filter by message name and body |
| projectType | query | optional | string | filter by project type |
| projectStatuses | query | optional | string | filter by project statuses |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| createdBefore | query | optional | string | filter by created before date |
| createdAfter | query | optional | string | filter by created after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| messageId | path | required | integer | — |
| updatedAfterIncludesReplies | query | optional | boolean | consider reply dates when using updatedAfter |
| unreadOnly | query | optional | boolean | show unread messages only |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| includeDeleted | query | optional | boolean | include deleted messages |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| getEmoji | query | optional | boolean | parse emojis to unicode |
| formatMarkdown | query | optional | boolean | — |
| archivedOnly | query | optional | boolean | show archived messages only |
| userIds | query | optional | array | filter by user ids |
| tagIds | query | optional | array | filter by tag ids |
| projectTagIds | query | optional | array | filter by project tag ids |
| 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 |
| projectCompanyIds | query | optional | array | filter by company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| notifiedUserIds | query | optional | array | filter by users who got notified for the messages |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[projects] | query | optional | array | — |
| fields[messageReplies] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
200 OK
400 Bad Request
403 Forbidden
404 Not Found
GET /projects/api/v3/messages/{messageId}.json
/projects/api/v3/milestones/{milestoneId}/comments.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| milestoneId | path | required | integer | — |
200 OK
400 Bad Request
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/milestones/{milestoneId}/comments.json
/projects/api/v3/milestones.json
All milestones are returned on projects that the authenticated user is
associated with. You can use the provided filters to return only those
milestones that are incomplete, completed, upcoming or late. All milestones
are returning in this call. This call uses pagination, returning 100
milestones per page by default.
| 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 milestone name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| dueBeforeDate | query | optional | string | filter by due before date (deprecated, use dueBefore) |
| dueBefore | query | optional | string | filter by due before date |
| dueAfterDate | query | optional | string | filter by due after date (deprecated, use dueAfter) |
| dueAfter | query | optional | string | filter by due after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| showPrivate | query | optional | boolean | show private milestones |
| showDeleted | query | optional | boolean | include deleted items |
| showAttachedTasklists | query | optional | boolean | show attached tasklists |
| searchCompaniesTeams | query | optional | boolean | include companies and teams in the search term |
| searchAssignees | query | optional | boolean | include assignees in the search |
| progress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyMyProjects | query | optional | boolean | filter by projects that the logged-in user is related |
| onlyAdminProjects | query | optional | boolean | only include milestones from projects where the user is strictly a project admin. |
| matchAllTags | query | optional | boolean | match all milestone tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUpdate | query | optional | boolean | include milestones latest update action |
| includeToday | query | optional | boolean | include today when milestone status is upcoming |
| includeTeamUserIds | query | optional | boolean | include team users to the responsible party ids |
| includeTags | query | optional | boolean | include tags in the reports |
| includeProgress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| includePercentageComplete | query | optional | boolean | include percentage of tasks completed for all linked tasklists |
| includeCompleted | query | optional | boolean | optional to include completed milestones |
| includeCompanyUserIds | query | optional | boolean | include company users to the responsible party ids |
| 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 |
| emoji | query | optional | boolean | convert emoji alias to unicode |
| countUnreadComments | query | optional | boolean | count unread comments |
| calendar | query | optional | boolean | enables the calendar style layout |
| tagIds | query | optional | array | filter by milestone tag ids |
| status | query | optional | array | filter by list of milestone status |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectTagIds | query | optional | array | filter by project tag ids |
| projectStatuses | query | optional | array | filter by list of 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 list of project health |
| projectHealth | query | optional | array | filter by list of 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 |
| ids | query | optional | array | filter by ids |
| followerIds | query | optional | array | filter by followers’ ids |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[milestones] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| creatorIds | query | optional | array | filter by creators’ 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 |
200 OK
400 Bad Request
GET /projects/api/v3/milestones.json
/projects/api/v3/milestones/metrics/deadlines.json
Count the number of milestones on each deadline date. Only the milestones
that the logged-in user can access will be included in the counting.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| startDate | query | optional | string | — |
| endDate | query | optional | string | — |
200 OK
400 Bad Request
GET /projects/api/v3/milestones/metrics/deadlines.json
/projects/api/v3/milestones/{milestonId}.json
This returns all details about an individual milestone.
| 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 milestone name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| dueBeforeDate | query | optional | string | filter by due before date (deprecated, use dueBefore) |
| dueBefore | query | optional | string | filter by due before date |
| dueAfterDate | query | optional | string | filter by due after date (deprecated, use dueAfter) |
| dueAfter | query | optional | string | filter by due after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| milestonId | path | required | integer | — |
| showPrivate | query | optional | boolean | show private milestones |
| showDeleted | query | optional | boolean | include deleted items |
| showAttachedTasklists | query | optional | boolean | show attached tasklists |
| searchCompaniesTeams | query | optional | boolean | include companies and teams in the search term |
| searchAssignees | query | optional | boolean | include assignees in the search |
| progress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyMyProjects | query | optional | boolean | filter by projects that the logged-in user is related |
| onlyAdminProjects | query | optional | boolean | only include milestones from projects where the user is strictly a project admin. |
| matchAllTags | query | optional | boolean | match all milestone tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUpdate | query | optional | boolean | include milestones latest update action |
| includeToday | query | optional | boolean | include today when milestone status is upcoming |
| includeTeamUserIds | query | optional | boolean | include team users to the responsible party ids |
| includeTags | query | optional | boolean | include tags in the reports |
| includeProgress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| includePercentageComplete | query | optional | boolean | include percentage of tasks completed for all linked tasklists |
| includeCompleted | query | optional | boolean | optional to include completed milestones |
| includeCompanyUserIds | query | optional | boolean | include company users to the responsible party ids |
| 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 |
| emoji | query | optional | boolean | convert emoji alias to unicode |
| countUnreadComments | query | optional | boolean | count unread comments |
| calendar | query | optional | boolean | enables the calendar style layout |
| tagIds | query | optional | array | filter by milestone tag ids |
| status | query | optional | array | filter by list of milestone status |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectTagIds | query | optional | array | filter by project tag ids |
| projectStatuses | query | optional | array | filter by list of 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 list of project health |
| projectHealth | query | optional | array | filter by list of 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 |
| ids | query | optional | array | filter by ids |
| followerIds | query | optional | array | filter by followers’ ids |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[milestones] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| creatorIds | query | optional | array | filter by creators’ 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 |
200 OK
400 Bad Request
GET /projects/api/v3/milestones/{milestonId}.json
/projects/api/v3/projects/{projectId}/milestones.json
This lets you query the list of milestones for a project. You can use the
provided filters to return only those milestones that are incomplete,
completed, upcoming or late. This call uses pagination, returning 100
milestones per page by default.
| 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 milestone name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| dueBeforeDate | query | optional | string | filter by due before date (deprecated, use dueBefore) |
| dueBefore | query | optional | string | filter by due before date |
| dueAfterDate | query | optional | string | filter by due after date (deprecated, use dueAfter) |
| dueAfter | query | optional | string | filter by due after date |
| projectId | path | required | integer | — |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| showPrivate | query | optional | boolean | show private milestones |
| showDeleted | query | optional | boolean | include deleted items |
| showAttachedTasklists | query | optional | boolean | show attached tasklists |
| searchCompaniesTeams | query | optional | boolean | include companies and teams in the search term |
| searchAssignees | query | optional | boolean | include assignees in the search |
| progress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyMyProjects | query | optional | boolean | filter by projects that the logged-in user is related |
| onlyAdminProjects | query | optional | boolean | only include milestones from projects where the user is strictly a project admin. |
| matchAllTags | query | optional | boolean | match all milestone tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUpdate | query | optional | boolean | include milestones latest update action |
| includeToday | query | optional | boolean | include today when milestone status is upcoming |
| includeTeamUserIds | query | optional | boolean | include team users to the responsible party ids |
| includeTags | query | optional | boolean | include tags in the reports |
| includeProgress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| includePercentageComplete | query | optional | boolean | include percentage of tasks completed for all linked tasklists |
| includeCompleted | query | optional | boolean | optional to include completed milestones |
| includeCompanyUserIds | query | optional | boolean | include company users to the responsible party ids |
| 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 |
| emoji | query | optional | boolean | convert emoji alias to unicode |
| countUnreadComments | query | optional | boolean | count unread comments |
| calendar | query | optional | boolean | enables the calendar style layout |
| tagIds | query | optional | array | filter by milestone tag ids |
| status | query | optional | array | filter by list of milestone status |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectTagIds | query | optional | array | filter by project tag ids |
| projectStatuses | query | optional | array | filter by list of 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 list of project health |
| projectHealth | query | optional | array | filter by list of 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 |
| ids | query | optional | array | filter by ids |
| followerIds | query | optional | array | filter by followers’ ids |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[milestones] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| creatorIds | query | optional | array | filter by creators’ 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/milestones.json
/projects/api/v3/reporting/precanned/plannedvsactual/milestones.csv
Generates a milestone report in CSV format containing all milestones for the
provided filters. Only the milestones that the logged-in user can access will
be returned.
| 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 milestone name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| dueBeforeDate | query | optional | string | filter by due before date (deprecated, use dueBefore) |
| dueBefore | query | optional | string | filter by due before date |
| dueAfterDate | query | optional | string | filter by due after date (deprecated, use dueAfter) |
| dueAfter | query | optional | string | filter by due after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| showPrivate | query | optional | boolean | show private milestones |
| showDeleted | query | optional | boolean | include deleted items |
| showAttachedTasklists | query | optional | boolean | show attached tasklists |
| searchCompaniesTeams | query | optional | boolean | include companies and teams in the search term |
| searchAssignees | query | optional | boolean | include assignees in the search |
| progress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyMyProjects | query | optional | boolean | filter by projects that the logged-in user is related |
| onlyAdminProjects | query | optional | boolean | only include milestones from projects where the user is strictly a project admin. |
| matchAllTags | query | optional | boolean | match all milestone tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUpdate | query | optional | boolean | include milestones latest update action |
| includeToday | query | optional | boolean | include today when milestone status is upcoming |
| includeTeamUserIds | query | optional | boolean | include team users to the responsible party ids |
| includeTags | query | optional | boolean | include tags in the reports |
| includeProgress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| includePercentageComplete | query | optional | boolean | include percentage of tasks completed for all linked tasklists |
| includeCompleted | query | optional | boolean | optional to include completed milestones |
| includeCompanyUserIds | query | optional | boolean | include company users to the responsible party ids |
| 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 |
| emoji | query | optional | boolean | convert emoji alias to unicode |
| countUnreadComments | query | optional | boolean | count unread comments |
| calendar | query | optional | boolean | enables the calendar style layout |
| tagIds | query | optional | array | filter by milestone tag ids |
| status | query | optional | array | filter by list of milestone status |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectTagIds | query | optional | array | filter by project tag ids |
| projectStatuses | query | optional | array | filter by list of 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 list of project health |
| projectHealth | query | optional | array | filter by list of 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 |
| ids | query | optional | array | filter by ids |
| followerIds | query | optional | array | filter by followers’ ids |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[milestones] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| creatorIds | query | optional | array | filter by creators’ 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 |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/plannedvsactual/milestones.csv
/projects/api/v3/reporting/precanned/plannedvsactual/milestones.html
Generates a milestone report in HTML format containing all milestones for the
provided filters. Only the milestones that the logged-in user can access will
be returned.
| 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 milestone name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| dueBeforeDate | query | optional | string | filter by due before date (deprecated, use dueBefore) |
| dueBefore | query | optional | string | filter by due before date |
| dueAfterDate | query | optional | string | filter by due after date (deprecated, use dueAfter) |
| dueAfter | query | optional | string | filter by due after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| showPrivate | query | optional | boolean | show private milestones |
| showDeleted | query | optional | boolean | include deleted items |
| showAttachedTasklists | query | optional | boolean | show attached tasklists |
| searchCompaniesTeams | query | optional | boolean | include companies and teams in the search term |
| searchAssignees | query | optional | boolean | include assignees in the search |
| progress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyMyProjects | query | optional | boolean | filter by projects that the logged-in user is related |
| onlyAdminProjects | query | optional | boolean | only include milestones from projects where the user is strictly a project admin. |
| matchAllTags | query | optional | boolean | match all milestone tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUpdate | query | optional | boolean | include milestones latest update action |
| includeToday | query | optional | boolean | include today when milestone status is upcoming |
| includeTeamUserIds | query | optional | boolean | include team users to the responsible party ids |
| includeTags | query | optional | boolean | include tags in the reports |
| includeProgress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| includePercentageComplete | query | optional | boolean | include percentage of tasks completed for all linked tasklists |
| includeCompleted | query | optional | boolean | optional to include completed milestones |
| includeCompanyUserIds | query | optional | boolean | include company users to the responsible party ids |
| 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 |
| emoji | query | optional | boolean | convert emoji alias to unicode |
| countUnreadComments | query | optional | boolean | count unread comments |
| calendar | query | optional | boolean | enables the calendar style layout |
| tagIds | query | optional | array | filter by milestone tag ids |
| status | query | optional | array | filter by list of milestone status |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectTagIds | query | optional | array | filter by project tag ids |
| projectStatuses | query | optional | array | filter by list of 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 list of project health |
| projectHealth | query | optional | array | filter by list of 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 |
| ids | query | optional | array | filter by ids |
| followerIds | query | optional | array | filter by followers’ ids |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[milestones] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| creatorIds | query | optional | array | filter by creators’ 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 |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/plannedvsactual/milestones.html
/projects/api/v3/reporting/precanned/plannedvsactual/milestones.pdf
Generates a milestone report in PDF format containing all milestones for the
provided filters. Only the milestones that the logged-in user can access will
be returned.
| 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 milestone name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| dueBeforeDate | query | optional | string | filter by due before date (deprecated, use dueBefore) |
| dueBefore | query | optional | string | filter by due before date |
| dueAfterDate | query | optional | string | filter by due after date (deprecated, use dueAfter) |
| dueAfter | query | optional | string | filter by due after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| showPrivate | query | optional | boolean | show private milestones |
| showDeleted | query | optional | boolean | include deleted items |
| showAttachedTasklists | query | optional | boolean | show attached tasklists |
| searchCompaniesTeams | query | optional | boolean | include companies and teams in the search term |
| searchAssignees | query | optional | boolean | include assignees in the search |
| progress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyMyProjects | query | optional | boolean | filter by projects that the logged-in user is related |
| onlyAdminProjects | query | optional | boolean | only include milestones from projects where the user is strictly a project admin. |
| matchAllTags | query | optional | boolean | match all milestone tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUpdate | query | optional | boolean | include milestones latest update action |
| includeToday | query | optional | boolean | include today when milestone status is upcoming |
| includeTeamUserIds | query | optional | boolean | include team users to the responsible party ids |
| includeTags | query | optional | boolean | include tags in the reports |
| includeProgress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| includePercentageComplete | query | optional | boolean | include percentage of tasks completed for all linked tasklists |
| includeCompleted | query | optional | boolean | optional to include completed milestones |
| includeCompanyUserIds | query | optional | boolean | include company users to the responsible party ids |
| 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 |
| emoji | query | optional | boolean | convert emoji alias to unicode |
| countUnreadComments | query | optional | boolean | count unread comments |
| calendar | query | optional | boolean | enables the calendar style layout |
| tagIds | query | optional | array | filter by milestone tag ids |
| status | query | optional | array | filter by list of milestone status |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectTagIds | query | optional | array | filter by project tag ids |
| projectStatuses | query | optional | array | filter by list of 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 list of project health |
| projectHealth | query | optional | array | filter by list of 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 |
| ids | query | optional | array | filter by ids |
| followerIds | query | optional | array | filter by followers’ ids |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[milestones] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| creatorIds | query | optional | array | filter by creators’ 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 |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/plannedvsactual/milestones.pdf
/projects/api/v3/reporting/precanned/plannedvsactual/milestones.xlsx
Generates a milestone report in XLSX format containing all milestones for the
provided filters. Only the milestones that the logged-in user can access will
be returned.
| 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 milestone name and description |
| reportType | query | optional | string | define the type of the report |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| dueBeforeDate | query | optional | string | filter by due before date (deprecated, use dueBefore) |
| dueBefore | query | optional | string | filter by due before date |
| dueAfterDate | query | optional | string | filter by due after date (deprecated, use dueAfter) |
| dueAfter | query | optional | string | filter by due after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| showPrivate | query | optional | boolean | show private milestones |
| showDeleted | query | optional | boolean | include deleted items |
| showAttachedTasklists | query | optional | boolean | show attached tasklists |
| searchCompaniesTeams | query | optional | boolean | include companies and teams in the search term |
| searchAssignees | query | optional | boolean | include assignees in the search |
| progress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| onlyMyProjects | query | optional | boolean | filter by projects that the logged-in user is related |
| onlyAdminProjects | query | optional | boolean | only include milestones from projects where the user is strictly a project admin. |
| matchAllTags | query | optional | boolean | match all milestone tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeUpdate | query | optional | boolean | include milestones latest update action |
| includeToday | query | optional | boolean | include today when milestone status is upcoming |
| includeTeamUserIds | query | optional | boolean | include team users to the responsible party ids |
| includeTags | query | optional | boolean | include tags in the reports |
| includeProgress | query | optional | boolean | include percentage of tasks completed for all linked tasklists (deprecated, use includePercentageComplete) |
| includePercentageComplete | query | optional | boolean | include percentage of tasks completed for all linked tasklists |
| includeCompleted | query | optional | boolean | optional to include completed milestones |
| includeCompanyUserIds | query | optional | boolean | include company users to the responsible party ids |
| 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 |
| emoji | query | optional | boolean | convert emoji alias to unicode |
| countUnreadComments | query | optional | boolean | count unread comments |
| calendar | query | optional | boolean | enables the calendar style layout |
| tagIds | query | optional | array | filter by milestone tag ids |
| status | query | optional | array | filter by list of milestone status |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectTagIds | query | optional | array | filter by project tag ids |
| projectStatuses | query | optional | array | filter by list of 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 list of project health |
| projectHealth | query | optional | array | filter by list of 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 |
| ids | query | optional | array | filter by ids |
| followerIds | query | optional | array | filter by followers’ ids |
| fields[users] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[milestones] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| creatorIds | query | optional | array | filter by creators’ 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 |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/plannedvsactual/milestones.xlsx
/projects/api/v3/notebooks/{notebookId}/comments.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| notebookId | path | required | integer | — |
200 OK
400 Bad Request
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/notebooks/{notebookId}/comments.json
/projects/api/v3/notebooks.json
| 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 notebook name and description |
| projectType | query | optional | string | filter by project type |
| projectStatuses | query | optional | string | filter by project statuses |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| createdAfterDate | query | optional | string | filter by created after date (deprecated, use createdAfter) |
| createdAfter | query | optional | string | filter by created after date |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| showDeleted | query | optional | boolean | include deleted items |
| secureOnly | query | optional | boolean | filter by showing only secure notebooks |
| matchAllTags | query | optional | boolean | match all notebook tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| lockedOnly | query | optional | boolean | filter by showing only locked notebooks |
| includeContents | query | optional | boolean | include contents. |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| getEmoji | query | optional | boolean | parse emojis to unicode |
| tagIds | query | optional | array | filter by notebook tag ids |
| projectTagIds | query | optional | array | filter by project tag ids |
| 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 |
| 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 ids |
| fields[users] | query | optional | array | — |
| fields[teams] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[notebooks] | query | optional | array | — |
| fields[notebookCategories] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| creatorIds | query | optional | array | filter by creators’ ids |
| categoryIds | query | optional | array | filter by notebook category ids |
200 OK
400 Bad Request
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/notebooks.json
/projects/api/v3/notebooks/{notebookId}.json
| 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 |
| projectType | query | optional | string | filter by project type |
| notebookId | path | required | integer | — |
| showDeleted | query | optional | boolean | show deleted notebooks |
| getEmoji | query | optional | boolean | parse emojis to unicode |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
| fields[teams] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[notebooks] | query | optional | array | — |
| fields[notebookCategories] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
200 OK
400 Bad Request
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/notebooks/{notebookId}.json
/projects/api/v3/notebooks/{notebookId}/compare.json
Gets the contents diff between the contents of 2 notebook versions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| notebookId | path | required | integer | — |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/notebooks/{notebookId}/compare.json
/projects/api/v3/notebooks/{notebookId}/versions.json
Get a list of a notebooks versions.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| notebookId | path | required | integer | — |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/notebooks/{notebookId}/versions.json
/projects/api/v3/notebooks/{notebookId}/versions/{versionId}.json
Get a specific notebook version.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| versionId | path | required | integer | — |
| notebookId | path | required | integer | — |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/notebooks/{notebookId}/versions/{versionId}.json
/projects/api/v3/people.json
Retrieve all people for the provided filters.
| 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 | — |
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/people.json
/projects/api/v3/people/metrics/performance.json
Count the number of completed tasks by user for the provided period. By
default the user with the most completed tasks is shown first.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| startDate | query | optional | string | — |
| orderMode | query | optional | string | order mode |
| endDate | query | optional | string | — |
200 OK
400 Bad Request
GET /projects/api/v3/people/metrics/performance.json
/projects/api/v3/people/utilization.json
Verify the user utilization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| zoom | query | optional | string | determine the type of zoom filter used to display on the report |
| startDate | query | optional | string | filter by start date |
| sortOrder | query | optional | string | order mode |
| sort | query | optional | string | sort by (deprecated, use orderBy) |
| searchTerm | query | optional | string | filter by user first or last name |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | group by |
| orderBy | query | optional | string | sort by |
| groupBy | query | optional | string | group by |
| endDate | query | optional | string | filter by end date |
| 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 |
| isReportDownload | query | optional | boolean | generate a report document |
| isCustomDateRange | query | optional | boolean | determine if the query is for a custom date range |
| includeCollaborators | query | optional | boolean | include collaborators |
| includeClients | query | optional | boolean | include client users |
| userIds | query | optional | array | filter by userIds |
| teamIds | query | optional | array | filter by team ids |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectIds | query | optional | array | filter by project ids |
| include | query | optional | array | include |
| fields[utilizations] | query | optional | array | — |
| fields[users] | query | optional | array | — |
| companyIds | query | optional | array | filter by company ids |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/people/utilization.json
/projects/api/v3/projects/{projectId}/people.json
Retrieve all people on the project.
| 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 | — |
| 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 |
| 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 |
| includeServiceAccounts | query | optional | boolean | include service accounts |
| includeObservers | query | optional | boolean | include project observers |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/people.json
/projects/api/v3/reporting/precanned/usertaskcompletion.json
Retrieve all people for the provided filters and their task completions.
| 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 |
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/reporting/precanned/usertaskcompletion.json
/projects/api/v3/reporting/precanned/utilization.csv
Generates a utilization report in CSV format containing all people for the
provided filters. Only the people that the logged-in user can access will
be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| zoom | query | optional | string | determine the type of zoom filter used to display on the report |
| startDate | query | optional | string | filter by start date |
| sortOrder | query | optional | string | order mode |
| sort | query | optional | string | sort by (deprecated, use orderBy) |
| searchTerm | query | optional | string | filter by user first or last name |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | group by |
| orderBy | query | optional | string | sort by |
| groupBy | query | optional | string | group by |
| endDate | query | optional | string | filter by end date |
| 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 |
| isReportDownload | query | optional | boolean | generate a report document |
| isCustomDateRange | query | optional | boolean | determine if the query is for a custom date range |
| includeCollaborators | query | optional | boolean | include collaborators |
| includeClients | query | optional | boolean | include client users |
| userIds | query | optional | array | filter by userIds |
| teamIds | query | optional | array | filter by team ids |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectIds | query | optional | array | filter by project ids |
| include | query | optional | array | include |
| fields[utilizations] | query | optional | array | — |
| fields[users] | query | optional | array | — |
| companyIds | query | optional | array | filter by company ids |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/utilization.csv
/projects/api/v3/reporting/precanned/utilization.html
Generates a utilization report in HTML format containing all people for the
provided filters. Only the people that the logged-in user can access will
be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| zoom | query | optional | string | determine the type of zoom filter used to display on the report |
| startDate | query | optional | string | filter by start date |
| sortOrder | query | optional | string | order mode |
| sort | query | optional | string | sort by (deprecated, use orderBy) |
| searchTerm | query | optional | string | filter by user first or last name |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | group by |
| orderBy | query | optional | string | sort by |
| groupBy | query | optional | string | group by |
| endDate | query | optional | string | filter by end date |
| 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 |
| isReportDownload | query | optional | boolean | generate a report document |
| isCustomDateRange | query | optional | boolean | determine if the query is for a custom date range |
| includeCollaborators | query | optional | boolean | include collaborators |
| includeClients | query | optional | boolean | include client users |
| userIds | query | optional | array | filter by userIds |
| teamIds | query | optional | array | filter by team ids |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectIds | query | optional | array | filter by project ids |
| include | query | optional | array | include |
| fields[utilizations] | query | optional | array | — |
| fields[users] | query | optional | array | — |
| companyIds | query | optional | array | filter by company ids |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/utilization.html
/projects/api/v3/reporting/precanned/utilization.pdf
Generates a utilization report in PDF format containing all people for the
provided filters. Only the people that the logged-in user can access will
be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| zoom | query | optional | string | determine the type of zoom filter used to display on the report |
| startDate | query | optional | string | filter by start date |
| sortOrder | query | optional | string | order mode |
| sort | query | optional | string | sort by (deprecated, use orderBy) |
| searchTerm | query | optional | string | filter by user first or last name |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | group by |
| orderBy | query | optional | string | sort by |
| groupBy | query | optional | string | group by |
| endDate | query | optional | string | filter by end date |
| 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 |
| isReportDownload | query | optional | boolean | generate a report document |
| isCustomDateRange | query | optional | boolean | determine if the query is for a custom date range |
| includeCollaborators | query | optional | boolean | include collaborators |
| includeClients | query | optional | boolean | include client users |
| userIds | query | optional | array | filter by userIds |
| teamIds | query | optional | array | filter by team ids |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectIds | query | optional | array | filter by project ids |
| include | query | optional | array | include |
| fields[utilizations] | query | optional | array | — |
| fields[users] | query | optional | array | — |
| companyIds | query | optional | array | filter by company ids |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/utilization.pdf
/projects/api/v3/reporting/precanned/utilization.xlsx
Generates a utilization report in XLSX format containing all people for the
provided filters. Only the people that the logged-in user can access will
be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| zoom | query | optional | string | determine the type of zoom filter used to display on the report |
| startDate | query | optional | string | filter by start date |
| sortOrder | query | optional | string | order mode |
| sort | query | optional | string | sort by (deprecated, use orderBy) |
| searchTerm | query | optional | string | filter by user first or last name |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | group by |
| orderBy | query | optional | string | sort by |
| groupBy | query | optional | string | group by |
| endDate | query | optional | string | filter by end date |
| 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 |
| isReportDownload | query | optional | boolean | generate a report document |
| isCustomDateRange | query | optional | boolean | determine if the query is for a custom date range |
| includeCollaborators | query | optional | boolean | include collaborators |
| includeClients | query | optional | boolean | include client users |
| userIds | query | optional | array | filter by userIds |
| teamIds | query | optional | array | filter by team ids |
| selectedColumns | query | optional | array | customise the report by selecting columns to be displayed. |
| projectIds | query | optional | array | filter by project ids |
| include | query | optional | array | include |
| fields[utilizations] | query | optional | array | — |
| fields[users] | query | optional | array | — |
| companyIds | query | optional | array | filter by company ids |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/utilization.xlsx
/projects/api/v3/statuses.json
All of the latest status posts are returned for all users in the parent
company.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | return only statuses updated after a specific date |
| searchTerm | query | optional | string | filter by the user name or status message |
| 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 |
| showEveryone | query | optional | boolean | show also users without status |
| 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 | — |
| fields[statuses] | query | optional | array | — |
200 OK
400 Bad Request
GET /projects/api/v3/statuses.json
/projects/api/v3/statuses/timeline.json
Return a timeline list of people statuses that the logged-in user can access.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| searchTerm | query | optional | string | filter by the user name or status message |
| 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 |
| 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 | — |
200 OK
400 Bad Request
GET /projects/api/v3/statuses/timeline.json
/projects/api/v3/teams/{teamId}/statuses/timeline.json
Return people statuses from a specific team that the logged-in user can
access.
| 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 |
| 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 | — |
200 OK
400 Bad Request
GET /projects/api/v3/teams/{teamId}/statuses/timeline.json
/projects/api/v3/people/{personId}.json
Retrieve a person record.
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/people/{personId}.json
/projects/api/v3/projects/{projectId}/people/{personId}.json
Retrieve a person record.
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/people/{personId}.json
/projects/api/v3/reporting/precanned/usertaskcompletion/{userId}.json
Retrieve a person record and its task completion stats.
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/reporting/precanned/usertaskcompletion/{userId}.json
/projects/api/v3/projects/updates.json
Return the updates from all projects that the logged-in user can access.
| 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 |
| 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 | — |
200 OK
400 Bad Request
GET /projects/api/v3/projects/updates.json
/projects/api/v3/projects/{projectIds}/updates.json
Return the updates from a specific project.
| 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 |
| 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 | — |
200 OK
400 Bad Request
GET /projects/api/v3/projects/{projectIds}/updates.json
/projects/api/v3/projects.json
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:
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:
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects.json
/projects/api/v3/projects/metrics/active.json
Return the number of active projects that the logged-in user can access.
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/projects/metrics/active.json
/projects/api/v3/projects/metrics/billable.json
Returns the total billable time of all projects that the logged-in user has
access.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| startDate | query | optional | string | — |
| orderMode | query | optional | string | order mode |
| endDate | query | optional | string | — |
200 OK
400 Bad Request
GET /projects/api/v3/projects/metrics/billable.json
/projects/api/v3/projects/metrics/healths.json
Return the number of projects on each health category. It will only count the
projects that the logged-in user can access.
| 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 |
| projectCompanyIds | query | optional | array | filter by company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
200 OK
400 Bad Request
GET /projects/api/v3/projects/metrics/healths.json
/projects/api/v3/projects/metrics/invoice.json
Count the number of open invoices on all projects that the logged-in user has
access.
| 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 |
| projectCompanyIds | query | optional | array | filter by company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
200 OK
400 Bad Request
GET /projects/api/v3/projects/metrics/invoice.json
/projects/api/v3/projects/metrics/owners.json
Count the number of projects per project owner user.
| 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 |
| 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 |
| projectCompanyIds | query | optional | array | filter by company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
200 OK
400 Bad Request
GET /projects/api/v3/projects/metrics/owners.json
/projects/api/v3/projects/metrics/unbilled.json
Return the un-billed expenses for each project that the logged-in user has
access.
| 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 |
| projectCompanyIds | query | optional | array | filter by company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
200 OK
400 Bad Request
GET /projects/api/v3/projects/metrics/unbilled.json
/projects/api/v3/projects/starred.json
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:
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:
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/starred.json
/projects/api/v3/projects/teamwork/samples.json
Retrieve all sample projects for the provided filters.
| 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 |
| ids | query | optional | array | filter by sample ids |
| fields[sampleprojects] | query | optional | array | — |
| categoryIds | query | optional | array | filter by category ids |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/teamwork/samples.json
/projects/api/v3/projects/templates.json
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:
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:
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/templates.json
/projects/api/v3/projects/{projectId}.json
On this endpoint you can filter by project custom fields. The syntax for the
query parameter is the following:
projectCustomField[id][op]=value
Where:
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:
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/projects/{projectId}.json
/projects/api/v3/projects/{projectId}/featureorder.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| projectId | path | required | integer | — |
200 OK
400 Bad Request
GET /projects/api/v3/projects/{projectId}/featureorder.json
/projects/api/v3/reporting/precanned/health/projects.csv
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:
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:
| 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 |
| 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 |
| 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 |
200 OK (no data)
400 Bad Request
403 Forbidden
GET /projects/api/v3/reporting/precanned/health/projects.csv
/projects/api/v3/reporting/precanned/health/projects.html
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:
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:
| 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 |
| 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 |
| 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 |
200 OK (no data)
400 Bad Request
403 Forbidden
GET /projects/api/v3/reporting/precanned/health/projects.html
/projects/api/v3/reporting/precanned/health/projects.pdf
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:
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:
| 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 |
| 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 |
| 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 |
200 OK (no data)
400 Bad Request
403 Forbidden
GET /projects/api/v3/reporting/precanned/health/projects.pdf
/projects/api/v3/reporting/precanned/health/projects.xlsx
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:
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:
| 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 |
| 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 |
| 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 |
200 OK (no data)
400 Bad Request
403 Forbidden
GET /projects/api/v3/reporting/precanned/health/projects.xlsx
/projects/api/v3/projects/{projectId}/risks
Return all risks for a specific project. Only filters that the logged-in user
has access will be returned.
| 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 |
| 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 | — |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/risks
/projects/api/v3/risks.json
Return all risks for the provided filters. Only filters that the logged-in user
has access will be returned.
| 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 |
| 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 | — |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/risks.json
/projects/api/v3/projects/{projectId}/summary.json
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:
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:
| 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 |
| 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 |
| 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 |
| projectHealth | query | optional | array | project health (deprecated, use projectHealths) 0: not set |
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
GET /projects/api/v3/projects/{projectId}/summary.json
/projects/api/v3/summary.json
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:
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:
| 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 |
| 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 |
| 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 |
| projectHealth | query | optional | array | project healths (deprecated, use projectHealths) 0: not set |
| 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 |
| 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 |
200 OK
400 Bad Request
GET /projects/api/v3/summary.json
/projects/api/v3/tags.json
Return all tags that the logged-in user can access.
| 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 |
| 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 | — |
200 OK
400 Bad Request
GET /projects/api/v3/tags.json
/projects/api/v3/tags/{tagId}.json
Return a specific tag.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tagId | path | required | integer | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/tags/{tagId}.json
/projects/api/v3/tasks/{taskId}/comments.json
| 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 | — |
200 OK
400 Bad Request
403 Forbidden
404 Not Found (no data)
GET /projects/api/v3/tasks/{taskId}/comments.json
/projects/api/v3/projects/{projectId}/tasklists
| 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 |
| 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 |
| 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 | — |
200 OK
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/tasklists
/projects/api/v3/projects/{projectId}/tasklists.csv
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.
| 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 |
200 OK (no data)
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/tasklists.csv
/projects/api/v3/projects/{projectId}/tasklists.html
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.
| 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 |
200 OK (no data)
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/tasklists.html
/projects/api/v3/projects/{projectId}/tasklists.pdf
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.
| 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 |
200 OK (no data)
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/tasklists.pdf
/projects/api/v3/projects/{projectId}/tasklists.xlsx
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.
| 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 |
200 OK (no data)
400 Bad Request
403 Forbidden
GET /projects/api/v3/projects/{projectId}/tasklists.xlsx
/projects/api/v3/tasklists
| 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 |
| 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 |
| 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 | — |
200 OK
400 Bad Request
GET /projects/api/v3/tasklists
/projects/api/v3/tasklists/{tasklistId}
| 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 |
| 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 |
| 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 | — |
200 OK
400 Bad Request
GET /projects/api/v3/tasklists/{tasklistId}
/projects/api/v3/projects/{projectId}/tasks.json
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:
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:
| 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 |
| 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. |
| 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. |
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
GET /projects/api/v3/projects/{projectId}/tasks.json
/projects/api/v3/reporting/precanned/plannedvsactual/tasks.csv
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.
| 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 |
| 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. |
| 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. |
| 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 |
| 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 |
| 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 |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.csv
/projects/api/v3/reporting/precanned/plannedvsactual/tasks.html
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.
| 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 |
| 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. |
| 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. |
| 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 |
| 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 |
| 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 |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.html
/projects/api/v3/reporting/precanned/plannedvsactual/tasks.pdf
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.
| 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 |
| 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. |
| 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. |
| 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 |
| 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 |
| 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 |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.pdf
/projects/api/v3/reporting/precanned/plannedvsactual/tasks.xlsx
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.
| 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 |
| 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. |
| 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. |
| 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 |
| 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 |
| 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 |
200 OK (no data)
400 Bad Request
GET /projects/api/v3/reporting/precanned/plannedvsactual/tasks.xlsx
/projects/api/v3/tasklists/{tasklistId}/tasks.json
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:
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:
| 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 |
| tasklistId | 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 |
| 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. |
| 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. |
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
GET /projects/api/v3/tasklists/{tasklistId}/tasks.json
/projects/api/v3/tasks.json
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:
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:
| 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 |
| 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. |
| 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. |
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
GET /projects/api/v3/tasks.json
/projects/api/v3/tasks/metrics/complete.json
Returns the total number of completed tasks. Only the tasks that the
logged-in user can access will be counted.
200 OK
400 Bad Request
GET /projects/api/v3/tasks/metrics/complete.json
/projects/api/v3/tasks/metrics/late.json
Returns the number of late tasks. Only the tasks that the logged-in user has
access to will be counted.
200 OK
400 Bad Request
GET /projects/api/v3/tasks/metrics/late.json
/projects/api/v3/tasks/{taskId}.json
Returns the information about a specific task.
On this endpoint you can filter by custom fields. The syntax for the
query parameter is the following:
customField[id][op]=value
Where:
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:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| taskId | path | required | integer | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/tasks/{taskId}.json
/projects/api/v3/tasks/{taskId}/subtasks.json
Return multiple subtasks according to the provided filter.
On this endpoint you can filter by custom fields. The syntax for the
query parameter is the following:
customField[id][op]=value
Where:
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:
| 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 |
| taskId | 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 |
| 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. |
| 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. |
| 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 |
| 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 |
| 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 |
200 OK
400 Bad Request
GET /projects/api/v3/tasks/{taskId}/subtasks.json
/projects/api/v3/allocations/{allocationId}/time.json
Return logged time entries for a specific allocation. Only the time entries that
the logged-in user can access will be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| startDate | query | optional | string | filter by a starting date |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | sort order |
| invoicedType | query | optional | string | filter by invoiced type |
| endDate | query | optional | string | filter by an ending date |
| billableType | query | optional | string | filter by billable type |
| updatedBy | query | optional | integer | filter by the user who updated the timelog |
| ticketId | query | optional | integer | filter by ticket id |
| tasklistId | query | optional | integer | filter by tasklist id |
| taskId | query | optional | integer | filter by task id (deprecated, use taskIds) |
| projectId | query | optional | integer | filter by project id (deprecated, use projectIds) |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| budgetId | query | optional | integer | filter by budget id |
| allocationId | path | required | integer | — |
| allocationId | query | optional | integer | filter by allocation id |
| unattachedTimelogs | query | optional | boolean | filter by timelogs that are directly logged against projects and not its child tasks |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllTaskTags | query | optional | boolean | match all task tags |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTotals | query | optional | boolean | include totals |
| includePermissions | query | optional | boolean | include permissions |
| includeDescendants | query | optional | boolean | include descendants |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| taskTagIds | query | optional | array | filter by task tag ids |
| taskIds | query | optional | array | filter by task ids |
| tagIds | query | optional | array | filter by tag ids |
| selectedColumns | query | optional | array | customise the report by selecting columns |
| projectsFromCompanyId | query | optional | array | filter by project company ids (deprecated, use projectCompanyIds) |
| 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 | filter by project healths 0: not set |
| projectCompanyIds | query | optional | array | filter by project company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[users] | query | optional | array | — |
| fields[timelogs] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[projectcategories] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| 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 |
| assignedTeamIds | query | optional | array | filter by assigned team ids |
200 OK
400 Bad Request
GET /projects/api/v3/allocations/{allocationId}/time.json
/projects/api/v3/companies/time.json
Return all logged time entries for all projects grouped by company ID.
Only the time entries that the logged-in user can access will be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| startDate | query | optional | string | filter by a starting date |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | sort order |
| invoicedType | query | optional | string | filter by invoiced type |
| endDate | query | optional | string | filter by an ending date |
| billableType | query | optional | string | filter by billable type |
| updatedBy | query | optional | integer | filter by the user who updated the timelog |
| ticketId | query | optional | integer | filter by ticket id |
| tasklistId | query | optional | integer | filter by tasklist id |
| taskId | query | optional | integer | filter by task id (deprecated, use taskIds) |
| projectId | query | optional | integer | filter by project id (deprecated, use projectIds) |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| budgetId | query | optional | integer | filter by budget id |
| allocationId | query | optional | integer | filter by allocation id |
| unattachedTimelogs | query | optional | boolean | filter by timelogs that are directly logged against projects and not its child tasks |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllTaskTags | query | optional | boolean | match all task tags |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTotals | query | optional | boolean | include totals |
| includePermissions | query | optional | boolean | include permissions |
| includeDescendants | query | optional | boolean | include descendants |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| taskTagIds | query | optional | array | filter by task tag ids |
| taskIds | query | optional | array | filter by task ids |
| tagIds | query | optional | array | filter by tag ids |
| selectedColumns | query | optional | array | customise the report by selecting columns |
| projectsFromCompanyId | query | optional | array | filter by project company ids (deprecated, use projectCompanyIds) |
| 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 | filter by project healths 0: not set |
| projectCompanyIds | query | optional | array | filter by project company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[users] | query | optional | array | — |
| fields[timelogs] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[projectcategories] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| 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 |
| assignedTeamIds | query | optional | array | filter by assigned team ids |
200 OK
400 Bad Request
GET /projects/api/v3/companies/time.json
/projects/api/v3/me/timers.json
Will get all your running timers or the person you are logged in as.
| 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 |
| userId | query | optional | integer | filter by user id |
| taskId | query | optional | integer | filter by task id |
| 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 |
| showDeleted | query | optional | boolean | include deleted items |
| runningTimersOnly | query | optional | boolean | enforce running timers only |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
| fields[timers] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
200 OK
400 Bad Request
GET /projects/api/v3/me/timers.json
/projects/api/v3/projects/{projectId}/time.json
Return logged time entries for a specific project. Only the time entries that
the logged-in user can access will be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| startDate | query | optional | string | filter by a starting date |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | sort order |
| invoicedType | query | optional | string | filter by invoiced type |
| endDate | query | optional | string | filter by an ending date |
| billableType | query | optional | string | filter by billable type |
| updatedBy | query | optional | integer | filter by the user who updated the timelog |
| ticketId | query | optional | integer | filter by ticket id |
| tasklistId | query | optional | integer | filter by tasklist id |
| taskId | query | optional | integer | filter by task id (deprecated, use taskIds) |
| projectId | path | required | integer | — |
| projectId | query | optional | integer | filter by project id (deprecated, use projectIds) |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| budgetId | query | optional | integer | filter by budget id |
| allocationId | query | optional | integer | filter by allocation id |
| unattachedTimelogs | query | optional | boolean | filter by timelogs that are directly logged against projects and not its child tasks |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllTaskTags | query | optional | boolean | match all task tags |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTotals | query | optional | boolean | include totals |
| includePermissions | query | optional | boolean | include permissions |
| includeDescendants | query | optional | boolean | include descendants |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| taskTagIds | query | optional | array | filter by task tag ids |
| taskIds | query | optional | array | filter by task ids |
| tagIds | query | optional | array | filter by tag ids |
| selectedColumns | query | optional | array | customise the report by selecting columns |
| projectsFromCompanyId | query | optional | array | filter by project company ids (deprecated, use projectCompanyIds) |
| 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 | filter by project healths 0: not set |
| projectCompanyIds | query | optional | array | filter by project company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[users] | query | optional | array | — |
| fields[timelogs] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[projectcategories] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| 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 |
| assignedTeamIds | query | optional | array | filter by assigned team ids |
200 OK
400 Bad Request
GET /projects/api/v3/projects/{projectId}/time.json
/projects/api/v3/projects/{projectId}/time/total.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after |
| startDate | query | optional | string | filter by a starting date |
| projectStatus | query | optional | string | filter by project status |
| endDate | query | optional | string | filter by an ending date |
| userId | query | optional | integer | filter by user id (deprecated, use assignedToUserIds) |
| tasklistId | query | optional | integer | filter by tasklist id |
| taskId | query | optional | integer | filter by task id (deprecated, use taskIds) |
| projectId | path | required | integer | — |
| projectId | query | optional | integer | filter by project id |
| deskTicketId | query | optional | integer | filter by desk ticket id |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| includeDescendants | query | optional | boolean | get subtask totals |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| userIds | query | optional | array | filter by user ids (deprecated, use assignedToUserIds) |
| taskIds | query | optional | array | filter by task ids |
| subTaskStatuses | query | optional | array | filter by sub-task status, includeDescendants must be set to true |
| 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 | filter by project healths 0: not set |
| projectCompanyIds | query | optional | array | filter by project company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| companyIds | query | optional | array | filter by company 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 |
| assignedTeamIds | query | optional | array | filter by assigned team ids |
200 OK
400 Bad Request
GET /projects/api/v3/projects/{projectId}/time/total.json
/projects/api/v3/reporting/precanned/companytime.json
Return all logged time entries for all projects grouped by company ID.
Only the time entries that the logged-in user can access will be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| startDate | query | optional | string | filter by a starting date |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | sort order |
| invoicedType | query | optional | string | filter by invoiced type |
| endDate | query | optional | string | filter by an ending date |
| billableType | query | optional | string | filter by billable type |
| updatedBy | query | optional | integer | filter by the user who updated the timelog |
| ticketId | query | optional | integer | filter by ticket id |
| tasklistId | query | optional | integer | filter by tasklist id |
| taskId | query | optional | integer | filter by task id (deprecated, use taskIds) |
| projectId | query | optional | integer | filter by project id (deprecated, use projectIds) |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| budgetId | query | optional | integer | filter by budget id |
| allocationId | query | optional | integer | filter by allocation id |
| unattachedTimelogs | query | optional | boolean | filter by timelogs that are directly logged against projects and not its child tasks |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllTaskTags | query | optional | boolean | match all task tags |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTotals | query | optional | boolean | include totals |
| includePermissions | query | optional | boolean | include permissions |
| includeDescendants | query | optional | boolean | include descendants |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| taskTagIds | query | optional | array | filter by task tag ids |
| taskIds | query | optional | array | filter by task ids |
| tagIds | query | optional | array | filter by tag ids |
| selectedColumns | query | optional | array | customise the report by selecting columns |
| projectsFromCompanyId | query | optional | array | filter by project company ids (deprecated, use projectCompanyIds) |
| 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 | filter by project healths 0: not set |
| projectCompanyIds | query | optional | array | filter by project company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[users] | query | optional | array | — |
| fields[timelogs] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[projectcategories] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| 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 |
| assignedTeamIds | query | optional | array | filter by assigned team ids |
200 OK
400 Bad Request
GET /projects/api/v3/reporting/precanned/companytime.json
/projects/api/v3/tasklists/{tasklistId}/time/total.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tasklistId | path | required | integer | — |
200 OK
400 Bad Request
GET /projects/api/v3/tasklists/{tasklistId}/time/total.json
/projects/api/v3/tasks/{taskId}/time.json
Return logged time entries for a specific task. Only the time entries that
the logged-in user can access will be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| startDate | query | optional | string | filter by a starting date |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | sort order |
| invoicedType | query | optional | string | filter by invoiced type |
| endDate | query | optional | string | filter by an ending date |
| billableType | query | optional | string | filter by billable type |
| updatedBy | query | optional | integer | filter by the user who updated the timelog |
| ticketId | query | optional | integer | filter by ticket id |
| tasklistId | query | optional | integer | filter by tasklist id |
| taskId | path | required | integer | — |
| taskId | query | optional | integer | filter by task id (deprecated, use taskIds) |
| projectId | query | optional | integer | filter by project id (deprecated, use projectIds) |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| budgetId | query | optional | integer | filter by budget id |
| allocationId | query | optional | integer | filter by allocation id |
| unattachedTimelogs | query | optional | boolean | filter by timelogs that are directly logged against projects and not its child tasks |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllTaskTags | query | optional | boolean | match all task tags |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTotals | query | optional | boolean | include totals |
| includePermissions | query | optional | boolean | include permissions |
| includeDescendants | query | optional | boolean | include descendants |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| taskTagIds | query | optional | array | filter by task tag ids |
| taskIds | query | optional | array | filter by task ids |
| tagIds | query | optional | array | filter by tag ids |
| selectedColumns | query | optional | array | customise the report by selecting columns |
| projectsFromCompanyId | query | optional | array | filter by project company ids (deprecated, use projectCompanyIds) |
| 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 | filter by project healths 0: not set |
| projectCompanyIds | query | optional | array | filter by project company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[users] | query | optional | array | — |
| fields[timelogs] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[projectcategories] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| 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 |
| assignedTeamIds | query | optional | array | filter by assigned team ids |
200 OK
400 Bad Request
GET /projects/api/v3/tasks/{taskId}/time.json
/projects/api/v3/tasks/{taskId}/time/total.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| taskId | path | required | integer | — |
200 OK
400 Bad Request
GET /projects/api/v3/tasks/{taskId}/time/total.json
/projects/api/v3/time.json
Return all logged time entries for all projects. Only the time entries that
the logged-in user can access will be returned.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after date |
| startDate | query | optional | string | filter by a starting date |
| reportFormat | query | optional | string | define the format of the report |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | sort order |
| invoicedType | query | optional | string | filter by invoiced type |
| endDate | query | optional | string | filter by an ending date |
| billableType | query | optional | string | filter by billable type |
| updatedBy | query | optional | integer | filter by the user who updated the timelog |
| ticketId | query | optional | integer | filter by ticket id |
| tasklistId | query | optional | integer | filter by tasklist id |
| taskId | query | optional | integer | filter by task id (deprecated, use taskIds) |
| projectId | query | optional | integer | filter by project id (deprecated, use projectIds) |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| budgetId | query | optional | integer | filter by budget id |
| allocationId | query | optional | integer | filter by allocation id |
| unattachedTimelogs | query | optional | boolean | filter by timelogs that are directly logged against projects and not its child tasks |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| showDeleted | query | optional | boolean | include deleted items |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllTaskTags | query | optional | boolean | match all task tags |
| matchAllTags | query | optional | boolean | match all tags |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| isReportDownload | query | optional | boolean | generate a report document |
| includeTotals | query | optional | boolean | include totals |
| includePermissions | query | optional | boolean | include permissions |
| includeDescendants | query | optional | boolean | include descendants |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| taskTagIds | query | optional | array | filter by task tag ids |
| taskIds | query | optional | array | filter by task ids |
| tagIds | query | optional | array | filter by tag ids |
| selectedColumns | query | optional | array | customise the report by selecting columns |
| projectsFromCompanyId | query | optional | array | filter by project company ids (deprecated, use projectCompanyIds) |
| 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 | filter by project healths 0: not set |
| projectCompanyIds | query | optional | array | filter by project company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| include | query | optional | array | include |
| ids | query | optional | array | filter by ids |
| fields[users] | query | optional | array | — |
| fields[timelogs] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[tags] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
| fields[projectcategories] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| 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 |
| assignedTeamIds | query | optional | array | filter by assigned team ids |
200 OK
400 Bad Request
GET /projects/api/v3/time.json
/projects/api/v3/time/total.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| updatedAfter | query | optional | string | filter by updated after |
| startDate | query | optional | string | filter by a starting date |
| projectStatus | query | optional | string | filter by project status |
| endDate | query | optional | string | filter by an ending date |
| userId | query | optional | integer | filter by user id (deprecated, use assignedToUserIds) |
| tasklistId | query | optional | integer | filter by tasklist id |
| taskId | query | optional | integer | filter by task id (deprecated, use taskIds) |
| projectId | query | optional | integer | filter by project id |
| deskTicketId | query | optional | integer | filter by desk ticket id |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllProjectTags | query | optional | boolean | match all project tags |
| includeDescendants | query | optional | boolean | get subtask totals |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| userIds | query | optional | array | filter by user ids (deprecated, use assignedToUserIds) |
| taskIds | query | optional | array | filter by task ids |
| subTaskStatuses | query | optional | array | filter by sub-task status, includeDescendants must be set to true |
| 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 | filter by project healths 0: not set |
| projectCompanyIds | query | optional | array | filter by project company ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| companyIds | query | optional | array | filter by company 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 |
| assignedTeamIds | query | optional | array | filter by assigned team ids |
200 OK
400 Bad Request
GET /projects/api/v3/time/total.json
/projects/api/v3/time/{timelogId}.json
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| timelogId | path | required | integer | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/time/{timelogId}.json
/projects/api/v3/timers.json
Brings back all current running timers. Will return a set of existing intervals for each timer.
If the timer has never been stopped then this interval will only have a from property set and
the you will need to calculate the current duration of the timer.
| 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 |
| userId | query | optional | integer | filter by user id |
| taskId | query | optional | integer | filter by task id |
| 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 |
| showDeleted | query | optional | boolean | include deleted items |
| runningTimersOnly | query | optional | boolean | enforce running timers only |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
| fields[timers] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
200 OK
400 Bad Request
GET /projects/api/v3/timers.json
/projects/api/v3/timers/{timerId}.json
Will get a timer with with a specific ID.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | query | optional | integer | filter by user id |
| timerId | path | required | integer | — |
| showDeleted | query | optional | boolean | filter by task id |
| include | query | optional | array | include |
| fields[users] | query | optional | array | — |
| fields[timers] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[projects] | query | optional | array | — |
200 OK
400 Bad Request
404 Not Found (no data)
GET /projects/api/v3/timers/{timerId}.json
/projects/api/v3/timesheets.json
Return a list of timesheet rows for the given user depending on param options.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| weekDate | query | optional | string | — |
| taskStatus | query | optional | string | filter by task status |
| startDate | query | optional | string | filter by a starting date, will default to the start of users work week. |
| searchTerm | query | optional | string | filter by tasks/projects/company names |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| invoicedType | query | optional | string | filter by invoiced type |
| endDate | query | optional | string | filter by an ending date, will default to the end of users work week. |
| billableType | query | optional | string | filter by billable type |
| userId | query | optional | integer | filter by user id, will default to session user |
| 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 |
| onlyStarredProjects | query | optional | boolean | filter by starred projects |
| isReportDownload | query | optional | boolean | generate a report export. |
| includeUnavailableTimes | query | optional | boolean | include users unavailable times field. |
| hasTimeLogged | query | optional | boolean | filter by tasks and projects that have time logged |
| assignedToTeams | query | optional | boolean | also include tasks that are assigned to teams |
| taskIds | query | optional | array | filter by task ids |
| tagIds | query | optional | array | filter by tag ids |
| projectStatuses | query | optional | array | filter by project statuses |
| projectIds | query | optional | array | filter by project ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| include | query | optional | array | include |
| excludeTimeframes | query | optional | array | exclude by time frames |
| companyIds | query | optional | array | filter by company ids |
200 OK
400 Bad Request
GET /projects/api/v3/timesheets.json
/projects/api/v3/timesheets/totals.json
Get the daily totals counts for all the user’s timesheets.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| weekDate | query | optional | string | — |
| taskStatus | query | optional | string | filter by task status |
| startDate | query | optional | string | filter by a starting date, will default to the start of users work week. |
| searchTerm | query | optional | string | filter by tasks/projects/company names |
| reportFormat | query | optional | string | define the format of the report |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| invoicedType | query | optional | string | filter by invoiced type |
| endDate | query | optional | string | filter by an ending date, will default to the end of users work week. |
| billableType | query | optional | string | filter by billable type |
| userId | query | optional | integer | filter by user id, will default to session user |
| 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 |
| onlyStarredProjects | query | optional | boolean | filter by starred projects |
| isReportDownload | query | optional | boolean | generate a report export. |
| includeUnavailableTimes | query | optional | boolean | include users unavailable times field. |
| hasTimeLogged | query | optional | boolean | filter by tasks and projects that have time logged |
| assignedToTeams | query | optional | boolean | also include tasks that are assigned to teams |
| taskIds | query | optional | array | filter by task ids |
| tagIds | query | optional | array | filter by tag ids |
| projectStatuses | query | optional | array | filter by project statuses |
| projectIds | query | optional | array | filter by project ids |
| projectCategoryIds | query | optional | array | filter by project category ids |
| include | query | optional | array | include |
| excludeTimeframes | query | optional | array | exclude by time frames |
| companyIds | query | optional | array | filter by company ids |
200 OK
400 Bad Request
GET /projects/api/v3/timesheets/totals.json
/projects/api/v3/workload/planners.json
Return the workload planner for each users of the installation.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| startDate | query | optional | string | define the start date of the planner |
| searchUserName | query | optional | string | filter by user name |
| searchTaskName | query | optional | string | filter by task name |
| projectStatus | query | optional | string | filter by project status |
| orderMode | query | optional | string | order mode |
| orderBy | query | optional | string | order by |
| endDate | query | optional | string | define the end date of the planner |
| pageSize | query | optional | integer | number of items in a page |
| page | query | optional | integer | page number |
| subtractLoggedTimeFromEstimates | query | optional | boolean | subtract logged time from task estimated time |
| skipCounts | query | optional | boolean | SkipCounts allows you to skip doing counts on a list API endpoint for |
| prorating | query | optional | boolean | include tasks that have the start and due dates outside the window range |
| onlyUntaggedTasks | query | optional | boolean | filter ony untagged tasks |
| onlyStarredProjects | query | optional | boolean | filter by starred projects only |
| matchAllProjectTags | query | optional | boolean | enforce all tag ids must be matched |
| includeTeamUserIds | query | optional | boolean | include team users to the responsible party ids |
| includeTasksWithoutDates | query | optional | boolean | include tasks without start or due date |
| includeCompletedTasks | query | optional | boolean | include completed tasks |
| includeCompanyUserIds | query | optional | boolean | include company users to the responsible party ids |
| includeCalendarEvents | query | optional | boolean | include calendar events on capacity calculation |
| includeAssigneeTeams | query | optional | boolean | include teams related to the responsible party ids |
| includeAssigneeCompanies | query | optional | boolean | include companies related to the responsible party ids |
| includeArchivedProjects | query | optional | boolean | include archived projects |
| distribute | query | optional | boolean | distribute the estimated time for a task between all the assignees |
| teamIds | query | optional | array | filter by member of team ids |
| tagIds | query | optional | array | filter by task tag ids |
| responsiblePartyIds | query | optional | array | filter by responsible party ids |
| 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 |
| 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 |
| memberOfProjectIds | query | optional | array | filter by member of project ids |
| include | query | optional | array | include |
| fields[workingHours] | query | optional | array | — |
| fields[workingHourEntries] | query | optional | array | — |
| fields[users] | query | optional | array | — |
| fields[timelogs] | query | optional | array | — |
| fields[tasks] | query | optional | array | — |
| fields[tasklists] | query | optional | array | — |
| fields[milestones] | query | optional | array | — |
| fields[companies] | query | optional | array | — |
| fields[calendarEvents] | query | optional | array | — |
| excludeTagIds | query | optional | array | filter by removing task tag ids |
| companyIds | query | optional | array | filter by user company id |
| assigneeTeamIds | query | optional | array | filter by assignee team ids |
| assigneeCompanyIds | query | optional | array | filter by assignee company ids |
200 OK
400 Bad Request
GET /projects/api/v3/workload/planners.json
active.ProjectMetricActive
{
"type": "object",
"title": "ProjectMetricActive",
"properties": {
"value": {
"type": "integer"
}
},
"description": "ProjectMetricActive contains all the information returned from a active."
}
active.Response
{
"type": "object",
"title": "Response",
"properties": {
"data": {
"$ref": "#/components/schemas/active.ProjectMetricActive"
}
},
"description": "Response contains information about a specific active."
}
activity.ActivitiesResponse
{
"type": "object",
"title": "ActivitiesResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
}
}
},
"activities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/activity.Activity"
}
}
},
"description": "ActivitiesResponse contains all the information returned when sending a GET\nrequest to the activity endpoint."
}
activity.Activity
{
"type": "object",
"title": "Activity",
"properties": {
"id": {
"type": "integer"
},
"item": {
"$ref": "#/components/schemas/view.Relationship"
},
"link": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/view.Relationship"
},
"itemId": {
"type": "integer"
},
"userId": {
"type": "integer"
},
"company": {
"$ref": "#/components/schemas/view.Relationship"
},
"dueDate": {
"type": "string"
},
"forUser": {
"$ref": "#/components/schemas/view.Relationship"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"dateTime": {
"type": "string"
},
"itemLink": {
"type": "string"
},
"lockdown": {
"$ref": "#/components/schemas/view.Relationship"
},
"companyId": {
"type": "integer"
},
"forUserId": {
"type": "integer"
},
"isPrivate": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"lockdownId": {
"type": "integer"
},
"publicInfo": {
"type": "string"
},
"description": {
"type": "string"
},
"forUserName": {
"type": "string"
},
"activityType": {
"type": "string"
},
"extraDescription": {
"type": "string"
},
"latestActivityType": {
"type": "string"
}
},
"description": "Activity represents a view of activity."
}
billable.ProjectMetricBillable
{
"type": "object",
"title": "ProjectMetricBillable",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"description": "ProjectMetricBillable contains all the information returned from a billable."
}
billable.ProjectMetricBillablesResponse
{
"type": "object",
"title": "ProjectMetricBillablesResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billable.ProjectMetricBillable"
}
}
},
"description": "ProjectMetricBillablesResponse contains information about a group of billables."
}
category.CategoriesResponse
{
"type": "object",
"title": "CategoriesResponse",
"properties": {
"projectCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.ProjectCategory"
}
},
"projectCategoryTotals": {
"$ref": "#/components/schemas/view.CategoryTotals"
}
},
"description": "CategoriesResponse contains information about a group of categories."
}
comment.CommentsResponse
{
"type": "object",
"title": "CommentsResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/comment.FullComment"
}
},
"included": {
"type": "object",
"properties": {
"files": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectFileV205"
}
},
"links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.LinkItem"
}
},
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskV205"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"notebooks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Notebook"
}
},
"milestones": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Milestone"
}
},
"fileversions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.FileversionV205"
}
}
}
}
},
"description": "CommentsResponse contains information about a group of comments."
}
comment.FullComment
{
"type": "object",
"title": "FullComment",
"properties": {
"id": {
"type": "integer"
},
"body": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/comment.Meta"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"object": {
"$ref": "#/components/schemas/view.Relationship"
},
"deleted": {
"type": "boolean"
},
"fileIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"htmlBody": {
"type": "string"
},
"objectId": {
"type": "integer"
},
"postedBy": {
"type": "integer"
},
"deletedBy": {
"type": "integer"
},
"fileCount": {
"type": "integer"
},
"isPrivate": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Reaction"
}
},
"lockdownID": {
"type": "integer"
},
"objectType": {
"type": "string"
},
"commentLink": {
"type": "string"
},
"contentType": {
"type": "string"
},
"dateDeleted": {
"type": "string"
},
"installation": {
"$ref": "#/components/schemas/view.Relationship"
},
"lastEditedBy": {
"type": "integer"
},
"dateLastEdited": {
"type": "string"
},
"installationId": {
"type": "integer"
},
"postedByUserId": {
"type": "integer"
},
"postedDateTime": {
"type": "string"
},
"reactionsCount": {
"type": "integer"
},
"deletedByUserId": {
"type": "integer"
},
"lastEditedByUserId": {
"type": "integer"
},
"peopleNotifiedCount": {
"type": "integer"
}
},
"description": "FullComment contains the full information for a comment"
}
comment.Meta
{
"type": "object",
"title": "Meta",
"properties": {
"isRead": {
"type": "boolean"
},
"permissions": {
"$ref": "#/components/schemas/comment.Permissions"
}
},
"description": "Meta contains metadata for a comment, such as permissions"
}
comment.Permissions
{
"type": "object",
"title": "Permissions",
"properties": {
"canEdit": {
"type": "boolean"
},
"canDelete": {
"type": "boolean"
}
},
"description": "Permissions are the permissions the user has for the comment"
}
company.CompaniesResponse
{
"type": "object",
"title": "CompaniesResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"letters": {
"type": "array",
"items": {
"type": "string"
}
},
"included": {
"type": "object",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"updates": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CompanyUpdate"
}
},
"countries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Country"
}
},
"industries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Industry"
}
},
"customfields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomField"
}
},
"customfieldCompanies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomFieldValueCompany"
}
}
}
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Company"
}
}
},
"description": "CompaniesResponse contains information about a group of companies."
}
company.Company
{
"type": "object",
"title": "Company",
"properties": {
"cid": {
"type": "string"
},
"fax": {
"type": "string"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"name": {
"type": "string"
},
"phone": {
"type": "string"
},
"state": {
"type": "string"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"profile": {
"type": "string"
},
"website": {
"type": "string"
},
"emailOne": {
"type": "string"
},
"emailTwo": {
"type": "string"
},
"addressOne": {
"type": "string"
},
"addressTwo": {
"type": "string"
},
"emailThree": {
"type": "string"
},
"countrycode": {
"type": "string"
},
"customFields": {
"$ref": "#/components/schemas/company.CustomFields"
},
"privateNotes": {
"type": "string"
},
"industryCatId": {
"type": "integer"
},
"clientManagedBy": {
"type": "integer"
},
"logoPendingFileRef": {
"type": "string"
}
},
"description": "Company contains all the information returned from a company."
}
company.CustomFields
{
"type": "object",
"title": "CustomFields",
"properties": {
"Values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/value.CustomFieldValue"
}
}
},
"description": "CustomFields is the custom fields type."
}
company.Request
{
"type": "object",
"title": "Request",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tag.Tag"
}
},
"company": {
"$ref": "#/components/schemas/company.Company"
},
"companyOptions": {
"type": "object",
"properties": {
"fireWebhook": {
"type": "boolean"
},
"logActivity": {
"type": "boolean"
},
"useNotifyViaTWIM": {
"type": "boolean"
}
}
}
},
"description": "Request contains information of a company to be created or updated."
}
company.Response
{
"type": "object",
"title": "Response",
"properties": {
"company": {
"$ref": "#/components/schemas/view.Company"
},
"included": {
"type": "object",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"updates": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CompanyUpdate"
}
},
"countries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Country"
}
},
"industries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Industry"
}
},
"customfields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomField"
}
},
"customfieldCompanies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomFieldValueCompany"
}
}
}
}
},
"description": "Response contains information about a specific company."
}
complete.Response
{
"type": "object",
"title": "Response",
"properties": {
"data": {
"$ref": "#/components/schemas/complete.TaskMetricComplete"
}
},
"description": "Response contains information about a specific complete."
}
complete.TaskMetricComplete
{
"type": "object",
"title": "TaskMetricComplete",
"properties": {
"value": {
"type": "integer"
}
},
"description": "TaskMetricComplete contains all the information returned from a complete."
}
customfield.BulkDeleteRequest
{
"type": "object",
"title": "BulkDeleteRequest",
"properties": {
"customfieldIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"description": "BulkDeleteRequest contains the ids of the custom fields that should be\nremoved."
}
customfield.CustomField
{
"type": "object",
"title": "CustomField",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"entity": {
"type": "string",
"description": "using a verbose name to avoid conflict"
},
"formula": {
"type": "string"
},
"groupId": {
"type": "integer"
},
"options": {},
"privacy": {
"$ref": "#/components/schemas/payload.UserGroups"
},
"required": {
"type": "boolean"
},
"isPrivate": {
"type": "boolean"
},
"projectId": {
"type": "integer"
},
"description": {
"type": "string"
},
"currencyCode": {
"type": "string"
},
"visibilities": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "CustomField contains all the information returned from a custom field."
}
customfield.CustomFieldsResponse
{
"type": "object",
"title": "CustomFieldsResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
}
}
},
"customfields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.CustomField"
}
}
},
"description": "CustomFieldsResponse contains information about a group of custom fields."
}
customfield.Request
{
"type": "object",
"title": "Request",
"properties": {
"customfield": {
"$ref": "#/components/schemas/customfield.CustomField"
}
},
"description": "Request contains information of a custom field to be created or updated."
}
customfield.Response
{
"type": "object",
"title": "Response",
"properties": {
"count": {
"type": "integer"
},
"customfield": {
"$ref": "#/components/schemas/view.CustomField"
}
},
"description": "Response contains information about a specific customfield."
}
dashboard.UserDashboardsResponse
{
"type": "object",
"title": "UserDashboardsResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"dashboardPanels": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.UserDashboardPanel"
}
},
"dashboardSettings": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.UserDashboardSetting"
}
},
"dashboardPanelSettings": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.UserDashboardPanelSetting"
}
}
}
},
"dashboards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.UserDashboard"
}
}
},
"description": "UserDashboardsResponse contains information about a group of dashboards."
}
deadline.MilestoneMetricDeadline
{
"type": "object",
"title": "MilestoneMetricDeadline",
"properties": {
"date": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"description": "MilestoneMetricDeadline contains all the information returned from a deadline."
}
deadline.MilestoneMetricDeadlinesResponse
{
"type": "object",
"title": "MilestoneMetricDeadlinesResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/deadline.MilestoneMetricDeadline"
}
}
},
"description": "MilestoneMetricDeadlinesResponse contains information about a group of deadlines."
}
entity.ProjectBudgetRange
{
"type": "object",
"title": "ProjectBudgetRange",
"properties": {
"to": {
"type": "integer"
},
"from": {
"type": "integer"
},
"count": {
"type": "integer"
},
"companyId": {
"type": "integer"
}
},
"description": "ProjectBudgetRange is a distribution item type."
}
form.Banner
{
"type": "object",
"title": "Banner",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"url": {
"type": "string"
},
"accentColor": {
"type": "string"
},
"primaryColor": {
"type": "string"
}
},
"description": "Banner contains information of a form banner to be created or updated."
}
form.Content
{
"type": "object",
"title": "Content",
"properties": {
"logo": {
"$ref": "#/components/schemas/form.Logo"
},
"name": {
"type": "string"
},
"state": {
"type": "string"
},
"banner": {
"$ref": "#/components/schemas/form.Banner"
},
"definition": {
"type": "string"
},
"description": {
"type": "string"
},
"pendingLogoId": {
"type": "string"
},
"pendingBannerId": {
"type": "string"
}
},
"description": "Content contains information of a form content to be created or updated."
}
form.CopyForm
{
"type": "object",
"title": "CopyForm",
"properties": {
"title": {
"type": "string"
},
"hostObject": {
"$ref": "#/components/schemas/form.HostObject"
},
"projectIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"copyAssignees": {
"type": "boolean"
},
"generateToken": {
"type": "boolean"
}
},
"description": "CopyForm contains information on where and what to copy from a form"
}
form.CopyRequest
{
"type": "object",
"title": "CopyRequest",
"properties": {
"form": {
"$ref": "#/components/schemas/form.CopyForm"
}
},
"description": "CopyRequest outter request for copying a form"
}
form.DestinationObject
{
"type": "object",
"title": "DestinationObject",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"description": "DestinationObject contains information of a form destination object to be created or updated."
}
form.Form
{
"type": "object",
"title": "Form",
"properties": {
"content": {
"$ref": "#/components/schemas/form.Content"
},
"hostObject": {
"$ref": "#/components/schemas/form.HostObject"
},
"redirectUrl": {
"type": "string"
},
"primaryColor": {
"type": "string"
},
"submitButtonText": {
"type": "string"
},
"taskTitleFieldId": {
"type": "string"
},
"destinationObject": {
"$ref": "#/components/schemas/form.DestinationObject"
},
"confirmationMessage": {
"type": "string"
},
"responseEmailFieldId": {
"type": "string"
},
"allowTeamworkBranding": {
"type": "boolean"
},
"promptAdditionalSubmissions": {
"type": "boolean"
}
},
"description": "Form contains information of a form to be created or updated."
}
form.FormsResponse
{
"type": "object",
"title": "FormsResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"forms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Form"
}
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"tasklists": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tasklist"
}
}
}
}
},
"description": "FormsResponse contains information about a group of forms."
}
form.HostObject
{
"type": "object",
"title": "HostObject",
"properties": {
"id": {
"type": "integer"
},
"meta": {
"$ref": "#/components/schemas/form.HostObjectMeta"
},
"type": {
"type": "string"
}
},
"description": "HostObject contains information of a form host object to be created or updated."
}
form.HostObjectMeta
{
"type": "object",
"title": "HostObjectMeta",
"properties": {
"tasklistId": {
"type": "integer"
}
},
"description": "HostObjectMeta contains information of a form host object meta to be created or updated."
}
form.Logo
{
"type": "object",
"title": "Logo",
"properties": {
"url": {
"type": "string"
}
},
"description": "Logo contains information of a form custom logo to be created or updated."
}
form.PublicResponse
{
"type": "object",
"title": "PublicResponse",
"properties": {
"form": {
"$ref": "#/components/schemas/view.PublicForm"
}
},
"description": "PublicResponse contains information about a specific public form."
}
form.Request
{
"type": "object",
"title": "Request",
"properties": {
"form": {
"$ref": "#/components/schemas/form.Form"
}
},
"description": "Request contains information of a form to be created or updated."
}
form.Response
{
"type": "object",
"title": "Response",
"properties": {
"form": {
"$ref": "#/components/schemas/view.Form"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"tasklists": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tasklist"
}
}
}
}
},
"description": "Response contains information about a specific form."
}
health.ProjectMetricHealth
{
"type": "object",
"title": "ProjectMetricHealth",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"description": "ProjectMetricHealth stores a specific health counter."
}
health.ProjectMetricHealthsResponse
{
"type": "object",
"title": "ProjectMetricHealthsResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/health.ProjectMetricHealth"
}
}
},
"description": "ProjectMetricHealthsResponse contains information about a group of healths.\nFollowing this format to satisfy the Numerics integration."
}
importer.Importer
{
"type": "object",
"title": "Importer",
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"running": {
"type": "boolean"
}
},
"description": "Importer single importer for response."
}
importer.ImportersResponse
{
"type": "object",
"title": "ImportersResponse",
"properties": {
"importers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/importer.Importer"
}
},
"isImporting": {
"type": "boolean"
}
},
"description": "ImportersResponse contains information about a group of importers."
}
invoice.ProjectMetricInvoicesResponse
{
"type": "object",
"title": "ProjectMetricInvoicesResponse",
"properties": {
"data": {
"type": "object",
"properties": {
"value": {
"type": "integer"
}
}
}
},
"description": "ProjectMetricInvoicesResponse contains information about a group of invoices."
}
late.Response
{
"type": "object",
"title": "Response",
"properties": {
"data": {
"$ref": "#/components/schemas/late.TaskMetricLate"
}
},
"description": "Response contains the count of late tasks.\nFollowing this format to satisfy the Numerics integration."
}
late.TaskMetricLate
{
"type": "object",
"title": "TaskMetricLate",
"properties": {
"value": {
"type": "integer"
}
},
"description": "TaskMetricLate contains count information about late tasks."
}
message.MessagesResponse
{
"type": "object",
"title": "MessagesResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"Included": {
"$ref": "#/components/schemas/messagereply.Included"
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"messageReplies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.MessageReply"
}
}
}
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Message"
}
}
},
"description": "MessagesResponse contains all the information returned when sending a GET\nrequest to the message endpoint."
}
message.Request
{
"type": "object",
"title": "Request",
"properties": {
"read": {
"type": "boolean"
}
},
"description": "Request contains information of a message to be created or updated."
}
message.Response
{
"type": "object",
"title": "Response",
"properties": {
"message": {
"$ref": "#/components/schemas/view.Message"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"Included": {
"$ref": "#/components/schemas/messagereply.Included"
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"messageReplies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.MessageReply"
}
}
}
}
},
"description": "Response contains information about a specific message."
}
| Version | Endpoints | Schemas | Ingested | Status |
|---|---|---|---|---|
| 3.0 | 188 | 296 | 2026-05-11 | current |
| 3.0 | 188 | 296 | 2026-04-16 |