Get all projects

get

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

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

For sorting the responses by the provided field, use the sortBy parameter.

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 provide a date and the responses will contain projects whose date are greater than the given start date.

startDate.eq

string

You can use this param to provide a date and the responses will contain exact matches of projects that match the given start date.

startDate.lt

string

You can use this param to provide a date and the responses will contain projects whose date are less than the given start date.

startDate.ge

string

You can use this param to provide a date and the responses will contain projects whose date are greater than or equal to the given start date.

startDate.le

string

You can use this param to provide a date and the responses will contain projects whose date are less than or equal to the given start date.

dueDate.gt

string

You can use this param to provide a date and the responses will contain projects whose date are greater than the given due date.

dueDate.eq

string

You can use this param to provide a date and the responses will contain exact matches of projects that match the given due date.

dueDate.lt

string

You can use this param to provide a date and the responses will contain projects whose date are less than the given due date.

dueDate.ge

string

You can use this param to provide a date and the responses will contain projects whose date are greater than or equal to the given due date.

dueDate.le

string

You can use this param to provide a date and the responses will contain projects whose date are less than or equal to the given due date.

startDateActual.gt

string

You can use this param to provide a date and the responses will contain projects whose date are greater than the given actual start date.

startDateActual.eq

string

You can use this param to provide a date and the responses will contain exact matches of projects that match the given actual start date.

startDateActual.lt

string

You can use this param to provide a date and the responses will contain projects whose date are less than the given actual start date.

startDateActual.ge

string

You can use this param to provide a date and the responses will contain projects whose date are greater than or equal to the given actual start date.

startDateActual.le

string

You can use this param to provide a date and the responses will contain projects whose date are less than or equal to the given actual start date.

dueDateActual.gt

string

You can use this param to provide a date and the responses will contain projects whose date are greater than the given actual due date.

dueDateActual.eq

string

You can use this param to provide a date and the responses will contain exact matches of projects that match the given actual due date.

dueDateActual.lt

string

You can use this param to provide a date and the responses will contain projects whose date are less than the given actual due date.

dueDateActual.ge

string

You can use this param to provide a date and the responses will contain projects whose date are greater than or equal to the given actual due date.

dueDateActual.le

string

You can use this param to provide a date and the responses will contain projects whose date are less than or equal to the given actual due date.

createdAt.gt

int64

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

createdAt.eq

int64

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

createdAt.lt

int64

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

createdAt.ge

int64

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

createdAt.le

int64

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

updatedAt.gt

int64

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

updatedAt.eq

int64

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

updatedAt.lt

int64

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

updatedAt.ge

int64

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

updatedAt.le

int64

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

annualizedRecurringRevenue.eq

number

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

annualizedRecurringRevenue.gt

number

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

annualizedRecurringRevenue.lt

number

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

projectFee.eq

number

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

projectFee.gt

number

You can use this param to specify some value as project fee and the responses will contain matches of projects greater than that of the given value.

projectFee.lt

number

You can use this param to specify some value as project fee and the responses will contain matches of projects lesser than that of the given value.

customerId.eq

string

You can use this param to provide a customer company id and the responses will contain exact matches of projects that match the given customer company id.

customerId.oneOf

string

You can use this param to provide customer company ids separated by commas and the responses will contain matches of projects that match any of the given customer company id.

customerId.noneOf

string

You can use this param to provide customer company id separated by commas and the responses will not contain matches of projects that match the given set of customer company id.

teamMemberId.eq

string

You can use this param to provide a team member id and the responses will contain exact matches of projects that match the given team member id.

teamMemberId.oneOf

string

You can use this param to provide team member ids separated by commas and the responses will contain matches of projects that match any of the given team member id.

teamMemberId.noneOf

string

You can use this param to provide team member id separated by commas and the responses will not contain matches of projects that match the given set of team member id.

companyId.eq

string

You can use this param to provide a customer company id and the responses will contain exact matches of projects that match the given customer company id.

