getProjects
Fetch and filter Teamwork projects by date, type, status, or custom criteria. Generate detailed reports in multiple formats and organize projects by various fields for streamlined project management.
Instructions
Get all projects from Teamwork
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| includeArchivedProjects | No | Include archived projects | |
| includeCompletedProjects | No | Include completed projects | |
| includeProjectBillingMethod | No | Include project billing method | |
| includeProjectBudget | No | Include project budget | |
| includeProjectCategory | No | Include project category | |
| includeProjectCompany | No | Include project company | |
| includeProjectCreator | No | Include project creator | |
| includeProjectCustomFields | No | Include project custom fields | |
| includeProjectHealth | No | Include project health | |
| includeProjectOwner | No | Include project owner | |
| includeProjectProfitability | No | Include project profitability | |
| includeProjectRateCardCurrencies | No | Include project rate card currencies | |
| includeProjectRateCardRates | No | Include project rate card rates | |
| includeProjectRateCardTaskCurrencies | No | Include project rate card task currencies | |
| includeProjectRateCardTaskRates | No | Include project rate card task rates | |
| includeProjectRateCardTasks | No | Include project rate card tasks | |
| includeProjectRateCardUserCurrencies | No | Include project rate card user currencies | |
| includeProjectRateCardUserRates | No | Include project rate card user rates | |
| includeProjectRateCardUsers | No | Include project rate card users | |
| includeProjectRateCards | No | Include project rate cards | |
| includeProjectStatus | No | Include project status | |
| includeProjectTags | No | Include project tags | |
| maxBudgetCapacityUsedPercent | No | Filter by maximum budget capacity used | |
| maxLastActivityDate | No | Filter by max last activity date (format: YYYY-MM-DD) | |
| minBudgetCapacityUsedPercent | No | Filter by minimum budget capacity used | |
| minLastActivityDate | No | Filter by min last activity date (format: YYYY-MM-DD) | |
| notCompletedBefore | No | Filter by projects that have not been completed before the given date (format: YYYY-MM-DD) | |
| orderBy | No | Order by field | |
| orderByCustomFieldId | No | Order by custom field id when orderBy is equal to customfield | |
| orderMode | No | Order mode | |
| page | No | Page number (not used when generating reports) | |
| pageSize | No | Number of items in a page (not used when generating reports) | |
| projectType | No | Filter by project type | |
| reportFormat | No | Define the format of the report | |
| reportTimezone | No | Configure the report dates displayed in a timezone | |
| reportType | No | Define the type of the report | |
| searchTerm | No | Filter by project name | |
| timeMode | No | Profitability time mode | |
| updatedAfter | No | Filter projects updated after this date-time (format: ISO 8601) | |
| userId | No | Filter by user id |
Input Schema (JSON Schema)
{
"properties": {
"includeArchivedProjects": {
"description": "Include archived projects",
"type": "boolean"
},
"includeCompletedProjects": {
"description": "Include completed projects",
"type": "boolean"
},
"includeProjectBillingMethod": {
"description": "Include project billing method",
"type": "boolean"
},
"includeProjectBudget": {
"description": "Include project budget",
"type": "boolean"
},
"includeProjectCategory": {
"description": "Include project category",
"type": "boolean"
},
"includeProjectCompany": {
"description": "Include project company",
"type": "boolean"
},
"includeProjectCreator": {
"description": "Include project creator",
"type": "boolean"
},
"includeProjectCustomFields": {
"description": "Include project custom fields",
"type": "boolean"
},
"includeProjectHealth": {
"description": "Include project health",
"type": "boolean"
},
"includeProjectOwner": {
"description": "Include project owner",
"type": "boolean"
},
"includeProjectProfitability": {
"description": "Include project profitability",
"type": "boolean"
},
"includeProjectRateCardCurrencies": {
"description": "Include project rate card currencies",
"type": "boolean"
},
"includeProjectRateCardRates": {
"description": "Include project rate card rates",
"type": "boolean"
},
"includeProjectRateCardTaskCurrencies": {
"description": "Include project rate card task currencies",
"type": "boolean"
},
"includeProjectRateCardTaskRates": {
"description": "Include project rate card task rates",
"type": "boolean"
},
"includeProjectRateCardTasks": {
"description": "Include project rate card tasks",
"type": "boolean"
},
"includeProjectRateCardUserCurrencies": {
"description": "Include project rate card user currencies",
"type": "boolean"
},
"includeProjectRateCardUserRates": {
"description": "Include project rate card user rates",
"type": "boolean"
},
"includeProjectRateCardUsers": {
"description": "Include project rate card users",
"type": "boolean"
},
"includeProjectRateCards": {
"description": "Include project rate cards",
"type": "boolean"
},
"includeProjectStatus": {
"description": "Include project status",
"type": "boolean"
},
"includeProjectTags": {
"description": "Include project tags",
"type": "boolean"
},
"maxBudgetCapacityUsedPercent": {
"description": "Filter by maximum budget capacity used",
"type": "integer"
},
"maxLastActivityDate": {
"description": "Filter by max last activity date (format: YYYY-MM-DD)",
"type": "string"
},
"minBudgetCapacityUsedPercent": {
"description": "Filter by minimum budget capacity used",
"type": "integer"
},
"minLastActivityDate": {
"description": "Filter by min last activity date (format: YYYY-MM-DD)",
"type": "string"
},
"notCompletedBefore": {
"description": "Filter by projects that have not been completed before the given date (format: YYYY-MM-DD)",
"type": "string"
},
"orderBy": {
"description": "Order by field",
"enum": [
"companyname",
"datecreated",
"duedate",
"lastactivity",
"name",
"namecaseinsensitive",
"ownercompany",
"starred",
"categoryname"
],
"type": "string"
},
"orderByCustomFieldId": {
"description": "Order by custom field id when orderBy is equal to customfield",
"type": "integer"
},
"orderMode": {
"description": "Order mode",
"enum": [
"asc",
"desc"
],
"type": "string"
},
"page": {
"description": "Page number (not used when generating reports)",
"type": "integer"
},
"pageSize": {
"description": "Number of items in a page (not used when generating reports)",
"type": "integer"
},
"projectType": {
"description": "Filter by project type",
"type": "string"
},
"reportFormat": {
"description": "Define the format of the report",
"enum": [
"csv",
"html",
"pdf",
"xls"
],
"type": "string"
},
"reportTimezone": {
"description": "Configure the report dates displayed in a timezone",
"type": "string"
},
"reportType": {
"description": "Define the type of the report",
"enum": [
"project",
"health"
],
"type": "string"
},
"searchTerm": {
"description": "Filter by project name",
"type": "string"
},
"timeMode": {
"description": "Profitability time mode",
"enum": [
"timelogs",
"estimated"
],
"type": "string"
},
"updatedAfter": {
"description": "Filter projects updated after this date-time (format: ISO 8601)",
"type": "string"
},
"userId": {
"description": "Filter by user id",
"type": "integer"
}
},
"type": "object"
}