Skip to main content
POST
Task Count by Status
Returns task counts grouped by task status. Filter fields are optional and supplied at the top level of the body; an empty body ({}) counts all tasks. The Open bucket additionally carries a week-over-week creation trend. Requires the CAN_VIEW_REPORTING permission (inherited from the key’s default user).

Authorizations

x-client-key
string
header
required
x-client-secret
string
header
required

Body

application/json
fromDate
string<date-time>

Start of the task date range.

toDate
string<date-time>

End of the task date range.

assignees
string[]

Assignee UUIDs (user, team, role, or location IDs). Use "unassigned" to include unassigned tasks.

createdBy
string<uuid>[]
completedBy
string<uuid>[]
taskStatuses
string[]

Task statuses to include, e.g. "Open", "In Progress", "Completed", "Missed".

locations
string<uuid>[]
priorities
string[]
categories
string<uuid>[]

Category (ServiceType) UUIDs.

dueFilter
object

Due-date filter. Provide one of the boolean flags or a dates range.

Response

Task counts by status retrieved successfully. Each status maps to an object with a count; the Open bucket also carries a trend.