GET/projects/api/v3/workload.json

Return the workload for users.

Return user's workload across projects.

Query Params

  • Name
    startDate
    Type
    string
    Description

    filter by start date

  • Name
    searchTerm
    Type
    string
    Description

    filter by user name

  • Name
    endDate
    Type
    string
    Description

    filter by end date

  • Name
    cursor
    Type
    string
    Description

    cursor used for pagination. When using this pagination mode the page and pageSize will be ignored, using limit to control the number of items. The sorting will strictly be by user ID. If any other filter is modified during the cursor iteration the response will fallback to the first page.

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    limit
    Type
    integer
    Description

    number of items to show when providing the cursor.

  • Name
    useLoggedTime
    Type
    boolean
    Description

    consider task's logged time when calculating the capacity. The time already logged will be subtracted from the estimated time before computing the capactiy.

  • Name
    skipCounts
    Type
    boolean
    Description

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

  • Name
    omitEmptyDateEntries
    Type
    boolean
    Description

    omit empty date entries. This is useful to minimize the response size, helping the parsing time. It requires that the client considers day gaps as no data.

    Default
    false
  • Name
    matchAllProjectTags
    Type
    boolean
    Description

    match all project tags

  • Name
    includeCompletedTasks
    Type
    boolean
    Description

    include completed tasks when calculating the capacity and includes returning completed tasks.

  • Name
    includeCalendarEvents
    Type
    boolean
    Description

    include synced calendar events in daily rollup calculations

  • Name
    userIds
    Type
    array[integer]
    Description

    filter by user ids

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

    filter by teams

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

    filter by task tag ids

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

    filter by tag ids

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

    filter by skill ids

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

    filter by project tag ids

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

    filter by projects

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

    filter by project company ids

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

    filter by project category ids

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

    filter by job role ids

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

    include

    Format
    Comma separated values
    Allowed values
    • users
    • users.workingHours
    • users.workingHours.workingHoursEntry
    • tasks
    • tasks.tasklists
    • tasks.tasklists.milestones
    • tasks.tasklists.projects
    • tasks.taskCapacities
    • users.milestones
    • calendarEvents
    • calendarEvents.calendarEventTypes
    • unavailableTimes
    • unavailableTimes.calendarEventTypes
    • tasks.taskSequences
    • holidays
    • tasks.timelogs
    • users.companies
    • users.milestones.tags
    • users.skills
    • users.jobroles
  • Name
    fields[workingHours]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • objectType
    • objectId
    • name
    • description
    • dateCreated
    • dateUpdated
    • entryIds
  • Name
    fields[workingHourEntries]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • workingHourId
    • weekday
    • startTime
    • endTime
    • taskHours
    • timezone
  • 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
    fields[unavailableTimes]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • startDate
    • endDate
    • durationMinutes
    • type
    • attendingUsers
    • ownedBy
    • createdAt
    • createdBy
    • updatedAt
    • updatedBy
    • deleted
    • deletedAt
    • deletedBy
  • Name
    fields[timelogs]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • dateCreated
    • minutes
    • description
    • timeLogged
    • billable
    • deleted
    • dateDeleted
    • hasStartTime
    • dateEdited
    • deskTicketId
    • userId
    • taskId
    • projectId
    • loggedByUserId
    • deletedByUserId
    • editedByUserId
    • taskIdPreMove
    • projectBillingInvoiceId
  • Name
    fields[tasks]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • dateUpdated
    • parentTaskId
    • isPrivate
    • status
    • tasklistId
    • startDate
    • dueDate
  • Name
    fields[tasklists]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • projectId
    • milestoneId
  • Name
    fields[taskSequences]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • installationId
    • frequency
    • selectedWeekDays
    • endDate
    • monthlyRepeatType
    • duration
    • rrule
  • Name
    fields[taskCapacities]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • taskId
    • userId
    • date
    • minutes
  • Name
    fields[skill]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[milestones]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • description
    • deadline
    • completed
    • projectId
    • createdOn
    • lastChangedOn
    • creatorUserId
    • reminder
    • private
    • lockdownId
    • status
    • completedOn
    • completerId
    • percentageComplete
  • Name
    fields[jobroles]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage
  • Name
    fields[calendarEvents]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • title
    • startDate
    • endDate
    • typeId
    • privacyType
    • allDay
    • location
    • description
    • showAsBusy
    • attendeesCanEdit
    • projectUsersCanEdit
    • monthlyRepeatType
    • dateLastUpdated
    • createdDateTime
    • deleted
    • dateDeleted
    • additionalProperties
    • currentUserAssociationType
    • sequenceId
    • projectId
    • ownerUserId
    • deletedByUserId
    • createdByUserId
    • updatedByUserId
  • Name
    fields[calendarEventTypes]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • color
    • unavailable
  • Name
    companyIds
    Type
    array[integer]
    Description

    filter by companies

    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    Response contains information about a workload.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.
  • Code
    403
    Type
    object
    Schema
    Description
    403 Forbidden
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

Response
{  "included": {    "calendarEventTypes": {      "additionalProp": {        "color": "string",        "id": 0,        "name": "string",        "unavailable": true      }    },    "companies": {      "additionalProp": {        "accounts": 0,        "addressOne": "string",        "addressTwo": "string",        "budgetDistribution": [          {            "color": "string",
Download Swagger