Skip to main content
Server path: /rocketlane-projects | Type: Application | PCID required: Yes

Tools

ToolDescription
rocketlane_projects_add_membersAdd members to a project
rocketlane_projects_archive_projectArchive project by Id
rocketlane_projects_assign_placeholdersAssign placeholders to an user in a project
rocketlane_projects_create_phaseCreate a phase
rocketlane_projects_create_projectCreate a project
rocketlane_projects_create_spaceCreate a space
rocketlane_projects_create_space_documentCreate a space document
rocketlane_projects_delete_phaseDelete phase by Id
rocketlane_projects_delete_projectDelete project by Id
rocketlane_projects_delete_spaceDelete space by Id
rocketlane_projects_delete_space_documentDelete space document by Id
rocketlane_projects_get_all_phasesGet all phases
rocketlane_projects_get_all_projectsGet all projects
rocketlane_projects_get_all_space_documentsGet all space documents
rocketlane_projects_get_all_spacesGet all spaces
rocketlane_projects_get_phaseGet phase by Id
rocketlane_projects_get_placeholdersGet placeholders
rocketlane_projects_get_projectGet project by Id
rocketlane_projects_get_spaceGet space by Id
rocketlane_projects_get_space_documentGet space document by Id
rocketlane_projects_import_templateImport a template to a project
rocketlane_projects_remove_membersRemove members from a project
rocketlane_projects_unassign_placeholdersUn assign placeholders from an user in a project
rocketlane_projects_update_phaseUpdate phase by Id
rocketlane_projects_update_projectUpdate project by Id
rocketlane_projects_update_spaceUpdate space by Id
rocketlane_projects_update_space_documentUpdate space document by Id

rocketlane_projects_add_members

Add members to a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.
customersobject[]NoThe project customers.
membersobject[]NoThe project team members.

rocketlane_projects_archive_project

Archive project by Id Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.

rocketlane_projects_assign_placeholders

Assign placeholders to an user in a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.
bodyobject[]YesRequest body

rocketlane_projects_create_phase

Create a phase Parameters:
ParameterTypeRequiredDefaultDescription
includeFieldsstring[]NoThis 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.
includeAllFieldsbooleanNoThis 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.
dueDatestringYesThe day on which the phase’s execution is planned to be completed. The due date is required and cannot be left blank. The dueDate must be on or after the given startDate. The format for the due date is YYYY-MM-DD.
phaseIdintegerNoThe identifier of the phase is generated by the system and can be used to identify the phase globally.
phaseNamestringYesThe name of the phase. The name specified will be displayed everywhere else and can be used for filtering purposes.
privatebooleanNoDescribes the privacy of the phase i.e. if it is private or shared.
projectobjectYesThe project associated with phase needs to be specified here and it is mandatory for the phase to get created and map accordingly.
startDatestringYesOn this date the phase’s execution officially begins. The start date is required. The format for the start date is YYYY-MM-DD.
statusobjectNoThe value of the phase status can be specified here and this is essential to keep track of the phase.

rocketlane_projects_create_project

