--- title: "Get task by Id" method: GET path: "/1.0/tasks/{taskId}" tags: ["Tasks"] --- # Get task by Id `GET /1.0/tasks/{taskId}` ## Path parameters - `taskId` integer, required ## Query parameters - `includeFields` string[] - `includeAllFields` boolean ## Response `200` The requested action was successfully executed. - TaskPublicAPIResponseEntity - `taskId` integer — The task's unique, system-generated **identifier**, which can be used to identify the task globally. - `taskName` string — The **name** of the task. - `taskDescription` string — The `description` of the task. The description body needs to be in **html** format to avoid any formatting issues in the application. - `startDate` string — The date when a task starts its execution. It can be empty. The format for the start date is _YYYY-MM-DD_. - `dueDate` string — The date when a task completes its execution. It can be empty. If both `startDate` and `dueDate` are specified for a given task, it is necessary that the latter should be on or after the given `startDate`. The format for the due date is _YYYY-MM-DD_. - `archived` boolean — The field `archived` denotes whether the task is archived or not. The task if archived will not be available in all search requests. - `effortInMinutes` integer — The effort is the expected time required to complete the task. The value is determined in minutes. - `progress` integer — The task's progress, if indicated, will be available here and ranges in value from 0 to 100. The task's status can be used in place of this field, however progress can offer more precise data. - `atRisk` boolean — Indicates whether the task has been marked as At Risk. This parameter is used to indicate that immediate action is necessary to unblock the task's execution. - `createdAt` integer — The time when the task was created. The referenced time will be in epoch millis. - `updatedAt` integer — The time when the task was last updated. Any changes that's related to the task are captured and specified here in epoch millis. - `createdBy` TaskCreatedByUserPublicAPI — The team member who updated the task. - `emailId` string — The user's email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `updatedBy` TaskCreatedByUserPublicAPI — The team member who updated the task. - `emailId` string — The user's email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `project` ProjectPublicAPITaskResponseEntity — The `project` associated with task. - `projectId` integer — The project's unique, system-generated identifier, which can be used to identify the project globally. - `projectName` string — The name of the project. - `status` TaskStatusPublicResponse — The task status value and the label. v 10, l xyz. - `value` integer — The value of the status field is the unique identifier for status fields. - `label` string — The label is the name of the status. - `fields` TaskFieldPublicResponseAPIEntity[] — Fields lists the custom project fields whose values were provided during project creation or updated later. Refer these [examples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know more about different types of custom fields returned in response. - `fieldId` integer — The unique identifier for the field. - `fieldLabel` string — The label of the field. - `fieldValue` object — The `fieldValue` is the value provided while creation or updating. The fieldValue can be a string, an integer, or an array and it must match the type of the field. Refer [e xamples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how each `field_type` is associated with task. - `fieldValueLabel` string — The `fieldValueLabel` is the value provided while creation or updating in a String format. - `startDateActual` string — The date on which the task status is changed to **In Progress**. The status can be either the default (**In Progress**) status or a custom status that is categorized as **In Progress**. It can be null for tasks that have not yet begun. The format for the actual start date is _YYYY-MM-DD_. - `dueDateActual` string — The date on which the task status is changed to **Completed**. The status can be either the default status **Completed** or a custom status that is categorized as **Completed**. It will be null if the task is yet to be completed. The format for the actual due date is _YYYY-MM-DD_. - `type` 'TASK' | 'MILESTONE' — The type of the task if specified will be available here. There are two options: `MILESTONE` or `TASK`. If a task is not explicitly marked as a milestone, it takes the default value as `TASK`. Milestones refer to critical tasks in the project that include an inbuilt CSAT capability that allows customers to offer CSAT evaluations depending on the task's execution. - `phase` TaskPhasePublicLiteAPIResponseEntity — The `phase` associated with the task. - `phaseId` integer — The unique identifier for the phase. - `phaseName` string — The name of the phase. - `assignees` AssigneePublicAPI — The users who are assigned the responsibility to execute the task. The assignees can be either **members** (team members or customers) or **placeholders**. - `members` TaskUserPublicAPI[] — The list includes both `team members` and `customers` assigned to the task. - `emailId` string — The user's email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `placeholders` TaskPlaceholderPublicAPI[] — The list contains all the placeholders assigned to the task. - `placeholderId` integer — The unique identifier for the placeholder. - `placeholderName` string — The name of the placeholder. - `role` RoleResponsePublicAPI — The role of the member or placeholder to whom allocation is made for - `roleId` integer — The role's unique, system-generated identifier, which can be used to identify the role globally. - `roleName` string — The name of the role. - `followers` TaskFollowersPublicResponse — The task followers are the team members who keep track of the execution of the project. It can be either `members` (team members or customers) or `placeholders`. - `members` TaskUserPublicAPI[] — The list includes both `team members` and `customers` assigned to the task. - `emailId` string — The user's email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `dependencies` TaskPublicLiteAPIResponseEntity[] — Task Dependencies allow you to define relationships between tasks that are dependent on each other. Note: Rocketlane allows you to have finish to start task dependencies. This means that dependent tasks are meant to start after the dependencies are marked as Complete. - `taskId` integer — The task's unique, system-generated **identifier**, which can be used to identify the task globally. - `taskName` string — The **name** of the task. - `parent` TaskPublicLiteAPIResponseEntity — The parent task of the task. - `taskId` integer — The task's unique, system-generated **identifier**, which can be used to identify the task globally. - `taskName` string — The **name** of the task. - `externalReferenceId` string — An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency. - `billable` boolean — Indicates whether the task is billable or non billable. - `timeEntryCategory` TaskPublicTimeEntryCategoryResponse — The category in which the task's time entry is added. - `categoryId` integer — Unique Identifier of the category in which the task's time entry is added. - `categoryName` string — Category Name in which the task's time entry is added. - `financialsBudgets` TaskPublicProjectFinancialsBudgetResponse[] — The Financials budget in which the task's time entry is added. - `budgetId` integer — Unique Identifier of the Financials budget in which the task's time entry is added. - `budgetName` string — Financials budget name in which task's time entry is added - `csatEnabled` boolean — In case of milestone tasks, this field determines if a CSAT survey will be sent out on completion of the task - `priority` TaskPriorityPublicResponse — Determines the level of priority of the task. - `value` integer — The value serves as a distinct identification for every priority field’s choice. - `label` string — The label is the name for every priority field’s choice. - `taskPrivateNote` string — The `privateNote` for the task is intended exclusively for team members. The note's content should be in `HTML` format to prevent any formatting issues in the application. - `private` boolean — This depicts if the task is private or not. ## Other responses - `400` — This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax. - `401` — You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab. - `404` — If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up. --- [API](https://skmtc.net/rocketlane/apis/rocketlane-api.md) · [All operations](https://skmtc.net/rocketlane/apis/rocketlane-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocketlane/rocketlane-api/revisions/1e8ba619e741/schema)