Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Tasks

Get all tasks

get/1.0/tasks

Query parameters

pageSizenumber
Example:100

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageTokenstring
Example:59c12a42-dd10-11ed-afa1-0242ac120002

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

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.

sortBy'taskName' | 'startDate' | 'dueDate' | 'startDateActual' | 'dueDateActual'

You can use the sortBy param to sort the responses by the given field.

sortOrder'ASC' | 'DESC'

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

match'all' | 'any'

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

startDate.gtstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date.

startDate.eqstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date.

startDate.ltstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are less than the given date.

startDate.gestring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date.

startDate.lestring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date.

dueDate.gtstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date.

dueDate.eqstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date.

dueDate.ltstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are less than the given date.

dueDate.gestring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date.

dueDate.lestring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date.

startDateActual.gtstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date.

startDateActual.eqstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date.

startDateActual.ltstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are less than the given date.

startDateActual.gestring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date.

startDateActual.lestring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date.

dueDateActual.gtstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date.

dueDateActual.eqstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date.

dueDateActual.ltstring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are less than the given date.

dueDateActual.gestring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date.

dueDateActual.lestring
Example:2023-03-28

You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date.

createdAt.gtinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than the given tasks created date.

createdAt.eqinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain exact matches of tasks that match the given tasks created date.

createdAt.ltinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than the given tasks created date.

createdAt.geinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than or equal to the given tasks created date.

createdAt.leinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than or equal to the given tasks created date.

updatedAt.gtinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than the given tasks updated date.

updatedAt.eqinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain exact matches of tasks that match the given tasks updated date.

updatedAt.ltinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than the given tasks updated date.

updatedAt.geinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than or equal to the given tasks updated date.

updatedAt.leinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than or equal to the given tasks updated date.

projectId.eqnumber
Example:10000

You can use this param to specify some value as project id and the responses will contain exact matches of tasks that match the given value.

phaseId.eqnumber
Example:10000

You can use this param to specify some value as phase id and the responses will contain exact matches of tasks that match the given value.

taskName.eqstring
Example:Stark Onboarding

You can use this param to specify some task name and the responses will contain exact matches of tasks that match the given name.

taskName.cnstring
Example:Stark Onboarding

You can use this param to specify some task name and the responses will contain matches of tasks that match the given name.

taskName.ncstring
Example:Stark Onboarding

You can use this param to specify some task name and the responses will not contain matches of tasks that match the given name.

effortInMinutes.eqnumber
Example:10000

You can use this param to specify some value as effort and the responses will contain exact matches of tasks that match the given value.

effortInMinutes.gtnumber
Example:10000

You can use this param to specify some value as effort and the responses will contain exact matches of tasks greater than that of the given value.

effortInMinutes.ltnumber
Example:10000

You can use this param to specify some value as effort and the responses will contain exact matches of tasks lesser than that of the given value.

progress.eqnumber
Example:55

You can use this param to specify some value as progress and the responses will contain exact matches of tasks that match the given value.

progress.gtnumber
Example:55

You can use this param to specify some value as progress and the responses will contain exact matches of tasks greater than that of the given value.

progress.ltnumber
Example:55

You can use this param to specify some value as progress and the responses will contain exact matches of tasks lesser than that of the given value.

includeArchive.eqboolean

You can use this parameter to specify whether responses will include the archived tasks.

task.status.eqstring

You can use this param to provide status and the responses will contain tasks that are equal to the given status

task.status.oneOfstring
Example:1,2

You can use this param to provide statuses and the responses will contain tasks that contains the given status

task.status.noneOfstring
Example:1,2

You can use this param to provide statuses and the responses will not contain tasks that are equal to the given status

project.status.eqstring

You can use this param to provide status of project and the responses will contain tasks whose project's status are equal to the given status

project.status.oneOfstring
Example:1,2

You can use this param to provide statuses of project and the responses will contain tasks whose project's statuses that contains the given status

project.status.noneOfstring
Example:1,2

You can use this param to provide statuses of project and the responses will not contain tasks whose project's statuses are equal to the given status(es)

externalReferenceId.eqstring
Example:task_1818910101

You can use this param to provide external reference id and the responses will contain tasks that are equal to the given id

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/tasks?includeFields=category,minutes&billable.eq=false&sortBy=startDate&sortOrder=desc&pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100&assignee.any=1&startDate.gt=2022-01-02",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}