Rocketlane
App · 25 actions
Manage onboarding projects, tasks, companies, phases and time entries.
Actions
| Action | What it does |
|---|---|
| Create company | Create a company. |
| Create phase | Create a phase. |
| Create project | Create a project. |
| Create task | Create a task. |
| Create time entry | Create a time entry. |
| Delete company | Delete company by Id. |
| Delete project | Delete project by Id. |
| Delete task | Delete task by Id. |
| Delete time entry | Delete a time entry. |
| Get company | Get company by Id. |
| Get phase | Get phase by Id. |
| Get project | Get project by Id. |
| Get task | Get task by Id. |
| Get time entry | Get a time entry. |
| Get user | Get user by Id. |
| List companies | Get all companies. |
| List phases | Get all phases. |
| List projects | Get all projects. |
| List tasks | Get all tasks. |
| List time entries | Get all time entries. |
| List users | Get all users. |
| Update company | Update company by Id. |
| Update project | Update project by Id. |
| Update task | Update task by Id. |
| Update time entry | Update a time entry. |
Create company
Create a company.
Inputs
- Include fields
include_fieldslist - Use this query parameter to opt in for companies to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.One or more of:
companyUrl,notes. - Include all fields
include_all_fieldstrue/false - 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.
- Company name
company_nametextRequired - The name of the company
- Company url
company_urltext - The URL of the client's website. Unless explicitly stated, the value for this field can be left blank
- Visibility
visibilitytext - Set visibility parameters to restrict who can see your company. On create/update there are two options: `EVERYONE` and `MEMBERS` (same as projects). Selecting `EVERYONE` allows all team members from your firm to view the company, while selecting `MEMBERS` restricts access to only those team members who have been specifically invited.One of:
EVERYONE,MEMBERS. - Description
descriptiontext - A detailed description or notes about the company.
- Owner
owner_idtextRequired - The unique identifier for the account owner.
- Fields
fieldslist - Custom fields to set on the company account.
- Notes
noteslist - Notes to create on this company during company creation. To add notes later, use POST /1.0/companies/{companyId}/add-notes.
Outputs
dataobject- Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response.
Example output
{
"data": {
"accountOwner": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"companyId": 1,
"companyName": "example",
"companyUrl": "example",
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"description": "example",
"fields": [],
"notes": [],
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"visibility": "EVERYONE"
}
}Create phase
Create a phase.
Inputs
- Include fields
include_fieldslist - 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.One or more of:
startDateActual,dueDateActual,budgets. - Include all fields
include_all_fieldstrue/false - 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.
- Phase name
phase_nametextRequired - The `name` of the phase. The name specified will be displayed everywhere else and can be used for filtering purposes.
- Project
project_idtextRequired - The `identifier` of the project is generated by the system and can be used to identify the project globally.
- Phase description
phase_descriptiontext - An optional `description` of the phase providing additional context.
- Start date
start_datedateRequired - On this date the phase's execution officially begins. The start date is required. The format for the start date is _YYYY-MM-DD_.
- Due date
due_datedateRequired - The 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_.
- Status
statusobject - The value of the phase status can be specified here and this is essential to keep track of the phase.
- Private
privatetrue/false - Describes the privacy of the phase i.e. if it is private or shared.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"budgets": [],
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"dueDate": "example",
"dueDateActual": "example",
"phaseDescription": "example",
"phaseId": 1,
"phaseName": "example",
"private": false,
"project": {
"projectId": 1,
"projectName": "example"
},
"startDate": "example",
"startDateActual": "example",
"status": {
"label": "example",
"value": 1
},
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
}
}
}Create project
Create a project.
Inputs
- Include fields
include_fieldslist - 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.One or more of:
annualizedRecurringRevenue,projectFee,allocatedHours,allocatedMinutes,budgetedHours,percentageBudgetedHoursConsumed,percentageBudgetConsumed,billableHours,billableMinutes,nonBillableHours, and 18 more. - Include all fields
include_all_fieldstrue/false - 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.
- Project name
project_nametextRequired - The `name` of the project. The name specified will be displayed everywhere else and can be used for filtering purposes.
- Start date
start_datedate - On 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_.
- Due date
due_datedate - The 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_.
- Visibility
visibilitytext - Set 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.One of:
EVERYONE,MEMBERS. - Owner
owner_idtextRequired - The unique identifier for project owner.
- Team members
team_membersobject - The 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.
- Status
statusobject - The value of the project status can be specified here and this is essential to keep track of the project.
- Fields
fieldslist - The 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](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`.
- Customer name
customer_nametextRequired - The name of the customer company
- Partners
partnerslist - The `partners` field is used to specify partner companies.
- Sources
sourceslist - Sources denotes the project templates involved in creation/ imported post creation of the `project`.
- Assign project owner
assign_project_ownertrue/false - When 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.
- Placeholders
placeholderslist - Rocketlane'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.
- Annualized recurring revenue
annualized_recurring_revenuenumber - Indicates the value of the recurring revenue of the customer's subscriptions for a single calendar year.
- Project fee
project_feenumber - The total fee that is charged for the project.
- Auto allocation
auto_allocationtrue/false - The 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.
- Auto create company
auto_create_companytrue/false - The 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.
- Budgeted hours
budgeted_hoursnumber - Budgeted 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).At least 0.
- Financials
financialsobject - This section addresses the financial aspects of the projects and the associated fields.
- Currency
currencytext - The 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.One of:
AFN,ALL,DZD,ARS,AMD,AUD,AZN,BHD,BDT,BYN, and 109 more. - External reference id
external_reference_idtext - An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"allocatedHours": 1,
"allocatedMinutes": 1.0,
"annualizedRecurringRevenue": 1,
"archived": false,
"autoAllocation": false,
"billableHours": 1,
"billableMinutes": 1.0,
"budgetedHours": 1.0,
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"currency": "AFN",
"currentPhases": [],
"customer": {
"companyId": 1,
"companyName": "example",
"companyUrl": "example"
},
"customersInvited": 1,
"customersJoined": 1,
"dueDate": "example",
"dueDateActual": "example",
"externalReferenceId": "example",
"fields": [],
"financials": {
"contractType": "FIXED_FEE",
"fixedFeeContract": {
"fixedFee": 1.0
},
"metrics": {
"actualCost": 1.0,
"actualProfit": 1.0,
"actualProfitMargin": 1.0,
"actualRevenue": 1.0,
"estimateAtCompletion": 1.0,
"estimatedCost": 1.0,
"estimatedProfit": 1.0,
"estimatedProfitMargin": 1.0,
"estimatedRevenue": 1.0,
"estimationToCompletionInHours": 1.0
},
"revenueRecognitionType": "example",
"subscriptionContract": {
"noOfPeriods": 1,
"periodBudget": 1.0,
"periodMinutes": 1,
"subscriptionFrequency": "MONTHLY",
"subscriptionStartDate": "example"
},
"timeAndMaterialContract": {
"projectBudget": 1.0,
"rateCard": {
"rateCardId": 1,
"rateCardName": "example"
}
}
},
"inferredProgress": "ON_TRACK",
"nonBillableHours": 1,
"nonBillableMinutes": 1.0,
"owner": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"partnerCompanies": [],
"percentageBudgetConsumed": 1.0,
"percentageBudgetedHoursConsumed": 1.0,
"plannedDurationInDays": 1,
"progressPercentage": 1,
"projectAgeInDays": 1,
"projectFee": 1,
"projectId": 1,
"projectName": "example",
"remainingHours": 1,
"remainingMinutes": 1,
"sources": [],
"startDate": "example",
"startDateActual": "example",
"status": {
"label": "example",
"value": 1
},
"teamMembers": {
"customerChampion": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"customers": [],
"members": []
},
"trackedHours": 1,
"trackedMinutes": 1.0,
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"visibility": "EVERYONE"
}
}Create task
Create a task.
Inputs
- Include fields
include_fieldslist - 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.One or more of:
startDateActual,dueDateActual,type,phase,assignees,followers,dependencies,billable,csatEnabled,priority, and 5 more. - Include all fields
include_all_fieldstrue/false - 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.
- Task name
task_nametextRequired - The **name** of the task.
- Task description
task_descriptiontext - The `description` of the task. The description body needs to be in **html** format to avoid any formatting issues in the application.
- Task private note
task_private_notetext - The `privateNote` for the task is intended exclusively for team members. The note's content should be in `HTML` format to prevent any formatting issues in the application.
- Start date
start_datedate - The date when a task starts its execution. It can be empty. The format for the start date is _YYYY-MM-DD_.
- Due date
due_datedate - The date when a task completes its execution. It can be empty. If both `startDate` and `dueDate` are specified for a given task, it is necessary that the latter should be on or after the given `startDate`. The format for the due date is _YYYY-MM-DD_.
- Effort in minutes
effort_in_minutesnumber - The effort is the expected time required to complete the task. The value is determined in minutes.
- Progress
progressnumber - The task's progress, if indicated, will be available here and ranges in value from 0 to 100. The task's status can be used in place of this field, however progress can offer more precise data.
- At risk
at_risktrue/false - Indicates whether the task has been marked as At Risk. This parameter is used to indicate that immediate action is necessary to unblock the task's execution.
- Type
typetext - The type of the task if specified will be available here. There are two options: `MILESTONE` or `TASK`. If a task is not explicitly marked as a milestone, it takes the default value as `TASK`. Milestones refer to critical tasks in the project that include an inbuilt CSAT capability that allows customers to offer CSAT evaluations depending on the task's execution.One of:
TASK,MILESTONE. - Project
project_idtextRequired - The `identifier` of the project is generated by the system and can be used to identify the project globally.
- Phase
phase_idtext - The unique identifier for the phase.
- Status
statusobject - The value of the task status can be specified here and this is essential to keep track of it.
- Fields
fieldslist - The custom fields can be set during the task 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](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`.
- Assignees
assigneesobject - Assignees.
- Followers
followersobject - The task followers can be either `members` (team members or customers) or `placeholders`.
- Parent
parentobject - Parent task id
- External reference id
external_reference_idtext - An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.
- Source
sourceobject - Source information for importing a task from a template
- Private
privatetrue/false - This depicts if the task is private or not.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"archived": false,
"assignees": {
"members": [],
"placeholders": []
},
"atRisk": false,
"billable": false,
"budgets": [],
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"csatEnabled": false,
"dependencies": [],
"dueDate": "example",
"dueDateActual": "example",
"effortInMinutes": 1,
"externalReferenceId": "example",
"fields": [],
"followers": {
"members": [],
"placeholders": []
},
"parent": {
"taskId": 1,
"taskName": "example"
},
"phase": {
"phaseId": 1,
"phaseName": "example"
},
"priority": {
"label": "example",
"value": 1
},
"private": false,
"progress": 1,
"project": {
"projectId": 1,
"projectName": "example"
},
"revRecRecognisedAmount": 1.0,
"revRecRecognisedPercentage": 1.0,
"revenueRecognitionDetails": [],
"revenueRecognitionTask": false,
"startDate": "example",
"startDateActual": "example",
"status": {
"label": "example",
"value": 1
},
"taskDescription": "example",
"taskId": 1,
"taskName": "example",
"taskPrivateNote": "example",
"timeEntryCategory": {
"categoryId": 1,
"categoryName": "example"
},
"totalAllocatedMins": 1,
"type": "TASK",
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
}
}
}Create time entry
Create a time entry.
Inputs
- Include fields
include_fieldslist - 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.One or more of:
notes,sourceType,deleted,status,submittedBy,submittedAt,approvedBy,approvedAt,rejectedBy,rejectedAt,costRate,billRate. - Include all fields
include_all_fieldstrue/false - 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.
- Date
datedateRequired - Date of the time entry in format YYYY-MM-DD
- Minutes
minutesnumberRequired - Duration of the time entry in minutesFrom 1 to 1440.
- Activity name
activity_nametext - Name of the adhoc activity being performed
- Project
project_idtext - The unique identifier for the project.
- Task id
task_idtext - The task’s unique, system-generated identifier, which can be used to identify the task globally.
- Project phase
project_phaseobject - Project phase associated with the time entry
- Billable
billabletrue/false - Whether the time entry is billable. Defaults to trueDefault:
true. - User
app_user_idtext - User associated with the time entry
- Notes
notestext - Notes for the time entry
- Category
categoryobject - Category associated with the time entry
- Budget
budgetobject - The financials budget associated with this time entry.
- Fields
fieldslist - The custom fields can be set during the time-entry 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](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"activityName": "example",
"approvedAt": 1,
"approvedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"billRate": {
"currency": "example",
"rate": 1.0
},
"billable": false,
"budget": {
"budgetId": 1,
"budgetName": "example"
},
"category": {
"categoryId": 1,
"categoryName": "example"
},
"costRate": {
"currency": "example",
"rate": 1.0
},
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"date": "example",
"deleted": false,
"fields": [],
"minutes": 1,
"notes": "example",
"project": {
"projectId": 1,
"projectName": "example"
},
"projectPhase": {
"phaseId": 1,
"phaseName": "example"
},
"rejectedAt": 1,
"rejectedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"sourceType": "GOOGLE_CALENDAR",
"status": "NOT_SUBMITTED",
"submittedAt": 1,
"submittedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"task": {
"taskId": 1,
"taskName": "example"
},
"timeEntryId": 1,
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"user": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
}
}
}Delete company
Delete company by Id.
Inputs
- Company
company_idtextRequired - The company's unique, system-generated identifier, which can be used to identify the company globally.
Outputs
datatext- Rocketlane response data.
Example output
{
"data": "example"
}Delete project
Delete project by Id.
Inputs
- Project
project_idtextRequired - The project's unique, system-generated identifier, which can be used to identify the project globally.
Outputs
datatext- Rocketlane response data.
Example output
{
"data": "example"
}Delete task
Delete task by Id.
Inputs
- Task id
task_idtextRequired - The ID of the task object
Outputs
datatext- Rocketlane response data.
Example output
{
"data": "example"
}Delete time entry
Delete a time entry.
Inputs
- Time entry id
time_entry_idtextRequired - The unique, system-generated identifier, which can be used to identify the time entry globally.
Outputs
datatext- Rocketlane response data.
Example output
{
"data": "example"
}Get company
Get company by Id.
Inputs
- Company
company_idtextRequired - The company's unique, system-generated identifier, which can be used to identify the company globally.
- Include fields
include_fieldslist - Use this query parameter to opt in for companies to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.One or more of:
companyUrl,notes. - Include all fields
include_all_fieldstrue/false - 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.
Outputs
dataobject- Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response.
Example output
{
"data": {
"accountOwner": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"companyId": 1,
"companyName": "example",
"companyUrl": "example",
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"description": "example",
"fields": [],
"notes": [],
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"visibility": "EVERYONE"
}
}Get phase
Get phase by Id.
Inputs
- Phase
phase_idtextRequired - The `identifier` of the phase is generated by the system and can be used to identify the phase globally.
- Include fields
include_fieldslist - 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.One or more of:
startDateActual,dueDateActual,budgets. - Include all fields
include_all_fieldstrue/false - 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.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"budgets": [],
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"dueDate": "example",
"dueDateActual": "example",
"phaseDescription": "example",
"phaseId": 1,
"phaseName": "example",
"private": false,
"project": {
"projectId": 1,
"projectName": "example"
},
"startDate": "example",
"startDateActual": "example",
"status": {
"label": "example",
"value": 1
},
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
}
}
}Get project
Get project by Id.
Inputs
- Project
project_idtextRequired - The project's unique, system-generated identifier, which can be used to identify the project globally.
- Include fields
include_fieldslist - 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.One or more of:
annualizedRecurringRevenue,projectFee,allocatedHours,allocatedMinutes,budgetedHours,percentageBudgetedHoursConsumed,percentageBudgetConsumed,billableHours,billableMinutes,nonBillableHours, and 18 more. - Include all fields
include_all_fieldstrue/false - 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.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"allocatedHours": 1,
"allocatedMinutes": 1.0,
"annualizedRecurringRevenue": 1,
"archived": false,
"autoAllocation": false,
"billableHours": 1,
"billableMinutes": 1.0,
"budgetedHours": 1.0,
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"currency": "AFN",
"currentPhases": [],
"customer": {
"companyId": 1,
"companyName": "example",
"companyUrl": "example"
},
"customersInvited": 1,
"customersJoined": 1,
"dueDate": "example",
"dueDateActual": "example",
"externalReferenceId": "example",
"fields": [],
"financials": {
"contractType": "FIXED_FEE",
"fixedFeeContract": {
"fixedFee": 1.0
},
"metrics": {
"actualCost": 1.0,
"actualProfit": 1.0,
"actualProfitMargin": 1.0,
"actualRevenue": 1.0,
"estimateAtCompletion": 1.0,
"estimatedCost": 1.0,
"estimatedProfit": 1.0,
"estimatedProfitMargin": 1.0,
"estimatedRevenue": 1.0,
"estimationToCompletionInHours": 1.0
},
"revenueRecognitionType": "example",
"subscriptionContract": {
"noOfPeriods": 1,
"periodBudget": 1.0,
"periodMinutes": 1,
"subscriptionFrequency": "MONTHLY",
"subscriptionStartDate": "example"
},
"timeAndMaterialContract": {
"projectBudget": 1.0,
"rateCard": {
"rateCardId": 1,
"rateCardName": "example"
}
}
},
"inferredProgress": "ON_TRACK",
"nonBillableHours": 1,
"nonBillableMinutes": 1.0,
"owner": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"partnerCompanies": [],
"percentageBudgetConsumed": 1.0,
"percentageBudgetedHoursConsumed": 1.0,
"plannedDurationInDays": 1,
"progressPercentage": 1,
"projectAgeInDays": 1,
"projectFee": 1,
"projectId": 1,
"projectName": "example",
"remainingHours": 1,
"remainingMinutes": 1,
"sources": [],
"startDate": "example",
"startDateActual": "example",
"status": {
"label": "example",
"value": 1
},
"teamMembers": {
"customerChampion": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"customers": [],
"members": []
},
"trackedHours": 1,
"trackedMinutes": 1.0,
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"visibility": "EVERYONE"
}
}Get task
Get task by Id.
Inputs
- Task id
task_idtextRequired - The task's unique, system-generated identifier, which can be used to identify the task globally.
- Include fields
include_fieldslist - 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.One or more of:
startDateActual,dueDateActual,type,phase,assignees,followers,dependencies,billable,csatEnabled,priority, and 5 more. - Include all fields
include_all_fieldstrue/false - 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.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"archived": false,
"assignees": {
"members": [],
"placeholders": []
},
"atRisk": false,
"billable": false,
"budgets": [],
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"csatEnabled": false,
"dependencies": [],
"dueDate": "example",
"dueDateActual": "example",
"effortInMinutes": 1,
"externalReferenceId": "example",
"fields": [],
"followers": {
"members": [],
"placeholders": []
},
"parent": {
"taskId": 1,
"taskName": "example"
},
"phase": {
"phaseId": 1,
"phaseName": "example"
},
"priority": {
"label": "example",
"value": 1
},
"private": false,
"progress": 1,
"project": {
"projectId": 1,
"projectName": "example"
},
"revRecRecognisedAmount": 1.0,
"revRecRecognisedPercentage": 1.0,
"revenueRecognitionDetails": [],
"revenueRecognitionTask": false,
"startDate": "example",
"startDateActual": "example",
"status": {
"label": "example",
"value": 1
},
"taskDescription": "example",
"taskId": 1,
"taskName": "example",
"taskPrivateNote": "example",
"timeEntryCategory": {
"categoryId": 1,
"categoryName": "example"
},
"totalAllocatedMins": 1,
"type": "TASK",
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
}
}
}Get time entry
Get a time entry.
Inputs
- Time entry id
time_entry_idtextRequired - The unique, system-generated identifier, which can be used to identify the time entry globally.
- Include fields
include_fieldslist - 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.One or more of:
notes,sourceType,deleted,status,submittedBy,submittedAt,approvedBy,approvedAt,rejectedBy,rejectedAt,costRate,billRate. - Include all fields
include_all_fieldstrue/false - 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.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"activityName": "example",
"approvedAt": 1,
"approvedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"billRate": {
"currency": "example",
"rate": 1.0
},
"billable": false,
"budget": {
"budgetId": 1,
"budgetName": "example"
},
"category": {
"categoryId": 1,
"categoryName": "example"
},
"costRate": {
"currency": "example",
"rate": 1.0
},
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"date": "example",
"deleted": false,
"fields": [],
"minutes": 1,
"notes": "example",
"project": {
"projectId": 1,
"projectName": "example"
},
"projectPhase": {
"phaseId": 1,
"phaseName": "example"
},
"rejectedAt": 1,
"rejectedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"sourceType": "GOOGLE_CALENDAR",
"status": "NOT_SUBMITTED",
"submittedAt": 1,
"submittedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"task": {
"taskId": 1,
"taskName": "example"
},
"timeEntryId": 1,
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"user": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
}
}
}Get user
Get user by Id.
Inputs
- User
app_user_idtextRequired - The user's unique, system-generated identifier, which can be used to identify the user globally.
- Include fields
include_fieldslist - 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.One or more of:
role,company,permission,holidayCalendar,capacityInMinutes,profilePictureUrl. - Include all fields
include_all_fieldstrue/false - 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.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"capacityInMinutes": 1,
"company": {
"companyId": 1,
"companyName": "example"
},
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"email": "example",
"fields": [],
"firstName": "example",
"holidayCalendar": {
"calenderId": 1,
"calenderName": "example"
},
"lastName": "example",
"permission": {
"permissionId": 1,
"permissionName": "example"
},
"profilePictureUrl": "example",
"role": {
"roleId": 1,
"roleName": "example"
},
"status": "INACTIVE",
"type": "TEAM_MEMBER",
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"userId": 1
}
}List companies
Get all companies.
Inputs
- Page size
page_sizenumber - 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.At least 0.
- Page token
page_tokentext - 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.
- Include fields
include_fieldslist - Use this query parameter to opt in for companies to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.One or more of:
companyUrl,notes. - Include all fields
include_all_fieldstrue/false - 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.
- Sort by
sort_bytext - You can use the sortBy param to sort the responses by the given field.One of:
companyName,createdAt,updatedAt. - Sort order
sort_ordertext - The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.One of:
ASC,DESC. - Match
matchtext - You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.One of:
all,any. - Company name eq
company_name_eqtext - You can use this param to specify some company name and the responses will contain exact matches of companies that match the given name.
- Company name cn
company_name_cntext - You can use this param to specify some company name and the responses will contain matches of companies that match the given name.
- Company name nc
company_name_nctext - You can use this param to specify some company name and the responses will not contain matches of companies that match the given name.
- Company url eq
company_url_eqtext - You can use this param to specify a company URL and the responses will contain exact matches of companies that match the given URL.
- Company url cn
company_url_cntext - You can use this param to specify a company URL substring and the responses will contain companies whose URL contains the given value.
- Company url nc
company_url_nctext - You can use this param to specify a company URL substring and the responses will not contain companies whose URL contains the given value.
- Account owner eq
account_owner_eqtext - You can use this param to filter companies by account owner userId (exact match).
- Account owner one of
account_owner_one_oftext - You can use this param to filter companies whose account owner userId is one of the given comma-separated userIds.
- Account owner none of
account_owner_none_oftext - You can use this param to filter companies whose account owner userId is none of the given comma-separated userIds.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"data": [],
"pagination": {
"hasMore": false,
"nextPage": "example",
"nextPageToken": "example",
"pageSize": 1,
"totalRecordCount": 1
}
}
}List phases
Get all phases.
Inputs
- Project
project_idtextRequired - The `identifier` of the project is generated by the system and can be used to identify the project globally.
- Page size
page_sizenumber - 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.At least 0.
- Page token
page_tokentext - 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.
- Include fields
include_fieldslist - 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.One or more of:
startDateActual,dueDateActual,budgets. - Include all fields
include_all_fieldstrue/false - 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.
- Sort by
sort_bytext - You can use the sortBy param to sort the responses by the given field.One of:
phaseName,startDate,dueDate,startDateActual,dueDateActual. - Sort order
sort_ordertext - The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.One of:
ASC,DESC. - Match
matchtext - You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.One of:
all,any. - Start date gt
start_date_gtdate - You can use this param to specify some date and the responses will contain phases whose date are greater than the given date.
- Start date eq
start_date_eqdate - You can use this param to specify some date and the responses will contain exact matches of phases that match the given date.
- Start date lt
start_date_ltdate - You can use this param to specify some date and the responses will contain phases whose date are less than the given date.
- Start date ge
start_date_gedate - 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.
- Start date le
start_date_ledate - 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.
- Due date gt
due_date_gtdate - You can use this param to specify some date and the responses will contain phases whose date are greater than the given date.
- Due date eq
due_date_eqdate - You can use this param to specify some date and the responses will contain exact matches of phases that match the given date.
- Due date lt
due_date_ltdate - You can use this param to specify some date and the responses will contain phases whose date are less than the given date.
- Due date ge
due_date_gedate - 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.
- Due date le
due_date_ledate - 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.
- Start date actual gt
start_date_actual_gtdate - You can use this param to specify some date and the responses will contain phases whose date are greater than the given date.
- Start date actual eq
start_date_actual_eqdate - You can use this param to specify some date and the responses will contain exact matches of phases that match the given date.
- Start date actual lt
start_date_actual_ltdate - You can use this param to specify some date and the responses will contain phases whose date are less than the given date.
- Start date actual ge
start_date_actual_gedate - 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.
- Start date actual le
start_date_actual_ledate - 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.
- Due date actual gt
due_date_actual_gtdate - You can use this param to specify some date and the responses will contain phases whose date are greater than the given date.
- Due date actual eq
due_date_actual_eqdate - You can use this param to specify some date and the responses will contain exact matches of phases that match the given date.
- Due date actual lt
due_date_actual_ltdate - You can use this param to specify some date and the responses will contain phases whose date are less than the given date.
- Due date actual ge
due_date_actual_gedate - 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.
- Due date actual le
due_date_actual_ledate - 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.
- Created at gt
created_at_gtdate and time - 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.
- Created at eq
created_at_eqdate and time - 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.
- Created at lt
created_at_ltdate and time - 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.
- Created at ge
created_at_gedate and time - 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.
- Created at le
created_at_ledate and time - 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.
- Updated at gt
updated_at_gtdate and time - 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.
- Updated at eq
updated_at_eqdate and time - 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.
- Updated at lt
updated_at_ltdate and time - 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.
- Updated at ge
updated_at_gedate and time - 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.
- Updated at le
updated_at_ledate and time - 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.
- Phase name eq
phase_name_eqtext - You can use this param to specify some phase name and the responses will contain exact matches of phases that match the given name.
- Phase name cn
phase_name_cntext - You can use this param to specify some phase name and the responses will contain matches of phases that match the given name.
- Phase name nc
phase_name_nctext - You can use this param to specify some phase name and the responses will not contain matches of phases that match the given name.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"data": [],
"pagination": {
"hasMore": false,
"nextPage": "example",
"nextPageToken": "example",
"pageSize": 1,
"totalRecordCount": 1
}
}
}List projects
Get all projects.
Inputs
- Page size
page_sizenumber - 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.At least 0.
- Page token
page_tokentext - 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.
- Include fields
include_fieldslist - 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.One or more of:
annualizedRecurringRevenue,projectFee,allocatedHours,allocatedMinutes,budgetedHours,percentageBudgetedHoursConsumed,percentageBudgetConsumed,billableHours,billableMinutes,nonBillableHours, and 18 more. - Include all fields
include_all_fieldstrue/false - 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.
- Sort by
sort_bytext - For sorting the responses by the provided field, use the sortBy parameter.One of:
projectName,startDate,dueDate,startDateActual,dueDateActual,annualizedRecurringRevenue,projectFee. - Sort order
sort_ordertext - The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.One of:
ASC,DESC. - Match
matchtext - You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.One of:
all,any. - Start date gt
start_date_gtdate - You can use this param to provide a date and the responses will contain projects whose date are greater than the given start date.
- Start date eq
start_date_eqdate - You can use this param to provide a date and the responses will contain exact matches of projects that match the given start date.
- Start date lt
start_date_ltdate - You can use this param to provide a date and the responses will contain projects whose date are less than the given start date.
- Start date ge
start_date_gedate - 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.
- Start date le
start_date_ledate - 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.
- Due date gt
due_date_gtdate - You can use this param to provide a date and the responses will contain projects whose date are greater than the given due date.
- Due date eq
due_date_eqdate - You can use this param to provide a date and the responses will contain exact matches of projects that match the given due date.
- Due date lt
due_date_ltdate - You can use this param to provide a date and the responses will contain projects whose date are less than the given due date.
- Due date ge
due_date_gedate - 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.
- Due date le
due_date_ledate - 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.
- Start date actual gt
start_date_actual_gtdate - 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.
- Start date actual eq
start_date_actual_eqdate - 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.
- Start date actual lt
start_date_actual_ltdate - 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.
- Start date actual ge
start_date_actual_gedate - 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.
- Start date actual le
start_date_actual_ledate - 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.
- Due date actual gt
due_date_actual_gtdate - 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.
- Due date actual eq
due_date_actual_eqdate - 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.
- Due date actual lt
due_date_actual_ltdate - 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.
- Due date actual ge
due_date_actual_gedate - 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.
- Due date actual le
due_date_actual_ledate - 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.
- Created at gt
created_at_gtdate and time - 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.
- Created at eq
created_at_eqdate and time - 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.
- Created at lt
created_at_ltdate and time - 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.
- Created at ge
created_at_gedate and time - 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.
- Created at le
created_at_ledate and time - 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.
- Updated at gt
updated_at_gtdate and time - 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.
- Updated at eq
updated_at_eqdate and time - 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.
- Updated at lt
updated_at_ltdate and time - 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.
- Updated at ge
updated_at_gedate and time - 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.
- Updated at le
updated_at_ledate and time - 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.
- Annualized recurring revenue eq
annualized_recurring_revenue_eqnumber - 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.
- Annualized recurring revenue gt
annualized_recurring_revenue_gtnumber - 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.
- Annualized recurring revenue lt
annualized_recurring_revenue_ltnumber - 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.
- Project fee eq
project_fee_eqnumber - 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.
- Project fee gt
project_fee_gtnumber - 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.
- Project fee lt
project_fee_ltnumber - 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.
- Customer id eq
customer_id_eqtext - 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.
- Customer id one of
customer_id_one_oftext - 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.
- Customer id none of
customer_id_none_oftext - 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.
- Team member id eq
team_member_id_eqtext - 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.
- Team member id one of
team_member_id_one_oftext - 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.
- Team member id none of
team_member_id_none_oftext - 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.
- Company id eq
company_id_eqtext - 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.
- Company id one of
company_id_one_oftext - 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.
- Company id none of
company_id_none_oftext - 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.
- Project name eq
project_name_eqtext - You can use this param to specify some project name and the responses will contain exact matches of projects that match the given name.
- Project name cn
project_name_cntext - You can use this param to specify some project name and the responses will contain matches of projects that match the given name.
- Project name nc
project_name_nctext - You can use this param to specify some project name and the responses will not contain matches of projects that match the given name.
- Inferred progress eq
inferred_progress_eqlist - 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.One or more of:
ON_TRACK(On track),AHEAD_OF_TIME(Ahead of time),RUNNING_LATE(Running late),NONE. - Contract type eq
contract_type_eqlist - You can use this param to provide a contract type and the responses will contain exact matches of projects that match the given contract typeOne or more of:
FIXED_FEE(Fixed fee),TIME_AND_MATERIAL(Time and material),SUBSCRIPTION,NON_BILLABLE(Non billable). - Contract type one of
contract_type_one_oflist - 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.One or more of:
FIXED_FEE(Fixed fee),TIME_AND_MATERIAL(Time and material),SUBSCRIPTION,NON_BILLABLE(Non billable). - Contract type none of
contract_type_none_oflist - 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.One or more of:
FIXED_FEE(Fixed fee),TIME_AND_MATERIAL(Time and material),SUBSCRIPTION,NON_BILLABLE(Non billable). - Budgeted hours gt
budgeted_hours_gttext - 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.
- Budgeted hours eq
budgeted_hours_eqtext - 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.
- Budgeted hours lt
budgeted_hours_lttext - 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.
- Budgeted hours ge
budgeted_hours_getext - 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.
- Allocated hours le
allocated_hours_letext - 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.
- Allocated hours gt
allocated_hours_gttext - 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.
- Allocated hours eq
allocated_hours_eqtext - 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.
- Allocated hours lt
allocated_hours_lttext - 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.
- Allocated hours ge
allocated_hours_getext - 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.
- Customers invited gt
customers_invited_gttext - 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.
- Customers invited eq
customers_invited_eqtext - 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.
- Customers invited lt
customers_invited_lttext - 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.
- Customers invited ge
customers_invited_getext - 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.
- Customers invited le
customers_invited_letext - 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.
- Customers joined gt
customers_joined_gttext - 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.
- Customers joined eq
customers_joined_eqtext - 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.
- Customers joined lt
customers_joined_lttext - 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.
- Customers joined ge
customers_joined_getext - 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.
- Customers joined le
customers_joined_letext - 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.
- Include archive eq
include_archive_eqtrue/false - You can use this parameter to specify whether responses will include the archived projects.
- Status eq
status_eqtext - You can use this param to provide status and the responses will contain projects that are equal to the given status
- Status one of
status_one_oftext - You can use this param to provide statuses and the responses will contain projects that match one of the given statuses
- Status none of
status_none_oftext - You can use this param to provide statuses and the responses will contain projects that matches none of the given statuses
- External reference id eq
external_reference_id_eqtext - You can use this param to provide external reference id and the responses will contain projects that are equal to the given id
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"data": [],
"pagination": {
"hasMore": false,
"nextPage": "example",
"nextPageToken": "example",
"pageSize": 1,
"totalRecordCount": 1
}
}
}List tasks
Get all tasks.
Inputs
- Page size
page_sizenumber - 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.At least 0.
- Page token
page_tokentext - 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.
- Include fields
include_fieldslist - 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.One or more of:
startDateActual,dueDateActual,type,phase,assignees,followers,dependencies,billable,csatEnabled,priority, and 5 more. - Include all fields
include_all_fieldstrue/false - 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.
- Sort by
sort_bytext - You can use the sortBy param to sort the responses by the given field.One of:
taskName,startDate,dueDate,startDateActual,dueDateActual. - Sort order
sort_ordertext - The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.One of:
ASC,DESC. - Match
matchtext - You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.One of:
all,any. - Start date gt
start_date_gtdate - You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date.
- Start date eq
start_date_eqdate - You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date.
- Start date lt
start_date_ltdate - You can use this param to specify some date and the responses will contain tasks whose date are less than the given date.
- Start date ge
start_date_gedate - 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.
- Start date le
start_date_ledate - 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.
- Due date gt
due_date_gtdate - You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date.
- Due date eq
due_date_eqdate - You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date.
- Due date lt
due_date_ltdate - You can use this param to specify some date and the responses will contain tasks whose date are less than the given date.
- Due date ge
due_date_gedate - 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.
- Due date le
due_date_ledate - 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.
- Start date actual gt
start_date_actual_gtdate - You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date.
- Start date actual eq
start_date_actual_eqdate - You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date.
- Start date actual lt
start_date_actual_ltdate - You can use this param to specify some date and the responses will contain tasks whose date are less than the given date.
- Start date actual ge
start_date_actual_gedate - 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.
- Start date actual le
start_date_actual_ledate - 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.
- Due date actual gt
due_date_actual_gtdate - You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date.
- Due date actual eq
due_date_actual_eqdate - You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date.
- Due date actual lt
due_date_actual_ltdate - You can use this param to specify some date and the responses will contain tasks whose date are less than the given date.
- Due date actual ge
due_date_actual_gedate - 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.
- Due date actual le
due_date_actual_ledate - 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.
- Created at gt
created_at_gtdate and time - 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.
- Created at eq
created_at_eqdate and time - 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.
- Created at lt
created_at_ltdate and time - 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.
- Created at ge
created_at_gedate and time - 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.
- Created at le
created_at_ledate and time - 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.
- Updated at gt
updated_at_gtdate and time - 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.
- Updated at eq
updated_at_eqdate and time - 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.
- Updated at lt
updated_at_ltdate and time - 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.
- Updated at ge
updated_at_gedate and time - 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.
- Updated at le
updated_at_ledate and time - 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.
- Project id eq
project_id_eqnumber - 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.
- Phase id eq
phase_id_eqnumber - 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.
- Task name eq
task_name_eqtext - You can use this param to specify some task name and the responses will contain exact matches of tasks that match the given name.
- Task name cn
task_name_cntext - You can use this param to specify some task name and the responses will contain matches of tasks that match the given name.
- Task name nc
task_name_nctext - You can use this param to specify some task name and the responses will not contain matches of tasks that match the given name.
- Effort in minutes eq
effort_in_minutes_eqnumber - 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.
- Effort in minutes gt
effort_in_minutes_gtnumber - 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.
- Effort in minutes lt
effort_in_minutes_ltnumber - 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
progress_eqnumber - 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.From 0 to 100.
- Progress gt
progress_gtnumber - 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.From 0 to 100.
- Progress lt
progress_ltnumber - 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.From 0 to 100.
- Include archive eq
include_archive_eqtrue/false - You can use this parameter to specify whether responses will include the archived tasks.
- Task status eq
task_status_eqtext - You can use this param to provide status and the responses will contain tasks that are equal to the given status
- Task status one of
task_status_one_oftext - You can use this param to provide statuses and the responses will contain tasks that contains the given status
- Task status none of
task_status_none_oftext - 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
project_status_eqtext - 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 one of
project_status_one_oftext - 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 none of
project_status_none_oftext - 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)
- External reference id eq
external_reference_id_eqtext - You can use this param to provide external reference id and the responses will contain tasks that are equal to the given id
- Assignee user id eq
assignee_user_id_eqtext - You can use this param to provide a comma-separated list of user ids and the responses will contain exact matches of tasks whose assignees match exactly the given set of user ids.
- Assignee user id one of
assignee_user_id_one_oftext - You can use this param to provide a comma-separated list of user ids and the responses will contain tasks that have at least one assignee matching any of the given user ids.
- Assignee user id none of
assignee_user_id_none_oftext - You can use this param to provide a comma-separated list of user ids and the responses will not contain tasks that have assignees matching any of the given user ids.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"data": [],
"pagination": {
"hasMore": false,
"nextPage": "example",
"nextPageToken": "example",
"pageSize": 1,
"totalRecordCount": 1
}
}
}List time entries
Get all time entries.
Inputs
- Page size
page_sizenumber - 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.At least 0.
- Page token
page_tokentext - 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.
- Include fields
include_fieldslist - 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.One or more of:
notes,sourceType,deleted,status,submittedBy,submittedAt,approvedBy,approvedAt,rejectedBy,rejectedAt,costRate,billRate. - Sort by
sort_bytext - You can use the sortBy param to sort the responses by the given field. Valid fields to perform sortBy are: `MINUTES`, `DATE`, `ID` and `BILLABLE`.One of:
minutes,date,id,billable. - Sort order
sort_ordertext - The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.One of:
ASC,DESC. - Match
matchtext - You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.One of:
all,any. - Date gt
date_gttext - You can use this param to specify some date and the responses will contain time-entries whose date are greater than the given date.
- Date eq
date_eqtext - You can use this param to specify some date and the responses will contain exact matches of time-entries that match the given date.
- Date lt
date_lttext - You can use this param to specify some date and the responses will contain time-entries whose date are less than the given date.
- Date ge
date_getext - You can use this param to specify some date and the responses will contain time-entries whose date are greater than or equal to the given date.
- Date le
date_letext - You can use this param to specify some date and the responses will contain time-entries whose date are less than or equal to the given date.
- Project eq
project_eqnumber - You can use this param to specify some project Id and the responses will contain exact matches of time-entries that match the given project.
- Project id eq
project_id_eqnumber - You can use this param to specify some project Id and the responses will contain exact matches of time-entries that match the given project.
- Task eq
task_eqnumber - You can use this param to specify some task Id and the responses will contain exact matches of time-entries that match the given task.
- Task id eq
task_id_eqnumber - You can use this param to specify some task Id and the responses will contain exact matches of time-entries that match the given task.
- Task id one of
task_id_one_ofnumber - You can use this param to provide ids of task and the responses will contain time entries whose time entries that contains the given task ids
- Task id none of
task_id_none_ofnumber - You can use this param to provide ids of task and the responses will contain time entries whose time entries that contains the given task ids
- Project phase eq
project_phase_eqnumber - You can use this param to specify some project phase Id and the responses will contain exact matches of time-entries that match the given phase.
- Category eq
category_eqnumber - You can use this param to specify some category Id and the responses will contain exact matches of time-entries that match the given category.
- User eq
user_eqnumber - You can use this param to specify some user Id and the responses will contain exact matches of time-entries that belong to the user with the given user Id.
- Email id eq
email_id_eqtext - You can use this param to specify some email Id and the responses will contain exact matches of time-entries that belong to the user with the given email Id.
- Email id cn
email_id_cntext - You can use this param to specify some text and the responses will contain time-entries that contain the given text in their email name.
- Email id nc
email_id_nctext - You can use this param to specify some text and the responses will contain time-entries that _DO NOT_ contain the given text in their email Id.
- Source type eq
source_type_eqtext - You can use this param to specify a source type for the time entries and the responses will contain exact matches of time-entries that have the given source type.One of:
GOOGLE_CALENDAR(Google calendar),OUTLOOK_CALENDAR(Outlook calendar),TASK,PROJECT,PHASE,ADHOC,MILESTONE. - Activity name eq
activity_name_eqtext - You can use this param to specify some activity name and the responses will contain exact matches of time-entries that match the given activity name.
- Activity name cn
activity_name_cntext - You can use this param to specify some text and the responses will contain time-entries that contain the given text in their activity name.
- Activity name nc
activity_name_nctext - You can use this param to specify some text and the responses will contain time-entries that _DO NOT_ contain the given text in their activity name.
- Approval status eq
approval_status_eqtext - You can use this param to specify an approval status for the time entries and the responses will contain exact matches of time-entries that have the given approval type.One of:
NOT_SUBMITTED(Not submitted),SUBMITTED,APPROVED,REJECTED. - Submitted by eq
submitted_by_eqnumber - You can use this param to specify a submitter for the time entries and the response will contain time-entries submitted by the given user.
- Submitted at eq
submitted_at_eqnumber - You can use this param to provide an epoch milli value and the responses will contain time entries submitted at the given timestamp.
- Submitted at gt
submitted_at_gtnumber - You can use this param to provide an epoch milli value and the responses will contain time entries submitted after the given timestamp.
- Submitted at ge
submitted_at_genumber - You can use this param to provide an epoch milli value and the responses will contain time entries submitted at or after the given timestamp.
- Submitted at lt
submitted_at_ltnumber - You can use this param to provide an epoch milli value and the responses will contain time entries submitted before the given timestamp.
- Submitted at le
submitted_at_lenumber - You can use this param to provide an epoch milli value and the responses will contain time entries submitted at or before the given timestamp.
- Approved by eq
approved_by_eqnumber - You can use this param to specify an approver for the time entries and the response will contain time-entries approved by the given user.
- Approved at eq
approved_at_eqnumber - You can use this param to provide an epoch milli value and the responses will contain time entries approved at the given timestamp.
- Approved at gt
approved_at_gtnumber - You can use this param to provide an epoch milli value and the responses will contain time entries approved after the given timestamp.
- Approved at ge
approved_at_genumber - You can use this param to provide an epoch milli value and the responses will contain time entries approved at or after the given timestamp.
- Approved at lt
approved_at_ltnumber - You can use this param to provide an epoch milli value and the responses will contain time entries approved before the given timestamp.
- Approved at le
approved_at_lenumber - You can use this param to provide an epoch milli value and the responses will contain time entries approved at or before the given timestamp.
- Rejected by eq
rejected_by_eqnumber - You can use this param to specify a rejecter for the time entries and the response will contain time-entries rejected by the given user.
- Rejected at eq
rejected_at_eqnumber - You can use this param to provide an epoch milli value and the responses will contain time entries rejected at the given timestamp.
- Rejected at gt
rejected_at_gtnumber - You can use this param to provide an epoch milli value and the responses will contain time entries rejected after the given timestamp.
- Rejected at ge
rejected_at_genumber - You can use this param to provide an epoch milli value and the responses will contain time entries rejected at or after the given timestamp.
- Rejected at lt
rejected_at_ltnumber - You can use this param to provide an epoch milli value and the responses will contain time entries rejected before the given timestamp.
- Rejected at le
rejected_at_lenumber - You can use this param to provide an epoch milli value and the responses will contain time entries rejected at or before the given timestamp.
- Billable eq
billable_eqtrue/false - You can use this param to specify the billable flag for the time entries and the responses will contain exact matches of time-entries that have the given billable.
- Include deleted eq
include_deleted_eqtrue/false - You can use this parameter to specify whether responses will include the deleted time entries.
- Created at gt
created_at_gtdate and time - You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than the given time entries created date.
- Created at eq
created_at_eqdate and time - You can use this param to provide an epoch milli value and the responses will contain exact matches of time entries that match the given time entries created date.
- Created at lt
created_at_ltdate and time - You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than the given time entries created date.
- Created at ge
created_at_gedate and time - You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than or equal to the given time entries created date.
- Created at le
created_at_ledate and time - You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than or equal to the given time entries created date.
- Updated at gt
updated_at_gtdate and time - You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than the given time entries updated date.
- Updated at eq
updated_at_eqdate and time - You can use this param to provide an epoch milli value and the responses will contain exact matches of time entries that match the given time entries updated date.
- Updated at lt
updated_at_ltdate and time - You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than the given time entries updated date.
- Updated at ge
updated_at_gedate and time - You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than or equal to the given time entries updated date.
- Updated at le
updated_at_ledate and time - You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than or equal to the given time entries updated date.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"data": [],
"pagination": {
"hasMore": false,
"nextPage": "example",
"nextPageToken": "example",
"pageSize": 1,
"totalRecordCount": 1
}
}
}List users
Get all users.
Inputs
- Page size
page_sizenumber - 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.At least 0.
- Page token
page_tokentext - 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.
- Include fields
include_fieldslist - 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.One or more of:
role,company,permission,holidayCalendar,capacityInMinutes,profilePictureUrl. - Include all fields
include_all_fieldstrue/false - 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.
- Sort by
sort_bytext - You can use the sortBy param to sort the responses by the given field.One of:
email,firstName,lastName,type,status,capacityInMinutes. - Sort order
sort_ordertext - The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.One of:
ASC,DESC. - Match
matchtext - You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.One of:
all,any. - First name eq
first_name_eqtext - You can use this param to specify some user first name and the responses will contain exact matches of users that match the given first name.
- First name cn
first_name_cntext - You can use this param to specify some user first name and the responses will contain matches of users that match the given first name.
- First name nc
first_name_nctext - You can use this param to specify some user first name and the responses will not contain matches of users that match the given first name.
- Last name eq
last_name_eqtext - You can use this param to specify some user last name and the responses will contain exact matches of users that match the given last ame.
- Last name cn
last_name_cntext - You can use this param to specify some user last name and the responses will contain matches of users that match the given last name.
- Last name nc
last_name_nctext - You can use this param to specify some user last name and the responses will not contain matches of users that match the given last name.
- Email eq
email_eqtext - You can use this param to specify some user email id and the responses will contain exact matches of users that match the given email id.
- Email cn
email_cntext - You can use this param to specify some user email id and the responses will contain matches of users that match the given email id.
- Email nc
email_nctext - You can use this param to specify some user email id and the responses will not contain matches of users that match the given email id.
- Status eq
status_eqlist - You can use this param to provide a user status and the responses will contain exact matches of users that match the given status.One or more of:
INACTIVE,INVITED,ACTIVE,PASSIVE. - Status one of
status_one_oflist - You can use this param to provide user statuses separated by commas and the responses will contain matches of users that match one of the given user status.One or more of:
INACTIVE,INVITED,ACTIVE,PASSIVE. - Status none of
status_none_oflist - You can use this param to provide user statuses separated by commas and the responses will contain matches of users that match the none of the given set of user statuses.One or more of:
INACTIVE,INVITED,ACTIVE,PASSIVE. - Type eq
type_eqlist - You can use this param to provide a user type and the responses will contain exact matches of users that match the given type.One or more of:
TEAM_MEMBER(Team member),PARTNER,CUSTOMER,EXTERNAL_PARTNER(External partner). - Type one of
type_one_oflist - You can use this param to provide user types separated by commas and the responses will contain matches of users that match the none of the given set of user types.One or more of:
TEAM_MEMBER(Team member),PARTNER,CUSTOMER,EXTERNAL_PARTNER(External partner). - Role id eq
role_id_eqtext - You can use this param to provide a role id and the responses will contain exact matches of users that match the given role id.
- Role id one of
role_id_one_oftext - You can use this param to provide role ids separated by commas and the responses will contain matches of users that match one of the given role id.
- Role id none of
role_id_none_oftext - You can use this param to provide role id separated by commas and the responses will contain matches of users that match the none of the given set of role id.
- Permission id eq
permission_id_eqtext - You can use this param to provide a permission id and the responses will contain exact matches of users that match the given permission id.
- Permission id one of
permission_id_one_oftext - You can use this param to provide permission ids separated by commas and the responses will contain matches of users that match one of the given set of permission id.
- Permission id none of
permission_id_none_oftext - You can use this param to provide permission ids separated by commas and the responses will contain matches of users that match the none of the given set of permission id.
- Capacity in minutes eq
capacity_in_minutes_eqnumber - You can use this param to specify some value as capacity and the responses will contain exact matches of users that match the given value.
- Capacity in minutes gt
capacity_in_minutes_gtnumber - You can use this param to specify some value as capacity and the responses will contain exact matches of capacity greater than that of the given value.
- Capacity in minutes ge
capacity_in_minutes_genumber - You can use this param to specify some value as capacity and the responses will contain exact matches of capacity greater than or equal to that of the given value.
- Capacity in minutes lt
capacity_in_minutes_ltnumber - You can use this param to specify some value as capacity and the responses will contain exact matches of capacity lesser than that of the given value.
- Capacity in minutes le
capacity_in_minutes_lenumber - You can use this param to specify some value as capacity and the responses will contain exact matches of capacity lesser than or equal to that of the given value.
- Created at gt
created_at_gtdate and time - You can use this param to provide an epoch milli value and the responses will contain users whose date are greater than the given users created date.
- Created at eq
created_at_eqdate and time - You can use this param to provide an epoch milli value and the responses will contain exact matches of users that match the given users created date.
- Created at lt
created_at_ltdate and time - You can use this param to provide an epoch milli value and the responses will contain users whose date are less than the given users created date.
- Created at ge
created_at_gedate and time - You can use this param to provide an epoch milli value and the responses will contain users whose date are greater than or equal to the given users created date.
- Created at le
created_at_ledate and time - You can use this param to provide an epoch milli value and the responses will contain users whose date are less than or equal to the given users created date.
- Updated at gt
updated_at_gtdate and time - You can use this param to provide an epoch milli value and the responses will contain users whose date are greater than the given users updated date.
- Updated at eq
updated_at_eqdate and time - You can use this param to provide an epoch milli value and the responses will contain exact matches of users that match the given users updated date.
- Updated at lt
updated_at_ltdate and time - You can use this param to provide an epoch milli value and the responses will contain users whose date are less than the given users updated date.
- Updated at ge
updated_at_gedate and time - You can use this param to provide an epoch milli value and the responses will contain users whose date are greater than or equal to the given users updated date.
- Updated at le
updated_at_ledate and time - You can use this param to provide an epoch milli value and the responses will contain users whose date are less than or equal to the given users updated date.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"data": [],
"pagination": {
"hasMore": false,
"nextPage": "example",
"nextPageToken": "example",
"pageSize": 1,
"totalRecordCount": 1
}
}
}Update company
Update company by Id.
Inputs
- Company
company_idtextRequired - The company's unique, system-generated identifier, which can be used to identify the company globally.
- Include fields
include_fieldslist - Use this query parameter to opt in for companies to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.One or more of:
companyUrl,notes. - Include all fields
include_all_fieldstrue/false - 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.
- Company name
company_nametext - The name of the company
- Company url
company_urltext - The URL of the client's website. Unless explicitly stated, the value for this field can be left blank
- Visibility
visibilitytext - Set visibility parameters to restrict who can see your company. On create/update there are two options: `EVERYONE` and `MEMBERS` (same as projects). Selecting `EVERYONE` allows all team members from your firm to view the company, while selecting `MEMBERS` restricts access to only those team members who have been specifically invited.One of:
EVERYONE,MEMBERS. - Description
descriptiontext - A detailed description or notes about the company.
- Owner
owner_idtext - The unique identifier for the account owner.
- Fields
fieldslist - Custom fields to update on the company. Provide fieldId and fieldValue for each field.
- Notes
noteslist - Existing notes to update on this company. Each entry requires noteId. To create a new note, use POST /1.0/companies/{companyId}/add-notes.
Outputs
dataobject- Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response.
Example output
{
"data": {
"accountOwner": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"companyId": 1,
"companyName": "example",
"companyUrl": "example",
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"description": "example",
"fields": [],
"notes": [],
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"visibility": "EVERYONE"
}
}Update project
Update project by Id.
Inputs
- Project
project_idtextRequired - The project's unique, system-generated identifier, which can be used to identify the project globally.
- Include fields
include_fieldslist - 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.One or more of:
annualizedRecurringRevenue,projectFee,allocatedHours,allocatedMinutes,budgetedHours,percentageBudgetedHoursConsumed,percentageBudgetConsumed,billableHours,billableMinutes,nonBillableHours, and 18 more. - Include all fields
include_all_fieldstrue/false - 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.
- Project name
project_nametext - The `name` of the project. The name specified will be displayed everywhere else and can be used for filtering purposes.
- Start date
start_datedate - On 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_.
- Due date
due_datedate - The 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_.
- Visibility
visibilitytext - Set 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.One of:
EVERYONE,MEMBERS. - Owner
owner_idtext - The unique identifier for project owner.
- Status
statusobject - The value of the project status can be specified here and this is essential to keep track of the project.
- Fields
fieldslist - The 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](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`.
- Annualized recurring revenue
annualized_recurring_revenuenumber - Indicates the value of the recurring revenue of the customer's subscriptions for a single calendar year.
- Project fee
project_feenumber - The total fee that is charged for the project.
- Auto allocation
auto_allocationtrue/false - The 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.
- Budgeted hours
budgeted_hoursnumber - Budgeted 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).
- External reference id
external_reference_idtext - An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"allocatedHours": 1,
"allocatedMinutes": 1.0,
"annualizedRecurringRevenue": 1,
"archived": false,
"autoAllocation": false,
"billableHours": 1,
"billableMinutes": 1.0,
"budgetedHours": 1.0,
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"currency": "AFN",
"currentPhases": [],
"customer": {
"companyId": 1,
"companyName": "example",
"companyUrl": "example"
},
"customersInvited": 1,
"customersJoined": 1,
"dueDate": "example",
"dueDateActual": "example",
"externalReferenceId": "example",
"fields": [],
"financials": {
"contractType": "FIXED_FEE",
"fixedFeeContract": {
"fixedFee": 1.0
},
"metrics": {
"actualCost": 1.0,
"actualProfit": 1.0,
"actualProfitMargin": 1.0,
"actualRevenue": 1.0,
"estimateAtCompletion": 1.0,
"estimatedCost": 1.0,
"estimatedProfit": 1.0,
"estimatedProfitMargin": 1.0,
"estimatedRevenue": 1.0,
"estimationToCompletionInHours": 1.0
},
"revenueRecognitionType": "example",
"subscriptionContract": {
"noOfPeriods": 1,
"periodBudget": 1.0,
"periodMinutes": 1,
"subscriptionFrequency": "MONTHLY",
"subscriptionStartDate": "example"
},
"timeAndMaterialContract": {
"projectBudget": 1.0,
"rateCard": {
"rateCardId": 1,
"rateCardName": "example"
}
}
},
"inferredProgress": "ON_TRACK",
"nonBillableHours": 1,
"nonBillableMinutes": 1.0,
"owner": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"partnerCompanies": [],
"percentageBudgetConsumed": 1.0,
"percentageBudgetedHoursConsumed": 1.0,
"plannedDurationInDays": 1,
"progressPercentage": 1,
"projectAgeInDays": 1,
"projectFee": 1,
"projectId": 1,
"projectName": "example",
"remainingHours": 1,
"remainingMinutes": 1,
"sources": [],
"startDate": "example",
"startDateActual": "example",
"status": {
"label": "example",
"value": 1
},
"teamMembers": {
"customerChampion": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"customers": [],
"members": []
},
"trackedHours": 1,
"trackedMinutes": 1.0,
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"visibility": "EVERYONE"
}
}Update task
Update task by Id.
Inputs
- Task id
task_idtextRequired - The task's unique, system-generated **identifier**, which can be used to identify the task globally
- Include fields
include_fieldslist - 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.One or more of:
startDateActual,dueDateActual,type,phase,assignees,followers,dependencies,billable,csatEnabled,priority, and 5 more. - Include all fields
include_all_fieldstrue/false - 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.
- Task name
task_nametext - The **name** of the task.
- Task description
task_descriptiontext - The `description` of the task. The description body needs to be in **html** format to avoid any formatting issues in the application.
- Task private note
task_private_notetext - The `privateNote` for the task is intended exclusively for team members. The note's content should be in `HTML` format to prevent any formatting issues in the application.
- Start date
start_datedate - The date when a task starts its execution. It can be empty. The format for the start date is _YYYY-MM-DD_.
- Due date
due_datedate - The date when a task completes its execution. It can be empty. If both `startDate` and `dueDate` are specified for a given task, it is necessary that the latter should be on or after the given `startDate`. The format for the due date is _YYYY-MM-DD_.
- Effort in minutes
effort_in_minutesnumber - The effort is the expected time required to complete the task. The value is determined in minutes.
- Progress
progressnumber - The task's progress, if indicated, will be available here and ranges in value from 0 to 100. The task's status can be used in place of this field, however progress can offer more precise data.
- At risk
at_risktrue/false - Indicates whether the task has been marked as At Risk. This parameter is used to indicate that immediate action is necessary to unblock the task's execution.
- Type
typetext - The type of the task if specified will be available here. There are two options: `MILESTONE` or `TASK`. If a task is not explicitly marked as a milestone, it takes the default value as `TASK`. Milestones refer to critical tasks in the project that include an inbuilt CSAT capability that allows customers to offer CSAT evaluations depending on the task's execution.One of:
TASK,MILESTONE. - Fields
fieldslist - The custom fields can be set during the task 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](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`.
- Status
statusobject - The value of the task status can be specified here and this is essential to keep track of it.
- External reference id
external_reference_idtext - An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.
- Private
privatetrue/false - This depicts if the task is private or not.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"archived": false,
"assignees": {
"members": [],
"placeholders": []
},
"atRisk": false,
"billable": false,
"budgets": [],
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"csatEnabled": false,
"dependencies": [],
"dueDate": "example",
"dueDateActual": "example",
"effortInMinutes": 1,
"externalReferenceId": "example",
"fields": [],
"followers": {
"members": [],
"placeholders": []
},
"parent": {
"taskId": 1,
"taskName": "example"
},
"phase": {
"phaseId": 1,
"phaseName": "example"
},
"priority": {
"label": "example",
"value": 1
},
"private": false,
"progress": 1,
"project": {
"projectId": 1,
"projectName": "example"
},
"revRecRecognisedAmount": 1.0,
"revRecRecognisedPercentage": 1.0,
"revenueRecognitionDetails": [],
"revenueRecognitionTask": false,
"startDate": "example",
"startDateActual": "example",
"status": {
"label": "example",
"value": 1
},
"taskDescription": "example",
"taskId": 1,
"taskName": "example",
"taskPrivateNote": "example",
"timeEntryCategory": {
"categoryId": 1,
"categoryName": "example"
},
"totalAllocatedMins": 1,
"type": "TASK",
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
}
}
}Update time entry
Update a time entry.
Inputs
- Time entry id
time_entry_idtextRequired - The unique, system-generated identifier, which can be used to identify the time entry globally.
- Include fields
include_fieldslist - 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.One or more of:
notes,sourceType,deleted,status,submittedBy,submittedAt,approvedBy,approvedAt,rejectedBy,rejectedAt,costRate,billRate. - Include all fields
include_all_fieldstrue/false - 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.
- Minutes
minutesnumber - Duration of the time entry in minutesFrom 1 to 1440.
- Activity name
activity_nametext - Name of the adhoc activity being performed
- Notes
notestext - Notes for the time entry
- Category
categoryobject - Category associated with the time entry
- Fields
fieldslist - The custom fields can be set during the time-entry 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](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`.
- Billable
billabletrue/false - Billable.
Outputs
dataobject- Rocketlane response data.
Example output
{
"data": {
"activityName": "example",
"approvedAt": 1,
"approvedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"billRate": {
"currency": "example",
"rate": 1.0
},
"billable": false,
"budget": {
"budgetId": 1,
"budgetName": "example"
},
"category": {
"categoryId": 1,
"categoryName": "example"
},
"costRate": {
"currency": "example",
"rate": 1.0
},
"createdAt": 1,
"createdBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"date": "example",
"deleted": false,
"fields": [],
"minutes": 1,
"notes": "example",
"project": {
"projectId": 1,
"projectName": "example"
},
"projectPhase": {
"phaseId": 1,
"phaseName": "example"
},
"rejectedAt": 1,
"rejectedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"sourceType": "GOOGLE_CALENDAR",
"status": "NOT_SUBMITTED",
"submittedAt": 1,
"submittedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"task": {
"taskId": 1,
"taskName": "example"
},
"timeEntryId": 1,
"updatedAt": 1,
"updatedBy": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
},
"user": {
"emailId": "example",
"firstName": "example",
"lastName": "example",
"userId": 1
}
}
}