Teamwork

Links

    Teamwork API

    Getting access, Developing, Testing

    Back to Teamwork

    Return the user utilization.

    Verify the user utilization.

    Input

    type: object properties: parameters: type: object properties: zoom: type: string enum: - week - month - last3months - quarterbyweek - quarterbymonth description: determine the type of zoom filter used to display on the report startDate: type: string format: date description: filter by start date sortOrder: type: string enum: - asc - desc default: asc description: order mode sort: type: string enum: - name - percentutilization - percentestimatedutilization - availableminutes - unavailableminutes - loggedminutes - billableminutes - unbillableminutes - billableutilization - nonbillableutilization default: name description: sort by (deprecated, use orderBy) searchTerm: type: string description: filter by user first or last name reportFormat: type: string enum: - pdf default: pdf description: define the format of the report orderMode: type: string enum: - weekly - monthly description: group by orderBy: type: string enum: - name - percentutilization - percentestimatedutilization - availableminutes - unavailableminutes - loggedminutes - billableminutes - unbillableminutes default: name description: sort by groupBy: type: string enum: - weekly - monthly description: group by endDate: type: string format: date description: filter by end date pageSize: type: integer default: '50' description: number of items in a page page: type: integer default: '1' description: page number isReportDownload: type: boolean default: 'false' description: generate a report document isCustomDateRange: type: boolean description: determine if the query is for a custom date range includeCollaborators: type: boolean default: 'true' description: include collaborators includeClients: type: boolean default: 'true' description: include client users userIds: type: array items: type: integer description: filter by userIds teamIds: type: array items: type: integer description: filter by team ids selectedColumns: type: array items: type: string description: customise the report by selecting columns to be displayed. projectIds: type: array items: type: integer description: filter by project ids include: type: array items: enum: - users type: string description: include fields[utilizations]: type: array items: enum: - userId - unavailableMinutes - availableMinutes - billableMinutes - unbillableMinutes - loggedMinutes type: string fields[users]: type: array items: enum: - id - firstName - lastName - title - email - companyId - company - isAdmin - isClientUser - isServiceAccount - type - deleted - avatarUrl - lengthOfDay - workingHoursId - workingHour - userRate - userCost - canAddProjects type: string companyIds: type: array items: type: integer description: filter by company ids title: Parameters

    Output

    type: object title: Response properties: included: type: object properties: users: type: object meta: type: object title: Meta properties: averageSpend: type: integer limit: type: integer nextCursor: type: string page: type: object title: MetaPage properties: count: type: integer hasMore: type: boolean pageOffset: type: integer pageSize: type: integer prevCursor: type: string totalCapacity: type: integer utilization: type: array items: type: object title: UserUtilization properties: data: type: array items: type: object title: UserUtilizationData properties: allocatedMinutes: type: integer availableMinutes: type: integer billableMinutes: type: integer endDate: type: object title: Date estimatedMinutes: type: integer loggedMinutes: type: integer startDate: type: object title: Date unavailableMinutes: type: integer unbillableMinutes: type: integer user: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string userId: type: integer