Create a project Parameters:
ParameterTypeRequiredDefaultDescription
includeFieldsstring[]NoThis 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.
includeAllFieldsbooleanNoThis 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.
annualizedRecurringRevenueintegerNoIndicates the value of the recurring revenue of the customer’s subscriptions for a single calendar year.
assignProjectOwnerbooleanNoWhen a project is created, you can use this param to automatically assign any unassigned tasks to the project owner. Note: If the project hasn’t been created using sources, this value will be skipped.
autoAllocationbooleanNoThe field autoAllocation defines whether Auto Allocation is enabled for the project or not. If auto allocation is enabled, instead of adding it manually, the allocations are computed from the tasks duration, effort and the assignees specified in the project.
autoCreateCompanybooleanNoThe field auto create company defines whether company should be created as part of the project creation. If the field is set to true, then if the company exists we re-use the company and proceed further. Else we will create a new company.
budgetedHoursnumberNoBudgeted hours represent the total hours allocated for project execution. This value can be edited at any point throughout the project’s duration. You can enter the budgeted hours in decimal form, including both hours and minutes, with up to two decimal places of precision. Eg: 1.65 hrs = 1h 39m(1.65h * 60m = 99m).
currencystringNoThe currency for handling the project’s financials. You can only specify a currency for a project that is added at the account level. Please note that the project’s currency cannot to changed once set.
customerobjectYesThis field is required to identify the customer as part of the request. The customer’s name is case-sensitive, and an exact match is required for further processing. It should be noted that once the customer information is entered, it cannot be modified during the project’s lifespan.
dueDatestringNoThe day on which the project’s execution is planned to be completed. The due date is not required and can be left blank. If sources (templates) are included as part of the project creation, the project’s due date will be calculated depending on the duration of the specified sources. For projects where both startDate and dueDate are specified, the latter must be on or after the given startDate. The format for the due date is YYYY-MM-DD.
externalReferenceIdstringNoAn externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.
fieldsobject[]NoThe custom fields can be set during the project creation with the help of fields. The fieldValue can be either a string or a number or an array and it has to comply with the type of the field. Refer examples to know how to assign fieldValue based on their field_type.
financialsobjectNoThis section addresses the financial aspects of the projects and the associated fields.
ownerobjectYesThe project owner is mandatory to be specified along with the project creation. The owner gets access to everything in the project and can be used to control the activities that happens in the project. Project owner will receive project invite email based on their notification configuration
partnersobject[]NoThe partners field is used to specify partner companies.
placeholdersobject[]NoRocketlane’s placeholders are associated with roles. Based on the kind of roles and expertise that are needed to execute a task, placeholders can be added as assignees to templates as well as projects. Eventually, you can resolve placeholders by replacing them with team members according to their availability and role. Note: If the project is not built using sources, this value will be ignored but the mappings are retained and can be used in the future.
projectFeeintegerNoThe total fee that is charged for the project.
projectIdintegerNoThe identifier of the project is generated by the system and can be used to identify the project globally.
projectNamestringYesThe name of the project. The name specified will be displayed everywhere else and can be used for filtering purposes.
sourcesobject[]NoSources denotes the project templates involved in creation/ imported post creation of the project.
startDatestringNoOn this date the project’s execution officially begins. If sources (templates) are mentioned in the request, the start date is required. For projects without any defined sources, it may be empty. The format for the start date is YYYY-MM-DD.
statusobjectNoThe value of the project status can be specified here and this is essential to keep track of the project.
teamMembersobjectNoThe teamMembers field can be used to specify the project members, customers and customerChampion. Once the project is created, an invite will be emailed to all the teamMembers specified.
visibilitystringNoSet visibility parameters to restrict who can see your project. There are two options: EVERYONE and MEMBERS. Selecting EVERYONE allows all team members from your firm to view the project, while selecting MEMBERS restricts access to only those team members who have been specifically invited.

rocketlane_projects_create_space

Create a space Parameters:
ParameterTypeRequiredDefaultDescription
privatebooleanNoDescribes the privacy of the space i.e. if it is private or shared.
projectobjectYesThe project where the space exists.
spaceIdintegerNoThe space’s unique, system-generated identifier, which can be used to identify the space globally.
spaceNamestringYesThe name of the space.

rocketlane_projects_create_space_document

Create a space document Parameters:
ParameterTypeRequiredDefaultDescription
sourceobjectNoSources denote the document templates based on which the document is created
spaceobjectYesInformation about the space to which the space document belongs to.
spaceDocumentIdintegerNoThe space document’s unique, system-generated identifier, which can be used to identify the space document globally.
spaceDocumentNamestringNoThe name of the space document.By default, the name is ‘Untitled’.
spaceDocumentTypestringYesDefines the type of the space document. This could be a Rocketlane document or an embedded document.
urlstringNoThe url that is embedded in the space document.

rocketlane_projects_delete_phase

Delete phase by Id Parameters:
ParameterTypeRequiredDefaultDescription
phaseIdintegerYesThe identifier of the phase is generated by the system and can be used to identify the phase globally.

rocketlane_projects_delete_project

