v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB

Tasks

Get task by Id

get/1.0/tasks/{taskId}

Path parameters

taskIdinteger required

The task's unique, system-generated identifier, which can be used to identify the task globally.

Query parameters

includeFieldsstring[]

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeAllFieldsboolean

Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Response

The requested action was successfully executed.

taskIdinteger

The task's unique, system-generated identifier, which can be used to identify the task globally.

taskNamestring

The name of the task.

taskDescriptionstring

The description of the task. The description body needs to be in html format to avoid any formatting issues in the application.

startDatestring

The date when a task starts its execution. It can be empty. The format for the start date is YYYY-MM-DD.

dueDatestring

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.

archivedboolean

The field archived denotes whether the task is archived or not. The task if archived will not be available in all search requests.

effortInMinutesinteger

The effort is the expected time required to complete the task. The value is determined in minutes.

progressinteger

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.

atRiskboolean

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.

createdAtinteger

The time when the task was created. The referenced time will be in epoch millis.

updatedAtinteger

The time when the task was last updated. Any changes that's related to the task are captured and specified here in epoch millis.

startDateActualstring

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.

dueDateActualstring

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.

externalReferenceIdstring

An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.

billableboolean

Indicates whether the task is billable or non billable.

csatEnabledboolean

In case of milestone tasks, this field determines if a CSAT survey will be sent out on completion of the task

taskPrivateNotestring

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.

privateboolean

This depicts if the task is private or not.

Example response

{
  "taskId": 201,
  "taskName": "Kick off",
  "taskDescription": "<p>Schedule Kick off meeting with the stakeholders involved.</p>",
  "startDate": "2023-03-28",
  "dueDate": "2023-03-28",
  "effortInMinutes": 3000,
  "progress": 50,
  "atRisk": true,
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000,
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "project": {
    "projectId": 201,
    "projectName": "Acme onboarding"
  },
  "status": {
    "value": 2,
    "label": "In progress"
  },
  "fields": [
    {
      "fieldId": 201,
      "fieldLabel": "MRR",
      "fieldValueLabel": "1000"
    }
  ],
  "startDateActual": "2023-03-28",
  "dueDateActual": "2023-03-28",
  "type": "MILESTONE",
  "phase": {
    "phaseId": 201,
    "phaseName": "Go live"
  },
  "assignees": {
    "members": [
      {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      }
    ],
    "placeholders": [
      {
        "placeholderId": 201,
        "placeholderName": "Customer Success",
        "role": {
          "roleId": 101,
          "roleName": "Designer"
        }
      }
    ]
  },
  "followers": {
    "members": [
      {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      }
    ]
  },
  "dependencies": [
    {
      "taskId": 201,
      "taskName": "Kick off"
    }
  ],
  "parent": {
    "taskId": 201,
    "taskName": "Kick off"
  },
  "externalReferenceId": "task_8171",
  "billable": true,
  "timeEntryCategory": {
    "categoryId": 201,
    "categoryName": "Pre-sales"
  },
  "financialsBudgets": [
    {
      "budgetId": 201,
      "budgetName": "Pre-sales"
    }
  ],
  "priority": {
    "value": 2,
    "label": "High"
  }
}

All 64 operations