Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Phases

Get all phases

get/1.0/phases

Query parameters

projectIdinteger required

The identifier of the project is generated by the system and can be used to identify the project globally.

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'phaseName' | '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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases 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 phases whose date are greater than the given phases 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 phases that match the given phases created date.

createdAt.ltinteger
Example:1625164800000

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

createdAt.geinteger
Example:1625164800000

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

createdAt.leinteger
Example:1625164800000

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

updatedAt.gtinteger
Example:1625164800000

You can use this param to provide an epoch milli value and the responses will contain phases whose date are greater than the given phases 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 phases that match the given phases updated date.

updatedAt.ltinteger
Example:1625164800000

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

updatedAt.geinteger
Example:1625164800000

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

updatedAt.leinteger
Example:1625164800000

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

phaseName.eqstring
Example:Stark Onboarding

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

phaseName.cnstring
Example:Stark Onboarding

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

phaseName.ncstring
Example:Stark Onboarding

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

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "phaseId": 201,
      "phaseName": "Kick off",
      "project": {
        "projectId": 201,
        "projectName": "Acme onboarding"
      },
      "startDate": "2023-03-28",
      "dueDate": "2023-03-28",
      "startDateActual": "2023-03-28",
      "dueDateActual": "2023-03-28",
      "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"
      },
      "status": {
        "value": 2,
        "label": "In progress"
      },
      "private": true
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/phases?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"
  }
}