Delete project by Id Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.

rocketlane_projects_delete_space

Delete space by Id Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdintegerYesThe space’s unique, system-generated identifier, which can be used to identify the space globally.

rocketlane_projects_delete_space_document

Delete space document by Id Parameters:
ParameterTypeRequiredDefaultDescription
spaceDocumentIdintegerYesThe space document’s unique, system-generated identifier, which can be used to identify the space document globally.

rocketlane_projects_get_all_phases

Get all phases Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe identifier of the project is generated by the system and can be used to identify the project globally.
pageSizenumberNoThis 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.
pageTokenstringNoUse 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[]NoThis 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.
includeAllFieldsbooleanNoThis 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.
sortBystringNoYou can use the sortBy param to sort the responses by the given field.
sortOrderstringNoThe sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.
matchstringNoYou can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.
startDate.gtstringNoYou can use this param to specify some date and the responses will contain phases whose date are greater than the given date.
startDate.eqstringNoYou can use this param to specify some date and the responses will contain exact matches of phases that match the given date.
startDate.ltstringNoYou can use this param to specify some date and the responses will contain phases whose date are less than the given date.
startDate.gestringNoYou 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.lestringNoYou 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.gtstringNoYou can use this param to specify some date and the responses will contain phases whose date are greater than the given date.
dueDate.eqstringNoYou can use this param to specify some date and the responses will contain exact matches of phases that match the given date.
dueDate.ltstringNoYou can use this param to specify some date and the responses will contain phases whose date are less than the given date.
dueDate.gestringNoYou 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.lestringNoYou 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.gtstringNoYou can use this param to specify some date and the responses will contain phases whose date are greater than the given date.
startDateActual.eqstringNoYou can use this param to specify some date and the responses will contain exact matches of phases that match the given date.
startDateActual.ltstringNoYou can use this param to specify some date and the responses will contain phases whose date are less than the given date.
startDateActual.gestringNoYou 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.lestringNoYou 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.gtstringNoYou can use this param to specify some date and the responses will contain phases whose date are greater than the given date.
dueDateActual.eqstringNoYou can use this param to specify some date and the responses will contain exact matches of phases that match the given date.
dueDateActual.ltstringNoYou can use this param to specify some date and the responses will contain phases whose date are less than the given date.
dueDateActual.gestringNoYou 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.lestringNoYou 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.gtintegerNoYou 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.eqintegerNoYou 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.ltintegerNoYou 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.geintegerNoYou 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.leintegerNoYou 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.gtintegerNoYou 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.eqintegerNoYou 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.ltintegerNoYou 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.geintegerNoYou 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.leintegerNoYou 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.eqstringNoYou can use this param to specify some phase name and the responses will contain exact matches of phases that match the given name.
phaseName.cnstringNoYou can use this param to specify some phase name and the responses will contain matches of phases that match the given name.
phaseName.ncstringNoYou can use this param to specify some phase name and the responses will not contain matches of phases that match the given name.

rocketlane_projects_get_all_projects