companyId.oneOf

string

You can use this param to provide customer company ids separated by commas and the responses will contain matches of projects that match any of the given customer company id.

companyId.noneOf

string

You can use this param to provide customer company id separated by commas and the responses will not contain matches of projects that match the given set of customer company id.

projectName.eq

string

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

projectName.cn

string

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

projectName.nc

string

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

inferredProgress.eq

array of strings

length ≤ 1

You can use this param to provide a inferred progress and the responses will contain exact matches of projects that match the given inferred progress.

inferredProgress.eq

contractType.eq

array of strings

length ≤ 1

You can use this param to provide a contract type and the responses will contain exact matches of projects that match the given contract type

contractType.eq

contractType.oneOf

array of strings

length ≤ 4

You can use this param to provide contract types separated by commas and the responses will contain matches of projects that match any of the given contract types.

contractType.oneOf

contractType.noneOf

array of strings

length ≤ 4

You can use this param to provide contract types separated by commas and the responses will not contain matches of projects that match the given set of contract types.

contractType.noneOf

budgetedHours.gt

string

You can use this param to provide a budgeted hour and the responses will contain projects whose budgeted hours are greater than the given budgeted hour.

budgetedHours.eq

string

You can use this param to provide a budgeted hour and the responses will contain exact matches of projects that match the given budgeted hour.

budgetedHours.lt

string

You can use this param to provide a budgeted hour and the responses will contain projects whose budgeted hours are less than the given budgeted hour.

budgetedHours.ge

string

You can use this param to provide a budgeted hour and the responses will contain projects whose budgeted hours are greater than or equal to the given budgeted hour.

allocatedHours.le

string

You can use this param to provide a allocated hour and the responses will contain projects whose allocated hours are less than or equal to the given allocated hour.

allocatedHours.gt

string

You can use this param to provide a allocated hour and the responses will contain projects whose allocated hours are greater than the given allocated hour.

allocatedHours.eq

string

You can use this param to provide a allocated hour and the responses will contain exact matches of projects that match the given allocated hour.

allocatedHours.lt

string

You can use this param to provide a allocated hour and the responses will contain projects whose allocated hours are less than the given allocated hour.

allocatedHours.ge

string

You can use this param to provide a allocated hour and the responses will contain projects whose allocated hours are greater than or equal to the given allocated hour.

customersInvited.gt

string

You can use this param to provide a number and the responses will contain projects that have more customers invited than given number of customers invited.

customersInvited.eq

string

You can use this param to provide a number and the responses will contain exact matches of projects that exactly have the given number of customers invited.

customersInvited.lt

string

You can use this param to provide a number and the responses will contain projects that have less customers invited than given number of customers invited.

customersInvited.ge

string

You can use this param to provide a number and the responses will contain projects that have equal or more customers invited than given number of customers invited.

customersInvited.le

string

You can use this param to provide a number and the responses will contain projects that have equal or less customers invited than given number of customers invited.

customersJoined.gt

string

You can use this param to provide a number and the responses will contain projects that have more customers joined than given number of customers joined.

customersJoined.eq

string

You can use this param to provide a number and the responses will contain exact matches of projects that exactly have the given number of customers joined.

customersJoined.lt

string

You can use this param to provide a number and the responses will contain projects that have less customers joined than given number of customers joined.

customersJoined.ge

string

You can use this param to provide a number and the responses will contain projects that have equal or more customers joined than given number of customers joined.

customersJoined.le

string

You can use this param to provide a number and the responses will contain projects that have equal or less customers joined than given number of customers joined.

includeArchive.eq

boolean

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

status.eq

string

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

status.oneOf

string

You can use this param to provide statuses and the responses will contain projects that match one of the given statuses

status.noneOf

string

You can use this param to provide statuses and the responses will contain projects that matches none of the given statuses

externalReferenceId.eq

string

You can use this param to provide external reference id and the responses will contain projects 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.