GET/projects/api/v3/people/utilization.json

Return the user utilization.

Verify the user utilization.

Query Params

  • Name
    zoom
    Type
    string
    Description

    determine the type of zoom filter used to display on the report

    Allowed values
    • week
    • month
    • last3months
    • quarterbyweek
    • quarterbymonth
  • Name
    startDate
    Type
    string
    Description

    filter by start date

  • Name
    sortOrder
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    sort
    Type
    string
    Description

    sort by (deprecated, use orderBy)

    Default
    name
    Allowed values
    • name
    • percentutilization
    • percentestimatedutilization
    • availableminutes
    • unavailableminutes
    • loggedminutes
    • billableminutes
    • unbillableminutes
    • billableutilization
    • nonbillableutilization
  • Name
    searchTerm
    Type
    string
    Description

    filter by user first or last name

  • Name
    reportFormat
    Type
    string
    Description

    define the format of the report

    Default
    pdf
    Allowed values
    • pdf
  • Name
    orderMode
    Type
    string
    Description

    group by

    Allowed values
    • weekly
    • monthly
  • Name
    orderBy
    Type
    string
    Description

    sort by

    Default
    name
    Allowed values
    • name
    • percentutilization
    • percentestimatedutilization
    • availableminutes
    • unavailableminutes
    • loggedminutes
    • billableminutes
    • unbillableminutes
    • companycount
    • achieved
    • target
    • allocatedutilization
    • totalworkingminutes
    • availableutilization
    • unavailableutilization
  • Name
    groupBy
    Type
    string
    Description

    group by

    Allowed values
    • week
    • month
  • Name
    endDate
    Type
    string
    Description

    filter by end date

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    isReportDownload
    Type
    boolean
    Description

    generate a report document

    Default
    false
  • Name
    isCustomDateRange
    Type
    boolean
    Description

    determine if the query is for a custom date range

  • Name
    includeCollaborators
    Type
    boolean
    Description

    include collaborators

    Default
    true
  • Name
    includeClients
    Type
    boolean
    Description

    include client users

    Default
    true
  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

    Default
    false
  • Name
    IncludeCompletedTasks
    Type
    boolean
    Description

    include completed tasks

    Default
    true
  • Name
    userIds
    Type
    array[integer]
    Description

    filter by userIds

    Format
    Comma separated values
  • Name
    teamIds
    Type
    array[integer]
    Description

    filter by team ids

    Format
    Comma separated values
  • Name
    selectedColumns
    Type
    array[string]
    Description

    customise the report by selecting columns to be displayed.

    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    jobRoleIds
    Type
    array[integer]
    Description

    filter by jobrole ids

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • users
    • jobroles
  • Name
    fields[utilizations]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • userId
    • unavailableMinutes
    • availableMinutes
    • billableMinutes
    • unbillableMinutes
    • loggedMinutes
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    companyIds
    Type
    array[integer]
    Description

    filter by company ids

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    Response contains information about a specific availability.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    404
    Description
    404 Not Found No Data

Examples

200 OK

Response
{
  "dashboardData": {
    "jobRolesDashboard": [
      {
        "data": {
          "billableUtilization": 0,
          "estimatedBillableUtilization": 0,
          "estimatedUtilization": 0
        },
        "jobRole": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "jobRoleId": 0,
        "users": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ]
      }
    ],
    "teamsDashboard": [
      {
        "data": {
          "billableUtilization": 0,
          "estimatedBillableUtilization": 0,
          "estimatedUtilization": 0
        },
        "team": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "teamId": 0,
        "users": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ]
      }
    ],
    "usersDashboard": [
      {
        "data": {
          "billableUtilization": 0,
          "estimatedBillableUtilization": 0,
          "estimatedUtilization": 0
        },
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "user": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "userId": 0
      }
    ]
  },
  "included": {
    "jobRoles": {
      "additionalProp": {
        "createdAt": "string",
        "createdByUser": 0,
        "deletedAt": "string",
        "deletedByUser": 0,
        "id": 0,
        "isActive": true,
        "name": "string",
        "updatedAt": "string",
        "updatedByUser": 0,
        "users": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ]
      }
    },
    "teams": {
      "additionalProp": {
        "id": 0,
        "name": "string",
        "teamLogo": "string",
        "teamLogoColor": "string",
        "teamLogoIcon": "string"
      }
    },
    "users": {
      "additionalProp": {
        "avatarUrl": "string",
        "canAddProjects": true,
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "companyId": 0,
        "companyRoleId": 0,
        "deleted": true,
        "email": "string",
        "firstName": "string",
        "id": 0,
        "isAdmin": true,
        "isClientUser": true,
        "isServiceAccount": true,
        "jobRoles": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "lastName": "string",
        "lengthOfDay": 0,
        "meta": {},
        "teams": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timezone": "string",
        "title": "string",
        "type": "string",
        "userCost": 0,
        "userRate": 0,
        "workingHour": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "workingHoursId": 0
      }
    }
  },
  "meta": {
    "averageSpend": 0,
    "limit": 0,
    "nextCursor": "string",
    "page": {
      "count": 0,
      "hasMore": true,
      "pageOffset": 0,
      "pageSize": 0
    },
    "prevCursor": "string",
    "totalCapacity": 0
  },
  "utilization": [
    {
      "data": [
        {
          "actualUtilization": 0,
          "allocatedMinutes": 0,
          "allocatedUtilization": 0,
          "availableMinutes": 0,
          "availableUtilization": 0,
          "billableMinutes": 0,
          "billableUtilization": 0,
          "companyCount": 0,
          "endDate": {},
          "estimatedBillableUtilization": 0,
          "estimatedMinutes": 0,
          "estimatedUtilization": 0,
          "loggedMinutes": 0,
          "nonBillableUtilization": 0,
          "startDate": {},
          "totalWorkingMinutes": 0,
          "unavailableMinutes": 0,
          "unavailableUtilization": 0,
          "unbillableMinutes": 0,
          "utilizationAchieved": 0,
          "utilizationTarget": 0
        }
      ],
      "user": {
        "id": 0,
        "meta": {},
        "type": "string"
      },
      "userId": 0
    }
  ]
}
Download Swagger