Get all projects Parameters:
ParameterTypeRequiredDefaultDescription
pageSizenumberNoThis 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.
pageTokenstringNoUse 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[]NoThis 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.
includeAllFieldsbooleanNoThis 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.
sortBystringNoFor sorting the responses by the provided field, use the sortBy parameter.
sortOrderstringNoThe sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.
matchstringNoYou can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.
startDate.gtstringNoYou can use this param to provide a date and the responses will contain projects whose date are greater than the given start date.
startDate.eqstringNoYou can use this param to provide a date and the responses will contain exact matches of projects that match the given start date.
startDate.ltstringNoYou can use this param to provide a date and the responses will contain projects whose date are less than the given start date.
startDate.gestringNoYou 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.lestringNoYou 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.gtstringNoYou can use this param to provide a date and the responses will contain projects whose date are greater than the given due date.
dueDate.eqstringNoYou can use this param to provide a date and the responses will contain exact matches of projects that match the given due date.
dueDate.ltstringNoYou can use this param to provide a date and the responses will contain projects whose date are less than the given due date.
dueDate.gestringNoYou 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.lestringNoYou 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.gtstringNoYou 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.eqstringNoYou 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.ltstringNoYou 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.gestringNoYou 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.lestringNoYou 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.gtstringNoYou 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.eqstringNoYou 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.ltstringNoYou 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.gestringNoYou 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.lestringNoYou 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.gtintegerNoYou 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.eqintegerNoYou 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.ltintegerNoYou 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.geintegerNoYou 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.leintegerNoYou 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.gtintegerNoYou 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.eqintegerNoYou 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.ltintegerNoYou 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.geintegerNoYou 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.leintegerNoYou 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.eqnumberNoYou 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.gtnumberNoYou 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.ltnumberNoYou 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.eqnumberNoYou 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.gtnumberNoYou 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.ltnumberNoYou 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.eqstringNoYou 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.oneOfstringNoYou 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.noneOfstringNoYou 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.eqstringNoYou 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.oneOfstringNoYou 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.noneOfstringNoYou 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.eqstringNoYou 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.oneOfstringNoYou 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.noneOfstringNoYou 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.eqstringNoYou can use this param to specify some project name and the responses will contain exact matches of projects that match the given name.
projectName.cnstringNoYou can use this param to specify some project name and the responses will contain matches of projects that match the given name.
projectName.ncstringNoYou can use this param to specify some project name and the responses will not contain matches of projects that match the given name.
inferredProgress.eqstring[]NoYou can use this param to provide a inferred progress and the responses will contain exact matches of projects that match the given inferred progress.
contractType.eqstring[]NoYou 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.oneOfstring[]NoYou 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.noneOfstring[]NoYou 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.
budgetedHours.gtstringNoYou 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.eqstringNoYou 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.ltstringNoYou 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.gestringNoYou 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.lestringNoYou 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.gtstringNoYou 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.eqstringNoYou 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.ltstringNoYou 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.gestringNoYou 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.gtstringNoYou 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.eqstringNoYou 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.ltstringNoYou 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.gestringNoYou 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.lestringNoYou 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.gtstringNoYou 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.eqstringNoYou 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.ltstringNoYou 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.gestringNoYou 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.lestringNoYou 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.eqbooleanNoYou can use this parameter to specify whether responses will include the archived projects.
status.eqstringNoYou can use this param to provide status and the responses will contain projects that are equal to the given status
status.oneOfstringNoYou can use this param to provide statuses and the responses will contain projects that match one of the given statuses
status.noneOfstringNoYou can use this param to provide statuses and the responses will contain projects that matches none of the given statuses
externalReferenceId.eqstringNoYou can use this param to provide external reference id and the responses will contain projects that are equal to the given id

rocketlane_projects_get_all_space_documents

Get all space documents Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesYou can use this param to specify some value as project id and the responses will contain exact matches of space documents that match the given value.
pageSizenumberNoThis 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.
pageTokenstringNoUse 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.
sortBystringNoYou can use the sortBy param to sort the responses by the given field.
sortOrderstringNoThe sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.
matchstringNoYou can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.
spaceDocumentName.eqstringNoYou can use this param to specify some space document name and the responses will contain exact matches of space documents that match the given name.
spaceDocumentName.cnstringNoYou can use this param to specify some space document name and the responses will contain matches of space documents that match the given name.
spaceDocumentName.ncstringNoYou can use this param to specify some space document name and the responses will not contain matches of space documents that match the given name.
createdAt.gtintegerNoYou can use this param to provide an epoch milli value and the responses will contain space documents whose date are greater than the given space documents created date.
createdAt.eqintegerNoYou can use this param to provide an epoch milli value and the responses will contain exact matches of space documents that match the given space documents created date.
createdAt.ltintegerNoYou can use this param to provide an epoch milli value and the responses will contain space documents whose date are less than the given space documents created date.
createdAt.geintegerNoYou can use this param to provide an epoch milli value and the responses will contain space documents whose date are greater than or equal to the given space documents created date.
createdAt.leintegerNoYou can use this param to provide an epoch milli value and the responses will contain space documents whose date are less than or equal to the given space documents created date.
updatedAt.gtintegerNoYou can use this param to provide an epoch milli value and the responses will contain space documents whose date are greater than the given space documents updated date.
updatedAt.eqintegerNoYou can use this param to provide an epoch milli value and the responses will contain exact matches of space documents that match the given space documents updated date.
updatedAt.ltintegerNoYou can use this param to provide an epoch milli value and the responses will contain space documents whose date are less than the given space documents updated date.
updatedAt.geintegerNoYou can use this param to provide an epoch milli value and the responses will contain space documents whose date are greater than or equal to the given space documents updated date.
updatedAt.leintegerNoYou can use this param to provide an epoch milli value and the responses will contain space documents whose date are less than or equal to the given space documents updated date.
spaceId.eqnumberNoYou can use this param to specify some value as space id and the responses will contain exact matches of space documents that match the given value.

