Get all phases

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Get all phases API enables users to find phases in their Rocketlane instances using advanced filtering options. This API is intended to provide a flexible and fast means of getting phase related data based on various parameters.

Developers can integrate phase search functionality into their applications and platforms by using this API. You can fine-tune your searches and retrieve the phase related data you need for integration into your applications or platforms by using the available parameters.

The includeFields param can be used to customize the response. You can fine-tune your searches and retrieve specific phase related data you need for integration into your applications or platforms by using filters.

You can use any combination of these parameters to execute searches based on your specifications. In addition to filters, sortBy and sortOrder can be used to sort the phases. The response body is paginated, and you can control the pagination using the limit and pageToken parameters.

Pagination

The Get all phases API accommodates pagination in the response body. The pageSize option can be used to restrict the amount of responses displayed/ available in a single request. Additionally, if there are more entries than the ones accessible in the answer, the response(s) may contain a pageToken.

Please refer to the pagination section for further information on this.

Filtering

The capacity to execute more sophisticated and nuanced searches on a dataset by combining numerous criteria and conditions is referred to as filtering.

Complex filtering in the context of the Get all phases API allows users to build elaborate search queries to return specific subsets of phases that satisfy specific requirements. By catering to a wide range of use cases, this enhanced filtering functionality considerably increases the API's utility and versatility.

The API reference includes a comprehensive range of filtering options.

The Get all phases API offers custom field filtering in addition to the regular filtering options. You can apply filters for these fields: startDate, projectID, dueDate, startDateActual, dueDateActual, phaseName.

Please refer to the below table for more information on how to construct the filtering criteria for phase related fields.

Operation	Definition	Example
field.gt	You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value is greater than the specified field value.	startDate.gt=2023-09-31
field.eq	You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value matches the specified field value.	projectId.eq
field.lt	You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value is less than the specified field value.	startDateActual.lt
field.ge	You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value is greater than or equal to the specified field value.	startDateActual.ge
field.le	You can use this parameter to indicate a field's value, and the responses will only include those particular resources whose field value is less than or equal to the specified field value.	dueDateActual.le
field.cn	You can use this param to specify some text and the responses will include those particular resources that contain the given text in their field value.	phaseName.cn
field.nc	You can use this param to specify some text and the responses will include those particular resources that DO NOT contain the given text in their field value.	phaseName.nc

Criteria Match

In addition to standard filtering and custom field filtering, the Get all phases API also supports the use of AND and OR conditions for more advanced filtering options. Users can combine different filters and custom field queries with these logical operators to build complex yet accurate search queries.

In case any issues arise or further assistance is required, please refer to the error handling section or reach out to our support team at [email protected] for a prompt resolution.

Query Params

projectId

int64

required

≥ 0

Defaults to 1

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

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

Allowed:

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 phases 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 phases that match the given date.

startDate.lt

string

You can use this param to specify some date and the responses will contain phases 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 phases 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 phases 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 phases 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 phases that match the given date.

dueDate.lt

string

You can use this param to specify some date and the responses will contain phases 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 phases 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 phases 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 phases 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 phases that match the given date.

startDateActual.lt

string

You can use this param to specify some date and the responses will contain phases 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 phases 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 phases 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 phases 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 phases that match the given date.

dueDateActual.lt

string

You can use this param to specify some date and the responses will contain phases 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 phases 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 phases 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 phases whose date are greater than the given phases created date.

createdAt.eq

int64

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

int64

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

int64

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

int64

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

int64

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

int64

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

int64

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

int64

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

int64

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

string

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

string

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

phaseName.nc

string

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

Responses

Pagination

Filtering

Criteria Match

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.