GET/projects/api/v3/workload/planners.json

Retrieve user workload planner

Return the workload planner for each users of the installation.

Query Params

  • Name
    startDate
    Type
    string
    Description
    define the start date of the planner
  • Name
    searchUserName
    Type
    string
    Description
    filter by user name
  • Name
    searchTaskName
    Type
    string
    Description
    filter by task name
  • Name
    projectStatus
    Type
    string
    Description
    filter by project status
  • Name
    orderMode
    Type
    string
    Description
    order mode
    Default
    asc
  • Name
    orderBy
    Type
    string
    Description
    order by
    Default
    name
  • Name
    endDate
    Type
    string
    Description
    define the end date of the planner
  • Name
    pageSize
    Type
    integer
    Description
    number of items in a page
    Default
    50
  • Name
    page
    Type
    integer
    Description
    page number
    Default
    1
  • Name
    subtractLoggedTimeFromEstimates
    Type
    boolean
    Description
    subtract logged time from task estimated time
  • Name
    skipCounts
    Type
    boolean
    Description
    SkipCounts allows you to skip doing counts on a list API endpoint for
    performance reasons.
  • Name
    prorating
    Type
    boolean
    Description
    include tasks that have the start and due dates outside the window range
    Default
    false
  • Name
    onlyUntaggedTasks
    Type
    boolean
    Description
    filter ony untagged tasks
  • Name
    onlyStarredProjects
    Type
    boolean
    Description
    filter by starred projects only
  • Name
    matchAllProjectTags
    Type
    boolean
    Description
    enforce all tag ids must be matched
  • Name
    includeTeamUserIds
    Type
    boolean
    Description
    include team users to the responsible party ids
    Default
    true
  • Name
    includeTasksWithoutDates
    Type
    boolean
    Description
    include tasks without start or due date
  • Name
    includeCompletedTasks
    Type
    boolean
    Description
    include completed tasks
  • Name
    includeCompanyUserIds
    Type
    boolean
    Description
    include company users to the responsible party ids
    Default
    true
  • Name
    includeCalendarEvents
    Type
    boolean
    Description
    include calendar events on capacity calculation
  • Name
    includeAssigneeTeams
    Type
    boolean
    Description
    include teams related to the responsible party ids
  • Name
    includeAssigneeCompanies
    Type
    boolean
    Description
    include companies related to the responsible party ids
  • Name
    includeArchivedProjects
    Type
    boolean
    Description
    include archived projects
  • Name
    distribute
    Type
    boolean
    Description
    distribute the estimated time for a task between all the assignees
  • Name
    teamIds
    Type
    array[integer]
    Description
    filter by member of team ids
    Format
    Comma separated values
  • Name
    tagIds
    Type
    array[integer]
    Description
    filter by task tag ids
    Format
    Comma separated values
  • Name
    responsiblePartyIds
    Type
    array[integer]
    Description
    filter by responsible party ids
    Format
    Comma separated values
  • Name
    projectTagIds
    Type
    array[integer]
    Description
    filter by project tag ids
    Format
    Comma separated values
  • Name
    projectStatuses
    Type
    array[string]
    Description
    list of project status
    Format
    Comma separated values
  • Name
    projectOwnerIds
    Type
    array[integer]
    Description
    filter by project owner ids
    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description
    filter by project ids
    Format
    Comma separated values
  • Name
    projectHealths
    Type
    array[integer]
    Description
    list of project health
    Format
    Comma separated values
  • Name
    projectCompanyIds
    Type
    array[integer]
    Description
    filter by company ids
    Format
    Comma separated values
  • Name
    projectCategoryIds
    Type
    array[integer]
    Description
    filter by project category ids
    Format
    Comma separated values
  • Name
    memberOfProjectIds
    Type
    array[integer]
    Description
    filter by member of project 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.timelogs
    • tasklists
    • milestones
    • companies
    • calendarEvents
  • 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[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[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[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
    excludeTagIds
    Type
    array[integer]
    Description
    filter by removing task tag ids
    Format
    Comma separated values
  • Name
    companyIds
    Type
    array[integer]
    Description
    filter by user company id
    Format
    Comma separated values
  • Name
    assigneeTeamIds
    Type
    array[integer]
    Description
    filter by assignee team ids
    Format
    Comma separated values
  • Name
    assigneeCompanyIds
    Type
    array[integer]
    Description
    filter by assignee company ids
    Format
    Comma separated values

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    WorkloadPlannersResponse contains information about a group of planners.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

WorkloadPlannersResponse
{  "included": {    "calendarEvents": {      "additionalProp": {        "additionalProperties": "string",        "allDay": true,        "attendeesCanEdit": true,        "attendingUserIds": [          0        ],        "attendingUsers": [          {            "id": 0,            "meta": {},            "type": "string"          }        ],        "createdAt": "string",