rocketlane_projects_get_all_spaces

Get all spaces Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesYou can use this param to specify some value as project id and the responses will contain exact matches of spaces that match the given value.
pageSizenumberNoThis 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.
pageTokenstringNoUse 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.
sortBystringNoYou can use the sortBy param to sort the responses by the given field.
sortOrderstringNoThe sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.
matchstringNoYou can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.
spaceName.eqstringNoYou can use this param to specify some space name and the responses will contain exact matches of spaces that match the given name.
spaceName.cnstringNoYou can use this param to specify some space name and the responses will contain matches of spaces that match the given name.
spaceName.ncstringNoYou can use this param to specify some space name and the responses will not contain matches of spaces that match the given name.
createdAt.gtintegerNoYou can use this param to provide an epoch milli value and the responses will contain spaces whose date are greater than the given spaces created date.
createdAt.eqintegerNoYou can use this param to provide an epoch milli value and the responses will contain exact matches of spaces that match the given spaces created date.
createdAt.ltintegerNoYou can use this param to provide an epoch milli value and the responses will contain spaces whose date are less than the given spaces created date.
createdAt.geintegerNoYou can use this param to provide an epoch milli value and the responses will contain spaces whose date are greater than or equal to the given spaces created date.
createdAt.leintegerNoYou can use this param to provide an epoch milli value and the responses will contain spaces whose date are less than or equal to the given spaces created date.
updatedAt.gtintegerNoYou can use this param to provide an epoch milli value and the responses will contain spaces whose date are greater than the given spaces updated date.
updatedAt.eqintegerNoYou can use this param to provide an epoch milli value and the responses will contain exact matches of spaces that match the given spaces updated date.
updatedAt.ltintegerNoYou can use this param to provide an epoch milli value and the responses will contain spaces whose date are less than the given spaces updated date.
updatedAt.geintegerNoYou can use this param to provide an epoch milli value and the responses will contain spaces whose date are greater than or equal to the given spaces updated date.
updatedAt.leintegerNoYou can use this param to provide an epoch milli value and the responses will contain spaces whose date are less than or equal to the given spaces updated date.

rocketlane_projects_get_phase

Get phase by Id Parameters:
ParameterTypeRequiredDefaultDescription
phaseIdintegerYesThe identifier of the phase is generated by the system and can be used to identify the phase globally.
includeFieldsstring[]NoThis 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.
includeAllFieldsbooleanNoThis 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.

rocketlane_projects_get_placeholders

Get placeholders Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesProject Id

rocketlane_projects_get_project

Get project by Id Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.
includeFieldsstring[]NoThis 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.
includeAllFieldsbooleanNoThis 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.

rocketlane_projects_get_space

Get space by Id Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdintegerYesThe space’s unique, system-generated identifier, which can be used to identify the space globally.

rocketlane_projects_get_space_document

Get space document by Id Parameters:
ParameterTypeRequiredDefaultDescription
spaceDocumentIdintegerYesThe space document’s unique, system-generated identifier, which can be used to identify the space document globally.

rocketlane_projects_import_template

Import a template to a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.
bodyobject[]YesRequest body

rocketlane_projects_remove_members

Remove members from a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.
membersobject[]YesThe team members from your organization working on the project.

