getProjectsReportingUtilization

Generate detailed utilization reports in CSV, HTML, PDF, or XLSX formats. Filter by date, user, team, or project to analyze resource allocation and productivity for accessible personnel within Teamwork MCP.

Instructions

Generate utilization report in various formats (CSV, HTML, PDF, XLSX). Generates a utilization report containing all people for the provided filters. Only the people that the logged-in user can access will be returned.

Input Schema

Name	Required	Description
`IncludeCompletedTasks`	No	include completed tasks
`companyIds`	No	filter by company ids
`endDate`	No	filter by end date
`fieldsUsers`	No	Query parameter: fields[users]
`fieldsUtilizations`	No	Query parameter: fields[utilizations]
`format`	Yes	The format of the report
`groupBy`	No	group by
`include`	No	include
`includeArchivedProjects`	No	include archived projects
`includeClients`	No	include client users
`includeCollaborators`	No	include collaborators
`includeTotals`	No	adds report summary to response
`includeUtilizations`	No	adds report rows for individual entities
`isCustomDateRange`	No	determine if the query is for a custom date range
`isReportDownload`	No	generate a report document
`jobRoleIds`	No	filter by jobrole ids
`legacyResponse`	No	return response without summary and its legacy body structure
`orderBy`	No	sort by
`orderMode`	No	group by
`page`	No	page number
`pageSize`	No	number of items in a page
`projectIds`	No	filter by project ids
`reportFormat`	No	define the format of the report
`searchTerm`	No	filter by user first or last name
`selectedColumns`	No	customise the report by selecting columns to be displayed.
`skipCounts`	No	SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
`sort`	No	sort by (deprecated, use orderBy)
`sortOrder`	No	order mode
`startDate`	No	filter by start date
`teamIds`	No	filter by team ids
`userIds`	No	filter by userIds
`zoom`	No	determine the type of zoom filter used to display on the report

Input Schema (JSON Schema)

{
  "properties": {
    "IncludeCompletedTasks": {
      "description": "include completed tasks",
      "type": "boolean"
    },
    "companyIds": {
      "description": "filter by company ids",
      "type": "array"
    },
    "endDate": {
      "description": "filter by end date",
      "type": "string"
    },
    "fieldsUsers": {
      "description": "Query parameter: fields[users]",
      "type": "array"
    },
    "fieldsUtilizations": {
      "description": "Query parameter: fields[utilizations]",
      "type": "array"
    },
    "format": {
      "description": "The format of the report",
      "enum": [
        "csv",
        "html",
        "pdf",
        "xlsx"
      ],
      "type": "string"
    },
    "groupBy": {
      "description": "group by",
      "enum": [
        "day",
        "week",
        "month"
      ],
      "type": "string"
    },
    "include": {
      "description": "include",
      "type": "array"
    },
    "includeArchivedProjects": {
      "description": "include archived projects",
      "type": "boolean"
    },
    "includeClients": {
      "description": "include client users",
      "type": "boolean"
    },
    "includeCollaborators": {
      "description": "include collaborators",
      "type": "boolean"
    },
    "includeTotals": {
      "description": "adds report summary to response",
      "type": "boolean"
    },
    "includeUtilizations": {
      "description": "adds report rows for individual entities",
      "type": "boolean"
    },
    "isCustomDateRange": {
      "description": "determine if the query is for a custom date range",
      "type": "boolean"
    },
    "isReportDownload": {
      "description": "generate a report document",
      "type": "boolean"
    },
    "jobRoleIds": {
      "description": "filter by jobrole ids",
      "type": "array"
    },
    "legacyResponse": {
      "description": "return response without summary and its legacy body structure",
      "type": "boolean"
    },
    "orderBy": {
      "description": "sort by",
      "enum": [
        "name",
        "percentutilization",
        "percentestimatedutilization",
        "availableminutes",
        "unavailableminutes",
        "loggedminutes",
        "billableminutes",
        "unbillableminutes",
        "companycount",
        "achieved",
        "target",
        "allocatedutilization",
        "totalworkingminutes",
        "availableutilization",
        "unavailableutilization"
      ],
      "type": "string"
    },
    "orderMode": {
      "description": "group by",
      "enum": [
        "weekly",
        "monthly"
      ],
      "type": "string"
    },
    "page": {
      "description": "page number",
      "type": "integer"
    },
    "pageSize": {
      "description": "number of items in a page",
      "type": "integer"
    },
    "projectIds": {
      "description": "filter by project ids",
      "type": "array"
    },
    "reportFormat": {
      "description": "define the format of the report",
      "enum": [
        "pdf"
      ],
      "type": "string"
    },
    "searchTerm": {
      "description": "filter by user first or last name",
      "type": "string"
    },
    "selectedColumns": {
      "description": "customise the report by selecting columns to be displayed.",
      "type": "array"
    },
    "skipCounts": {
      "description": "SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.",
      "type": "boolean"
    },
    "sort": {
      "description": "sort by (deprecated, use orderBy)",
      "enum": [
        "name",
        "percentutilization",
        "percentestimatedutilization",
        "availableminutes",
        "unavailableminutes",
        "loggedminutes",
        "billableminutes",
        "unbillableminutes",
        "billableutilization",
        "nonbillableutilization"
      ],
      "type": "string"
    },
    "sortOrder": {
      "description": "order mode",
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string"
    },
    "startDate": {
      "description": "filter by start date",
      "type": "string"
    },
    "teamIds": {
      "description": "filter by team ids",
      "type": "array"
    },
    "userIds": {
      "description": "filter by userIds",
      "type": "array"
    },
    "zoom": {
      "description": "determine the type of zoom filter used to display on the report",
      "enum": [
        "week",
        "month",
        "last3months",
        "quarterbyweek",
        "quarterbymonth"
      ],
      "type": "string"
    }
  },
  "required": [
    "format"
  ],
  "type": "object"
}

Teamwork MCP

getProjectsReportingUtilization

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Teamwork MCP

Related Tools

MCP directory API