API Docs / Operations / Reports / Get Team Workload Report

Get Team Workload Report

GET /tenants/{tenant}/reports/team-workload

Who's overloaded and who completes what: the open-workload snapshot per assignee (open, overdue, blocked) plus completion throughput over the window (completions, average turnaround, on-time rate). Group by user (completions attributed to who completed the task) or team.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

dateRange query string

Preset date range for the completion window (default Last30Days). If CustomDateRange, startDate and endDate are required. Open-workload counts are always a now snapshot.

Preset date range for the completion window (default Last30Days). If CustomDateRange, startDate and endDate are required. Open-workload counts are always a now snapshot.

startDate query string

Completion window start (inclusive). Only valid when dateRange=CustomDateRange

Completion window start (inclusive). Only valid when dateRange=CustomDateRange

endDate query string

Completion window end (inclusive). Only valid when dateRange=CustomDateRange

Completion window end (inclusive). Only valid when dateRange=CustomDateRange

groupBy query string

Breakdown dimension: User (default) or Team

Breakdown dimension: User (default) or Team

service query array

Filter by billable service code(s) - can specify multiple

Filter by billable service code(s) - can specify multiple

client query array

Filter by client code(s) - can specify multiple

Filter by client code(s) - can specify multiple

category query array

Filter by task category code(s) - can specify multiple

Filter by task category code(s) - can specify multiple

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key