rocketlane_projects_unassign_placeholders

Un assign placeholders from an user in a project Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.
bodyobject[]YesRequest body

rocketlane_projects_update_phase

Update phase by Id Parameters:
ParameterTypeRequiredDefaultDescription
phaseIdintegerYesThe identifier of the phase is generated by the system and can be used to identify the phase globally.
includeFieldsstring[]NoThis 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.
includeAllFieldsbooleanNoThis 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.
dueDatestringNoThe day on which the phase’s execution is planned to be completed. The dueDate must be on or after the given startDate. The format for the due date is YYYY-MM-DD.
phaseNamestringNoThe name of the phase. The name specified will be displayed everywhere else and can be used for filtering purposes.
privatebooleanNoDescribes the privacy of the phase i.e. if it is private or shared.
startDatestringNoOn this date the phase’s execution officially begins. The format for the start date is YYYY-MM-DD.
statusobjectNoThe value of the phase status can be specified here and this is essential to keep track of the phase.

rocketlane_projects_update_project

Update project by Id Parameters:
ParameterTypeRequiredDefaultDescription
projectIdintegerYesThe project’s unique, system-generated identifier, which can be used to identify the project globally.
includeFieldsstring[]NoThis 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.
includeAllFieldsbooleanNoThis 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.
annualizedRecurringRevenueintegerNoIndicates the value of the recurring revenue of the customer’s subscriptions for a single calendar year.
autoAllocationbooleanNoThe field autoAllocation defines whether Auto Allocation is enabled for the project or not. If auto allocation is enabled, instead of adding it manually, the allocations are computed from the tasks duration, effort and the assignees specified in the project.
budgetedHoursnumberNoBudgeted hours represent the total hours allocated for project execution. This value can be edited at any point throughout the project’s duration. You can enter the budgeted hours in decimal form, including both hours and minutes, with up to two decimal places of precision. Eg: 1.65 hrs = 1h 39m(1.65h * 60m = 99m).
dueDatestringNoThe day on which the project’s execution is planned to be completed. The due date is not required and can be left blank. If sources (templates) are included as part of the project creation, the project’s due date will be calculated depending on the duration of the specified sources. For projects where both startDate and dueDate are specified, the latter must be on or after the given startDate. The format for the due date is YYYY-MM-DD.
externalReferenceIdstringNoAn externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.
fieldsobject[]NoThe custom fields can be set during the project creation with the help of fields. The fieldValue can be either a string or a number or an array and it has to comply with the type of the field. Refer examples to know how to assign fieldValue based on their field_type.
ownerobjectNoThe project owner gets access to everything in the project and can be used to control the activities that happens in the project. Note: Changing the owner can result in transfer of ownership from the older member to the specified member. All the access for the older member will be revoked.
projectFeeintegerNoThe total fee that is charged for the project.
projectNamestringNoThe name of the project. The name specified will be displayed everywhere else and can be used for filtering purposes.
startDatestringNoOn this date the project’s execution officially begins. If sources (templates) are mentioned in the request, the start date is required. For projects without any defined sources, it may be empty. The format for the start date is YYYY-MM-DD.
statusobjectNoThe value of the project status can be specified here and this is essential to keep track of the project.
visibilitystringNoSet visibility parameters to restrict who can see your project. There are two options: EVERYONE and MEMBERS. Selecting EVERYONE allows all team members from your firm to view the project, while selecting MEMBERS restricts access to only those team members who have been specifically invited.

rocketlane_projects_update_space

Update space by Id Parameters:
ParameterTypeRequiredDefaultDescription
spaceIdintegerYesThe space’s unique, system-generated identifier, which can be used to identify the space globally.
spaceNamestringNoThe name of the space.

rocketlane_projects_update_space_document

Update space document by Id Parameters:
ParameterTypeRequiredDefaultDescription
spaceDocumentIdintegerYesThe space document’s unique, system-generated identifier, which can be used to identify the space document globally.
spaceDocumentNamestringNoThe name of the space document.
urlstringNoThe url that is embedded in the space document.