Get all tasks

get

https://api.rocketlane.com/api/1.0/tasks

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageSize

number

≥ 0

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.

pageToken

string

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.

includeFields

array of strings

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.

includeFields

includeAllFields

boolean

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

string

enum

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

Allowed:

sortOrder

string

enum

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

Allowed:

match

string

enum

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

Allowed:

startDate.gt

string

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

startDate.eq

string

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

startDate.lt

string

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

startDate.ge

string

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.le

string

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.gt

string

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

dueDate.eq

string

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

dueDate.lt

string

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

dueDate.ge

string

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.le

string

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.gt

string

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

startDateActual.eq

string

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

startDateActual.lt

string

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

startDateActual.ge

string

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.le

string

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.gt

string

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

dueDateActual.eq

string

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

dueDateActual.lt

string

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

dueDateActual.ge

string

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.le

string

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.gt

int64

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.eq

int64

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.lt

int64

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.ge

int64

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.le

int64

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.gt

int64

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.eq

int64

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.lt

int64

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.ge

int64

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.le

int64

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.eq

number

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.eq

number

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.eq

string

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.cn

string

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

taskName.nc

string

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.eq

number

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.gt

number

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.lt

number

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.eq

number

0 to 100

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.gt

number

0 to 100

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.lt

number

0 to 100

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.eq

boolean

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

task.status.eq

string

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

task.status.oneOf

string

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

task.status.noneOf

string

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

project.status.eq

string

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.oneOf

string

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.noneOf

string

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.eq

string

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

Responses

200The requested action was successfully executed.

400This 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.

401You 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.