Integrate Rocketlane into your workflow. Rocketlane is a professional-services automation platform for client onboarding and project delivery. Create and manage projects, tasks, phases, custom fields, time entries, time-offs, spaces, documents, resource allocations, and invoices.
Create a new Rocketlane project with a customer, owner, dates, team members, templates, financials, and custom fields
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectName | string | Yes | Name of the project |
customerCompanyName | string | Yes | Name of the customer company (case-sensitive exact match; cannot be changed after creation) |
ownerUserId | number | No | User ID of the project owner (either ownerUserId or ownerEmailId must be provided) |
ownerEmailId | string | No | Email of the project owner (either ownerUserId or ownerEmailId must be provided) |
startDate | string | No | Date on which the project begins (YYYY-MM-DD); required when sources are provided |
dueDate | string | No | Date on which the project is planned to complete (YYYY-MM-DD, on or after startDate) |
visibility | string | No | Who can see the project: EVERYONE or MEMBERS |
statusValue | number | No | Value (identifier) of the project status |
memberUserIds | array | No | User IDs of team members from your organization to add to the project |
customerUserIds | array | No | User IDs of customer stakeholders to add to the project |
customerChampionUserId | number | No | User ID of the customer champion |
fields | array | No | Custom field assignments, each with fieldId and fieldValue (string, number, or number array matching the field type) |
sources | array | No | Project templates to import at creation, each with templateId, startDate (YYYY-MM-DD), and optional prefix |
placeholders | array | No | Placeholder-to-user mappings, each with placeholderId and user ({ userId } or { emailId }); ignored unless the project is built from sources |
assignProjectOwner | boolean | No | Automatically assign unassigned tasks to the project owner (skipped when no sources are used) |
annualizedRecurringRevenue | number | No | Recurring revenue of the customer subscriptions for a single calendar year |
projectFee | number | No | Total fee charged for the project |
autoAllocation | boolean | No | Whether auto allocation is enabled for the project |
autoCreateCompany | boolean | No | Create the customer company if it does not already exist |
budgetedHours | number | No | Total hours allocated for project execution (decimal, up to two places) |
contractType | string | No | Contract type for the project financials: FIXED_FEE, TIME_AND_MATERIAL, NON_BILLABLE, or SUBSCRIPTION |
fixedFee | number | No | Project fee for FIXED_FEE contract type projects |
projectBudget | number | No | Project budget for TIME_AND_MATERIAL contract type projects |
rateCardId | number | No | Rate card ID for TIME_AND_MATERIAL contract type projects |
subscriptionFrequency | string | No | Subscription renewal interval for SUBSCRIPTION contracts: MONTHLY, QUARTERLY, HALF_YEARLY, or YEARLY |
subscriptionStartDate | string | No | Date when the subscription interval begins (YYYY-MM-DD) |
periodMinutes | number | No | Budgeted minutes for each subscription period |
periodBudget | number | No | Fixed budget of every subscription period |
noOfPeriods | number | No | Number of periods in the subscription |
currency | string | No | Currency for the project financials (ISO code, e.g. USD); cannot be changed once set |
externalReferenceId | string | No | Identifier linking the project to an external system |
includeFields | string | No | Comma-separated extra fields to return in the response (e.g. budgetedHours,progressPercentage) |
includeAllFields | boolean | No | Return all fields in the response body |
| Parameter | Type | Description |
|---|
project | object | The created project |
Retrieve a Rocketlane project by its unique identifier
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project |
includeFields | string | No | Comma-separated extra fields to return in the response (e.g. budgetedHours,progressPercentage) |
includeAllFields | boolean | No | Return all fields in the response body |
| Parameter | Type | Description |
|---|
project | object | The requested project |
List Rocketlane projects with optional filters, sorting, and token-based pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
pageSize | number | No | Maximum number of projects per page (defaults to 100) |
pageToken | string | No | Page token from a previous response (valid for 15 minutes) |
includeFields | string | No | Comma-separated extra fields to return in the response (e.g. budgetedHours,progressPercentage) |
includeAllFields | boolean | No | Return all fields in the response body |
sortBy | string | No | Field to sort by: projectName, startDate, dueDate, startDateActual, dueDateActual, annualizedRecurringRevenue, or projectFee |
sortOrder | string | No | Sort order: ASC or DESC (defaults to DESC) |
match | string | No | Combine filters with AND (all) or OR (any); defaults to all |
projectNameContains | string | No | Only return projects whose name contains this value |
projectNameEquals | string | No | Only return projects whose name exactly matches this value |
statusEquals | string | No | Only return projects with this status value |
statusOneOf | string | No | Comma-separated status values; returns projects matching any of them |
customerIdEquals | string | No | Only return projects for this customer company ID |
customerIdOneOf | string | No | Comma-separated customer company IDs; returns projects matching any of them |
teamMemberIdEquals | string | No | Only return projects that include this team member ID |
contractTypeEquals | string | No | Only return projects with this contract type: FIXED_FEE, TIME_AND_MATERIAL, SUBSCRIPTION, or NON_BILLABLE |
includeArchived | boolean | No | Whether to include archived projects in the results |
externalReferenceIdEquals | string | No | Only return projects with this external reference ID |
startDateAfter | string | No | Only return projects whose start date is after this date (YYYY-MM-DD) |
startDateBefore | string | No | Only return projects whose start date is before this date (YYYY-MM-DD) |
dueDateAfter | string | No | Only return projects whose due date is after this date (YYYY-MM-DD) |
dueDateBefore | string | No | Only return projects whose due date is before this date (YYYY-MM-DD) |
| Parameter | Type | Description |
|---|
projects | array | List of projects |
pagination | object | Pagination details for fetching further pages |
Update a Rocketlane project by ID, including name, dates, visibility, owner, status, and custom fields
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project to update |
projectName | string | No | New name of the project |
startDate | string | No | Date on which the project begins (YYYY-MM-DD) |
dueDate | string | No | Date on which the project is planned to complete (YYYY-MM-DD, on or after startDate) |
visibility | string | No | Who can see the project: EVERYONE or MEMBERS |
ownerUserId | number | No | User ID of the new project owner (transfers ownership and revokes access for the previous owner) |
ownerEmailId | string | No | Email of the new project owner |
statusValue | number | No | Value (identifier) of the project status |
fields | array | No | Custom field assignments, each with fieldId and fieldValue (string, number, or number array matching the field type) |
annualizedRecurringRevenue | number | No | Recurring revenue of the customer subscriptions for a single calendar year |
projectFee | number | No | Total fee charged for the project |
autoAllocation | boolean | No | Whether auto allocation is enabled for the project |
budgetedHours | number | No | Total hours allocated for project execution (decimal, up to two places) |
externalReferenceId | string | No | Identifier linking the project to an external system |
includeFields | string | No | Comma-separated extra fields to return in the response (e.g. budgetedHours,progressPercentage) |
includeAllFields | boolean | No | Return all fields in the response body |
| Parameter | Type | Description |
|---|
project | object | The updated project |
Archive a Rocketlane project by ID, making it dormant while preserving its details and history
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project to archive |
| Parameter | Type | Description |
|---|
archived | boolean | Whether the project was archived |
projectId | number | Unique identifier of the archived project |
Permanently delete a Rocketlane project by ID (irreversible; only Admins, Super Users, and Project Owners can delete)
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the project was deleted |
projectId | number | Unique identifier of the deleted project |
Add team members and customer stakeholders to a Rocketlane project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project |
memberUserIds | array | No | User IDs of team members from your organization to add |
memberEmailIds | array | No | Emails of team members from your organization to add |
customerUserIds | array | No | User IDs of customer stakeholders to add |
customerEmailIds | array | No | Emails of customer stakeholders to add |
| Parameter | Type | Description |
|---|
project | object | The project with its updated team members |
Remove team members from a Rocketlane project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project |
memberUserIds | array | No | User IDs of team members to remove (at least one of memberUserIds or memberEmailIds is required) |
memberEmailIds | array | No | Emails of team members to remove (at least one of memberUserIds or memberEmailIds is required) |
| Parameter | Type | Description |
|---|
project | object | The project with its updated team members |
Import a project template into an existing Rocketlane project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project to import the template into |
templateId | number | Yes | Unique identifier of the template to import |
startDate | string | Yes | Date on which the template goes into effect for the project (YYYY-MM-DD) |
prefix | string | No | Prefix distinguishing which phase or task corresponds to this template when importing multiple templates |
| Parameter | Type | Description |
|---|
project | object | The project after the template import (including its sources) |
List the placeholders of a Rocketlane project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project |
| Parameter | Type | Description |
|---|
placeholders | array | Placeholders of the project |
pagination | object | Pagination details for fetching further pages |
Assign a placeholder in a Rocketlane project to a user
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project |
placeholderId | number | Yes | Unique identifier of the placeholder to assign |
userId | number | No | User ID of the project member to assign (either userId or userEmailId must be provided; must be a customer user for CUSTOMER placeholders) |
userEmailId | string | No | Email of the project member to assign (either userId or userEmailId must be provided) |
| Parameter | Type | Description |
|---|
project | object | The project after the placeholder assignment |
placeholders | array | Placeholder-to-user mappings on the project |
Unassign a placeholder from its user in a Rocketlane project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | Unique identifier of the project |
placeholderId | number | Yes | Unique identifier of the placeholder to unassign |
| Parameter | Type | Description |
|---|
project | object | The project after the placeholder was unassigned |
placeholders | array | Placeholder-to-user mappings on the project |
Create a new task in a Rocketlane project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskName | string | Yes | Name of the task |
projectId | number | Yes | ID of the project the task belongs to |
taskDescription | string | No | Description of the task in HTML format |
taskPrivateNote | string | No | Private note visible only to team members, in HTML format |
startDate | string | No | Date when the task starts (YYYY-MM-DD) |
dueDate | string | No | Date when the task is due, on or after the start date (YYYY-MM-DD) |
effortInMinutes | number | No | Expected effort to complete the task, in minutes |
progress | number | No | Progress of the task (0-100) |
atRisk | boolean | No | Whether the task is marked as At Risk |
type | string | No | Type of the task: TASK or MILESTONE (defaults to TASK) |
phaseId | number | No | ID of the phase to associate the task with (must belong to the project) |
statusValue | number | No | Status value to set on the task |
assigneeUserIds | array | No | User IDs of members to assign to the task |
assigneeEmailIds | array | No | Email addresses of members to assign to the task |
followerUserIds | array | No | User IDs of members to add as followers of the task |
followerEmailIds | array | No | Email addresses of members to add as followers of the task |
parentTaskId | number | No | ID of the parent task |
externalReferenceId | string | No | External reference identifier linking the task to an external system |
private | boolean | No | Whether the task is private |
includeFields | array | No | Extra fields to include in the response (startDateActual, dueDateActual, type, phase, assignees, followers, dependencies, billable, csatEnabled, priority, timeEntryCategory, financialsBudget, taskPrivateNote, parent, externalReferenceId) |
includeAllFields | boolean | No | Whether all fields should be returned in the response |
| Parameter | Type | Description |
|---|
task | object | The created task |
Retrieve detailed information about a Rocketlane task by its unique identifier
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to retrieve |
includeFields | array | No | Extra fields to include in the response (startDateActual, dueDateActual, type, phase, assignees, followers, dependencies, billable, csatEnabled, priority, timeEntryCategory, financialsBudget, taskPrivateNote, parent, externalReferenceId) |
includeAllFields | boolean | No | Whether all fields should be returned in the response |
| Parameter | Type | Description |
|---|
task | object | The requested task |
Retrieve all Rocketlane tasks with optional filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
pageSize | number | No | Number of tasks per page (defaults to 100) |
pageToken | string | No | Token pointing to the next page of results, from a previous response |
includeFields | array | No | Extra fields to include in the response (startDateActual, dueDateActual, type, phase, assignees, followers, dependencies, billable, csatEnabled, priority, timeEntryCategory, financialsBudget, taskPrivateNote, parent, externalReferenceId) |
includeAllFields | boolean | No | Whether all fields should be returned in the response |
sortBy | string | No | Field to sort by: taskName, startDate, dueDate, startDateActual, or dueDateActual |
sortOrder | string | No | Sort order: ASC or DESC |
match | string | No | How multiple filters combine: all (AND) or any (OR) |
projectId | number | No | Filter tasks by project ID |
phaseId | number | No | Filter tasks by phase ID |
taskName | string | No | Filter tasks whose name exactly matches this value |
taskNameContains | string | No | Filter tasks whose name contains this value |
taskStatus | string | No | Filter tasks by task status value |
startDateFrom | string | No | Filter tasks with a start date on or after this date (YYYY-MM-DD) |
startDateTo | string | No | Filter tasks with a start date on or before this date (YYYY-MM-DD) |
dueDateFrom | string | No | Filter tasks with a due date on or after this date (YYYY-MM-DD) |
dueDateTo | string | No | Filter tasks with a due date on or before this date (YYYY-MM-DD) |
includeArchive | boolean | No | Whether archived tasks should be included in the results |
externalReferenceId | string | No | Filter tasks by external reference identifier |
| Parameter | Type | Description |
|---|
tasks | array | List of tasks matching the filters |
pagination | object | Pagination details for the result set |
Update the properties of an existing Rocketlane task by its unique identifier
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to update |
taskName | string | No | New name of the task |
taskDescription | string | No | Description of the task in HTML format |
taskPrivateNote | string | No | Private note visible only to team members, in HTML format |
startDate | string | No | Date when the task starts (YYYY-MM-DD) |
dueDate | string | No | Date when the task is due, on or after the start date (YYYY-MM-DD) |
effortInMinutes | number | No | Expected effort to complete the task, in minutes |
progress | number | No | Progress of the task (0-100) |
atRisk | boolean | No | Whether the task is marked as At Risk |
type | string | No | Type of the task: TASK or MILESTONE |
statusValue | number | No | Status value to set on the task |
externalReferenceId | string | No | External reference identifier linking the task to an external system |
private | boolean | No | Whether the task is private |
includeFields | array | No | Extra fields to include in the response (startDateActual, dueDateActual, type, phase, assignees, followers, dependencies, billable, csatEnabled, priority, timeEntryCategory, financialsBudget, taskPrivateNote, parent, externalReferenceId) |
includeAllFields | boolean | No | Whether all fields should be returned in the response |
| Parameter | Type | Description |
|---|
task | object | The updated task |
Permanently delete a Rocketlane task by its unique identifier
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the task was deleted |
taskId | number | ID of the deleted task |
Move a Rocketlane task to a given phase, associating the task with that phase
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to move |
phaseId | number | Yes | Unique identifier of the phase to move the task to |
| Parameter | Type | Description |
|---|
task | object | The task with its updated phase |
Add members as assignees to a Rocketlane task
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to add assignees to |
memberUserIds | array | No | User IDs of members to add as assignees |
memberEmailIds | array | No | Email addresses of members to add as assignees |
| Parameter | Type | Description |
|---|
task | object | The task with its updated assignees |
Remove assignees from a Rocketlane task
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to remove assignees from |
memberUserIds | array | No | User IDs of members to remove from the assignees |
memberEmailIds | array | No | Email addresses of members to remove from the assignees |
| Parameter | Type | Description |
|---|
task | object | The task with its updated assignees |
Add members as followers to a Rocketlane task
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to add followers to |
memberUserIds | array | No | User IDs of members to add as followers |
memberEmailIds | array | No | Email addresses of members to add as followers |
| Parameter | Type | Description |
|---|
task | object | The task with its updated followers |
Remove followers from a Rocketlane task
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to remove followers from |
memberUserIds | array | No | User IDs of members to remove from the followers |
memberEmailIds | array | No | Email addresses of members to remove from the followers |
| Parameter | Type | Description |
|---|
task | object | The task with its updated followers |
Add finish-to-start dependencies between a Rocketlane task and other tasks
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to add dependencies to |
dependencyTaskIds | array | Yes | Task IDs the task should depend on |
| Parameter | Type | Description |
|---|
task | object | The task with its updated dependencies |
Remove dependencies from a Rocketlane task
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
taskId | number | Yes | Unique identifier of the task to remove dependencies from |
dependencyTaskIds | array | Yes | Task IDs to remove from the task dependencies |
| Parameter | Type | Description |
|---|
task | object | The task with its updated dependencies |
Create a new phase in a Rocketlane project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
phaseName | string | Yes | Name of the phase |
projectId | number | Yes | ID of the project to create the phase in |
startDate | string | Yes | Planned start date of the phase (YYYY-MM-DD) |
dueDate | string | Yes | Planned due date of the phase (YYYY-MM-DD) |
statusValue | number | No | Numeric status value to set on the phase |
private | boolean | No | Whether the phase is private |
includeFields | string | No | Comma-separated extra phase properties to include in the response (supported: startDateActual, dueDateActual) |
includeAllFields | boolean | No | Whether to return all phase properties in the response |
| Parameter | Type | Description |
|---|
phase | object | The created phase |
Retrieve a single Rocketlane phase by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
phaseId | number | Yes | ID of the phase to retrieve |
includeFields | string | No | Comma-separated extra phase properties to include in the response (supported: startDateActual, dueDateActual) |
includeAllFields | boolean | No | Whether to return all phase properties in the response |
| Parameter | Type | Description |
|---|
phase | object | The requested phase |
List phases of a Rocketlane project, with optional filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | ID of the project to list phases for |
pageSize | number | No | Number of phases per page |
pageToken | string | No | Page token returned by a previous request (valid for 15 minutes) |
includeFields | string | No | Comma-separated extra phase properties to include in the response (supported: startDateActual, dueDateActual) |
includeAllFields | boolean | No | Whether to return all phase properties in the response |
sortBy | string | No | Property to sort by (phaseName, startDate, dueDate, startDateActual, dueDateActual) |
sortOrder | string | No | Sort order (ASC or DESC) |
match | string | No | Whether results must match all filters or any filter (all or any) |
phaseName | string | No | Filter by exact phase name |
| Parameter | Type | Description |
|---|
phases | array | List of phases |
pagination | object | Pagination details for the result set |
Update the name, dates, status, or privacy of an existing Rocketlane phase
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
phaseId | number | Yes | ID of the phase to update |
phaseName | string | No | New name of the phase |
startDate | string | No | New planned start date of the phase (YYYY-MM-DD) |
dueDate | string | No | New planned due date of the phase (YYYY-MM-DD) |
statusValue | number | No | New numeric status value for the phase |
private | boolean | No | Whether the phase is private |
includeFields | string | No | Comma-separated extra phase properties to include in the response (supported: startDateActual, dueDateActual) |
includeAllFields | boolean | No | Whether to return all phase properties in the response |
| Parameter | Type | Description |
|---|
phase | object | The updated phase |
Permanently delete a Rocketlane phase by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
phaseId | number | Yes | ID of the phase to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the phase was deleted |
phaseId | number | ID of the deleted phase |
Create a custom field in your Rocketlane account, with options for SINGLE_CHOICE and MULTIPLE_CHOICE field types
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
fieldLabel | string | Yes | Name of the field |
fieldType | string | Yes | Type of the field (TEXT, MULTI_LINE_TEXT, YES_OR_NO, DATE, SINGLE_CHOICE, MULTIPLE_CHOICE, SINGLE_USER, MULTIPLE_USER, NUMBER, NOTE, RATING) |
objectType | string | Yes | Object the field is associated with (PROJECT, TASK, or USER) |
fieldDescription | string | No | Description of the field |
fieldOptions | array | No | Options for SINGLE_CHOICE and MULTIPLE_CHOICE fields; the order provided is preserved |
ratingScale | string | No | Number of stars for RATING fields (THREE, FIVE, SEVEN, TEN) |
enabled | boolean | No | Whether the field is enabled (defaults to true) |
private | boolean | No | Whether the field is private |
includeFields | string | No | Comma-separated extra field properties to include in the response (supported: options) |
includeAllFields | boolean | No | Whether to return all field properties in the response |
| Parameter | Type | Description |
|---|
field | object | The created field |
Retrieve a single Rocketlane field by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
fieldId | number | Yes | ID of the field to retrieve |
includeFields | string | No | Comma-separated extra field properties to include in the response (supported: options) |
includeAllFields | boolean | No | Whether to return all field properties in the response |
| Parameter | Type | Description |
|---|
field | object | The requested field |
List fields in your Rocketlane account, with optional filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
pageSize | number | No | Number of fields per page |
pageToken | string | No | Page token returned by a previous request (valid for 15 minutes) |
includeFields | string | No | Comma-separated extra field properties to include in the response (supported: options) |
includeAllFields | boolean | No | Whether to return all field properties in the response |
sortBy | string | No | Property to sort by (supported: fieldLabel) |
sortOrder | string | No | Sort order (ASC or DESC) |
match | string | No | Whether results must match all filters or any filter (all or any) |
objectType | string | No | Filter by associated object type (PROJECT, TASK, or USER) |
fieldType | string | No | Filter by field type (TEXT, MULTI_LINE_TEXT, YES_OR_NO, DATE, SINGLE_CHOICE, MULTIPLE_CHOICE, SINGLE_USER, MULTIPLE_USER, NUMBER, NOTE, RATING) |
enabled | boolean | No | Filter by enabled state |
private | boolean | No | Filter by privacy setting |
| Parameter | Type | Description |
|---|
fields | array | List of fields |
pagination | object | Pagination details for the result set |
Update the label, description, enabled state, or privacy of an existing Rocketlane field
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
fieldId | number | Yes | ID of the field to update |
fieldLabel | string | No | New name of the field |
fieldDescription | string | No | New description of the field |
enabled | boolean | No | Whether the field is enabled |
private | boolean | No | Whether the field is private |
includeFields | string | No | Comma-separated extra field properties to include in the response (supported: options) |
includeAllFields | boolean | No | Whether to return all field properties in the response |
| Parameter | Type | Description |
|---|
field | object | The updated field |
Permanently delete a Rocketlane field by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
fieldId | number | Yes | ID of the field to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the field was deleted |
fieldId | number | ID of the deleted field |
Add a new option to an existing SINGLE_CHOICE or MULTIPLE_CHOICE Rocketlane field
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
fieldId | number | Yes | ID of the field to add the option to |
optionLabel | string | Yes | Display label of the new option |
optionColor | string | Yes | Color of the new option (RED, YELLOW, GREEN, TEAL, CYAN, BLUE, PURPLE, MAGENTA, GRAY, COOL_GRAY) |
| Parameter | Type | Description |
|---|
option | object | The created field option |
Update the label or color of an existing option on a SINGLE_CHOICE or MULTIPLE_CHOICE Rocketlane field
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
fieldId | number | Yes | ID of the field the option belongs to |
optionValue | number | Yes | Unique identifier of the option to update |
optionLabel | string | No | New display label of the option |
optionColor | string | No | New color of the option (RED, YELLOW, GREEN, TEAL, CYAN, BLUE, PURPLE, MAGENTA, GRAY, COOL_GRAY) |
| Parameter | Type | Description |
|---|
option | object | The updated field option |
Create a time entry in Rocketlane against an adhoc activity, task, project phase, or project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
date | string | Yes | Date of the time entry in YYYY-MM-DD format |
minutes | number | Yes | Duration of the time entry in minutes (1-1440) |
activityName | string | No | Name of the adhoc activity to track time against. Exactly one source is required among activityName, taskId, projectPhaseId, and projectId — providing more than one results in an error |
taskId | number | No | ID of the task to track time against. Exactly one source is required among activityName, taskId, projectPhaseId, and projectId — providing more than one results in an error |
projectPhaseId | number | No | ID of the project phase to track time against. Exactly one source is required among activityName, taskId, projectPhaseId, and projectId — providing more than one results in an error |
projectId | number | No | ID of the project to track time against. Exactly one source is required among activityName, taskId, projectPhaseId, and projectId — providing more than one results in an error |
billable | boolean | No | Whether the time entry is billable (defaults to true) |
userId | number | No | ID of the user the time entry belongs to |
userEmail | string | No | Email of the user the time entry belongs to (alternative to userId) |
notes | string | No | Notes for the time entry |
categoryId | number | No | ID of the time entry category |
includeFields | string | No | Comma-separated extra fields to include in the response (notes, sourceType, deleted, status, submittedBy, submittedAt, approvedBy, approvedAt, rejectedBy, rejectedAt, costRate, billRate) |
includeAllFields | boolean | No | Whether all fields should be returned in the response |
| Parameter | Type | Description |
|---|
timeEntry | object | The created time entry |
Get a single Rocketlane time entry by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
timeEntryId | number | Yes | ID of the time entry to retrieve |
includeFields | string | No | Comma-separated extra fields to include in the response (notes, sourceType, deleted, status, submittedBy, submittedAt, approvedBy, approvedAt, rejectedBy, rejectedAt, costRate, billRate) |
includeAllFields | boolean | No | Whether all fields should be returned in the response |
| Parameter | Type | Description |
|---|
timeEntry | object | The requested time entry |
List Rocketlane time entries with optional filters, sorting, and cursor-based pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
dateEq | string | No | Only entries on this exact date (YYYY-MM-DD) |
dateGt | string | No | Only entries after this date (YYYY-MM-DD) |
dateGe | string | No | Only entries on or after this date (YYYY-MM-DD) |
dateLt | string | No | Only entries before this date (YYYY-MM-DD) |
dateLe | string | No | Only entries on or before this date (YYYY-MM-DD) |
projectIdEq | number | No | Only entries for this project ID |
taskIdEq | number | No | Only entries for this task ID |
projectPhaseIdEq | number | No | Only entries for this project phase ID |
categoryIdEq | number | No | Only entries with this category ID |
userIdEq | number | No | Only entries belonging to this user ID |
emailIdEq | string | No | Only entries belonging to the user with this exact email |
emailIdCn | string | No | Only entries whose user email contains this text |
sourceTypeEq | string | No | Only entries with this source type (GOOGLE_CALENDAR, OUTLOOK_CALENDAR, TASK, PROJECT, PHASE, ADHOC, MILESTONE) |
activityNameEq | string | No | Only entries with this exact activity name |
activityNameCn | string | No | Only entries whose activity name contains this text |
approvalStatusEq | string | No | Only entries with this approval status (NOT_SUBMITTED, SUBMITTED, APPROVED, REJECTED) |
billableEq | boolean | No | Only billable (true) or non-billable (false) entries |
includeDeletedEq | boolean | No | Whether deleted time entries are included in the response |
submittedByEq | number | No | Only entries submitted by this user ID |
approvedByEq | number | No | Only entries approved by this user ID |
rejectedByEq | number | No | Only entries rejected by this user ID |
createdAtGt | number | No | Only entries created after this epoch-millisecond timestamp |
createdAtLt | number | No | Only entries created before this epoch-millisecond timestamp |
updatedAtGt | number | No | Only entries updated after this epoch-millisecond timestamp |
updatedAtLt | number | No | Only entries updated before this epoch-millisecond timestamp |
match | string | No | How to combine filters: all (AND, default) or any (OR) |
sortBy | string | No | Field to sort by (minutes, date, id, billable) |
sortOrder | string | No | Sort order: ASC or DESC (default DESC) |
includeFields | string | No | Comma-separated extra fields to include in the response (notes, sourceType, deleted, status, submittedBy, submittedAt, approvedBy, approvedAt, rejectedBy, rejectedAt, costRate, billRate) |
pageSize | number | No | Maximum number of entries per page (defaults to 100) |
pageToken | string | No | Page token from a previous response for fetching the next page |
| Parameter | Type | Description |
|---|
timeEntries | array | List of time entries matching the filters |
pagination | object | Pagination details for the result set |
Search Rocketlane time entries with filters, sorting, and pagination (deprecated by Rocketlane in favor of listing time entries with filters)
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
dateEq | string | No | Only entries on this exact date (YYYY-MM-DD) |
dateGt | string | No | Only entries after this date (YYYY-MM-DD) |
dateGe | string | No | Only entries on or after this date (YYYY-MM-DD) |
dateLt | string | No | Only entries before this date (YYYY-MM-DD) |
dateLe | string | No | Only entries on or before this date (YYYY-MM-DD) |
projectEq | number | No | Only entries for this project ID |
taskEq | number | No | Only entries for this task ID |
projectPhaseIdEq | number | No | Only entries for this project phase ID |
categoryIdEq | number | No | Only entries with this category ID |
userIdEq | number | No | Only entries belonging to this user ID |
sourceTypeEq | string | No | Only entries with this source type (GOOGLE_CALENDAR, OUTLOOK_CALENDAR, TASK, PROJECT, PHASE, ADHOC, MILESTONE) |
activityNameEq | string | No | Only entries with this exact activity name |
activityNameCn | string | No | Only entries whose activity name contains this text |
approvalStatusEq | string | No | Only entries with this approval status (NOT_SUBMITTED, SUBMITTED, APPROVED, REJECTED) |
match | string | No | How to combine filters: all (AND, default) or any (OR) |
sortBy | string | No | Field to sort by (minutes, date, id, billable) |
sortOrder | string | No | Sort order: ASC or DESC (default DESC) |
includeFields | string | No | Comma-separated extra fields to include in the response (notes, sourceType, deleted, status, submittedBy, submittedAt, approvedBy, approvedAt, rejectedBy, rejectedAt, costRate, billRate) |
includeAllFields | boolean | No | Whether all fields should be returned in the response |
pageSize | number | No | Maximum number of entries per page (defaults to 100) |
pageToken | string | No | Page token from a previous response for fetching the next page |
| Parameter | Type | Description |
|---|
timeEntries | array | List of time entries matching the search filters |
pagination | object | Pagination details for the result set |
Update a Rocketlane time entry by ID. The activityName, notes, billable, and minutes properties can be updated
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
timeEntryId | number | Yes | ID of the time entry to update |
date | string | Yes | Date of the time entry in YYYY-MM-DD format (mandatory so the total time for the date does not exceed 24 hours) |
minutes | number | Yes | Duration of the time entry in minutes (1-1440) |
activityName | string | No | New name for the adhoc activity |
notes | string | No | New notes for the time entry |
billable | boolean | No | Whether the time entry is billable |
categoryId | number | No | ID of the time entry category |
includeFields | string | No | Comma-separated extra fields to include in the response (notes, sourceType, deleted, status, submittedBy, submittedAt, approvedBy, approvedAt, rejectedBy, rejectedAt, costRate, billRate) |
includeAllFields | boolean | No | Whether all fields should be returned in the response |
| Parameter | Type | Description |
|---|
timeEntry | object | The updated time entry |
Permanently delete a Rocketlane time entry by ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
timeEntryId | number | Yes | ID of the time entry to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the time entry was deleted |
timeEntryId | number | ID of the deleted time entry |
List the time entry categories configured in Rocketlane
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
pageSize | number | No | Maximum number of categories per page (defaults to 100) |
pageToken | string | No | Page token from a previous response for fetching the next page |
| Parameter | Type | Description |
|---|
categories | array | List of time entry categories |
pagination | object | Pagination details for the result set |
Create a time-off for a team member in Rocketlane. Holidays and weekends within the date range are automatically excluded from the duration.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
userId | number | No | User ID of the team member taking the time-off (provide this or the user email) |
userEmail | string | No | Email of the team member taking the time-off (provide this or the user ID) |
startDate | string | Yes | Time-off start date in YYYY-MM-DD format |
endDate | string | Yes | Time-off end date in YYYY-MM-DD format (on or after the start date) |
type | string | Yes | Type of the time-off: FULL_DAY, HALF_DAY, or CUSTOM |
durationInMinutes | number | No | Duration in minutes per day; required when type is CUSTOM |
note | string | No | Note or comment about the time-off |
notifyProjectOwners | boolean | No | Notify project owners of projects the user is part of |
notifyUserIds | array | No | User IDs of additional users to notify about the time-off |
notifyUserEmails | array | No | Emails of additional users to notify about the time-off |
includeFields | array | No | Optional fields to include in the response: note, notifyUsers |
includeAllFields | boolean | No | Return all fields in the response |
| Parameter | Type | Description |
|---|
timeOff | object | The created time-off |
Retrieve a Rocketlane time-off by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
timeOffId | number | Yes | Unique identifier of the time-off |
includeFields | array | No | Optional fields to include in the response: note, notifyUsers |
includeAllFields | boolean | No | Return all fields in the response |
| Parameter | Type | Description |
|---|
timeOff | object | The requested time-off |
List time-offs in Rocketlane with optional date, type, and user filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
pageSize | number | No | Maximum number of time-offs per page (defaults to 100) |
pageToken | string | No | Page token from a previous response (valid for 15 minutes) |
includeFields | array | No | Optional fields to include in the response: note, notifyUsers |
includeAllFields | boolean | No | Return all fields in the response |
sortBy | string | No | Field to sort by: startDate, endDate, or createdAt |
sortOrder | string | No | Sort order: ASC or DESC (defaults to DESC) |
match | string | No | Combine filters with AND (all) or OR (any); defaults to all |
startDateGt | string | No | Return time-offs with start dates greater than this date (YYYY-MM-DD) |
startDateEq | string | No | Return time-offs with start dates equal to this date (YYYY-MM-DD) |
startDateLt | string | No | Return time-offs with start dates lesser than this date (YYYY-MM-DD) |
startDateGe | string | No | Return time-offs with start dates greater than or equal to this date (YYYY-MM-DD) |
startDateLe | string | No | Return time-offs with start dates lesser than or equal to this date (YYYY-MM-DD) |
endDateGt | string | No | Return time-offs with end dates greater than this date (YYYY-MM-DD) |
endDateEq | string | No | Return time-offs with end dates equal to this date (YYYY-MM-DD) |
endDateLt | string | No | Return time-offs with end dates lesser than this date (YYYY-MM-DD) |
endDateGe | string | No | Return time-offs with end dates greater than or equal to this date (YYYY-MM-DD) |
endDateLe | string | No | Return time-offs with end dates lesser than or equal to this date (YYYY-MM-DD) |
typeEq | string | No | Return time-offs matching this type: FULL_DAY, HALF_DAY, or CUSTOM |
typeOneOf | string | No | Comma-separated time-off types to match any of (FULL_DAY, HALF_DAY, CUSTOM) |
typeNoneOf | string | No | Comma-separated time-off types to match none of (FULL_DAY, HALF_DAY, CUSTOM) |
userIdEq | string | No | Return time-offs that exactly match this user ID |
userIdOneOf | string | No | Comma-separated user IDs to match any of |
userIdNoneOf | string | No | Comma-separated user IDs to match none of |
emailIdEq | string | No | Return time-offs that exactly match this user email |
emailIdOneOf | string | No | Comma-separated user emails to match any of |
emailIdNoneOf | string | No | Comma-separated user emails to match none of |
| Parameter | Type | Description |
|---|
timeOffs | array | List of time-offs |
pagination | object | Pagination details for the result set |
Permanently delete a Rocketlane time-off by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
timeOffId | number | Yes | Unique identifier of the time-off to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the time-off was deleted |
timeOffId | number | ID of the deleted time-off |
Retrieve a Rocketlane user by their ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
userId | number | Yes | ID of the user to retrieve |
includeFields | string | No | Comma-separated extra fields to include: role, company, permission, holidayCalendar, capacityInMinutes, profilePictureUrl |
includeAllFields | boolean | No | Whether to include all fields in the response |
| Parameter | Type | Description |
|---|
user | object | The requested user |
List users in your Rocketlane account, with optional filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
pageSize | number | No | Maximum number of users per page (defaults to 100) |
pageToken | string | No | Page token from a previous request (valid for 15 minutes) |
includeFields | string | No | Comma-separated extra fields to include: role, company, permission, holidayCalendar, capacityInMinutes, profilePictureUrl |
includeAllFields | boolean | No | Whether to include all fields in the response |
sortBy | string | No | Field to sort by: email, firstName, lastName, type, status, or capacityInMinutes |
sortOrder | string | No | Sort order: ASC or DESC (defaults to DESC) |
match | string | No | How to combine filters: all (AND) or any (OR); defaults to all |
firstNameEq | string | No | Only include users whose first name exactly matches this value |
firstNameCn | string | No | Only include users whose first name contains this value |
firstNameNc | string | No | Exclude users whose first name contains this value |
lastNameEq | string | No | Only include users whose last name exactly matches this value |
lastNameCn | string | No | Only include users whose last name contains this value |
lastNameNc | string | No | Exclude users whose last name contains this value |
emailEq | string | No | Only include users whose email exactly matches this value |
emailCn | string | No | Only include users whose email contains this value |
emailNc | string | No | Exclude users whose email contains this value |
statusEq | string | No | Only include users with this status: INACTIVE, INVITED, ACTIVE, or PASSIVE |
statusOneOf | string | No | Comma-separated statuses; only include users matching one of them (INACTIVE, INVITED, ACTIVE, PASSIVE) |
statusNoneOf | string | No | Comma-separated statuses; exclude users matching any of them (INACTIVE, INVITED, ACTIVE, PASSIVE) |
typeEq | string | No | Only include users of this type: TEAM_MEMBER, PARTNER, CUSTOMER, or EXTERNAL_PARTNER |
typeOneOf | string | No | Comma-separated types; only include users matching one of them (TEAM_MEMBER, PARTNER, CUSTOMER, EXTERNAL_PARTNER) |
roleIdEq | string | No | Only include users with this role ID |
roleIdOneOf | string | No | Comma-separated role IDs; only include users matching one of them |
roleIdNoneOf | string | No | Comma-separated role IDs; exclude users matching any of them |
permissionIdEq | string | No | Only include users with this permission ID |
permissionIdOneOf | string | No | Comma-separated permission IDs; only include users matching one of them |
permissionIdNoneOf | string | No | Comma-separated permission IDs; exclude users matching any of them |
capacityInMinutesEq | number | No | Only include users whose capacity in minutes equals this value |
capacityInMinutesGt | number | No | Only include users whose capacity in minutes is greater than this value |
capacityInMinutesGe | number | No | Only include users whose capacity in minutes is greater than or equal to this value |
capacityInMinutesLt | number | No | Only include users whose capacity in minutes is less than this value |
capacityInMinutesLe | number | No | Only include users whose capacity in minutes is less than or equal to this value |
createdAtGt | number | No | Only include users created after this time (epoch millis) |
createdAtEq | number | No | Only include users created at exactly this time (epoch millis) |
createdAtLt | number | No | Only include users created before this time (epoch millis) |
createdAtGe | number | No | Only include users created at or after this time (epoch millis) |
createdAtLe | number | No | Only include users created at or before this time (epoch millis) |
updatedAtGt | number | No | Only include users updated after this time (epoch millis) |
updatedAtEq | number | No | Only include users updated at exactly this time (epoch millis) |
updatedAtLt | number | No | Only include users updated before this time (epoch millis) |
updatedAtGe | number | No | Only include users updated at or after this time (epoch millis) |
updatedAtLe | number | No | Only include users updated at or before this time (epoch millis) |
| Parameter | Type | Description |
|---|
users | array | List of users |
pagination | object | Pagination details |
Create a new space in a Rocketlane project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | ID of the project the space belongs to |
spaceName | string | Yes | Name of the space |
private | boolean | No | Whether the space is private or shared (defaults to false) |
| Parameter | Type | Description |
|---|
space | object | The created space |
Retrieve a Rocketlane space by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
spaceId | number | Yes | ID of the space to retrieve |
| Parameter | Type | Description |
|---|
space | object | The requested space |
List spaces in a Rocketlane project, with optional filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | ID of the project whose spaces to list |
pageSize | number | No | Maximum number of spaces per page (defaults to 100) |
pageToken | string | No | Page token from a previous request (valid for 15 minutes) |
sortBy | string | No | Field to sort by (spaceName) |
sortOrder | string | No | Sort order: ASC or DESC (defaults to DESC) |
match | string | No | How to combine filters: all (AND) or any (OR); defaults to all |
spaceNameEq | string | No | Only include spaces whose name exactly matches this value |
spaceNameCn | string | No | Only include spaces whose name contains this value |
spaceNameNc | string | No | Exclude spaces whose name contains this value |
createdAtGt | number | No | Only include spaces created after this time (epoch millis) |
createdAtEq | number | No | Only include spaces created at exactly this time (epoch millis) |
createdAtLt | number | No | Only include spaces created before this time (epoch millis) |
createdAtGe | number | No | Only include spaces created at or after this time (epoch millis) |
createdAtLe | number | No | Only include spaces created at or before this time (epoch millis) |
updatedAtGt | number | No | Only include spaces updated after this time (epoch millis) |
updatedAtEq | number | No | Only include spaces updated at exactly this time (epoch millis) |
updatedAtLt | number | No | Only include spaces updated before this time (epoch millis) |
updatedAtGe | number | No | Only include spaces updated at or after this time (epoch millis) |
updatedAtLe | number | No | Only include spaces updated at or before this time (epoch millis) |
| Parameter | Type | Description |
|---|
spaces | array | List of spaces |
pagination | object | Pagination details |
Update a Rocketlane space by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
spaceId | number | Yes | ID of the space to update |
spaceName | string | No | New name of the space |
| Parameter | Type | Description |
|---|
space | object | The updated space |
Permanently delete a Rocketlane space by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
spaceId | number | Yes | ID of the space to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the space was deleted |
spaceId | number | ID of the deleted space |
Create a new space document in a Rocketlane space
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
spaceId | number | Yes | ID of the space the document belongs to |
spaceDocumentType | string | Yes | Type of the space document: ROCKETLANE_DOCUMENT or EMBEDDED_DOCUMENT |
spaceDocumentName | string | No | Name of the space document (defaults to Untitled) |
url | string | No | URL to embed in the space document (for embedded documents) |
templateId | number | No | ID of the document template to create the document from |
| Parameter | Type | Description |
|---|
spaceDocument | object | The created space document |
Retrieve a Rocketlane space document by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
spaceDocumentId | number | Yes | ID of the space document to retrieve |
| Parameter | Type | Description |
|---|
spaceDocument | object | The requested space document |
List space documents in a Rocketlane project, with optional filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
projectId | number | Yes | ID of the project whose space documents to list |
pageSize | number | No | Maximum number of space documents per page (defaults to 100) |
pageToken | string | No | Page token from a previous request (valid for 15 minutes) |
sortBy | string | No | Field to sort by (spaceTabName) |
sortOrder | string | No | Sort order: ASC or DESC (defaults to DESC) |
match | string | No | How to combine filters: all (AND) or any (OR); defaults to all |
spaceDocumentNameEq | string | No | Only include space documents whose name exactly matches this value |
spaceDocumentNameCn | string | No | Only include space documents whose name contains this value |
spaceDocumentNameNc | string | No | Exclude space documents whose name contains this value |
spaceIdEq | number | No | Only include space documents in the space with this ID |
createdAtGt | number | No | Only include space documents created after this time (epoch millis) |
createdAtEq | number | No | Only include space documents created at exactly this time (epoch millis) |
createdAtLt | number | No | Only include space documents created before this time (epoch millis) |
createdAtGe | number | No | Only include space documents created at or after this time (epoch millis) |
createdAtLe | number | No | Only include space documents created at or before this time (epoch millis) |
updatedAtGt | number | No | Only include space documents updated after this time (epoch millis) |
updatedAtEq | number | No | Only include space documents updated at exactly this time (epoch millis) |
updatedAtLt | number | No | Only include space documents updated before this time (epoch millis) |
updatedAtGe | number | No | Only include space documents updated at or after this time (epoch millis) |
updatedAtLe | number | No | Only include space documents updated at or before this time (epoch millis) |
| Parameter | Type | Description |
|---|
spaceDocuments | array | List of space documents |
pagination | object | Pagination details |
Update a Rocketlane space document by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
spaceDocumentId | number | Yes | ID of the space document to update |
spaceDocumentName | string | No | New name of the space document |
url | string | No | New URL to embed in the space document (for embedded documents) |
| Parameter | Type | Description |
|---|
spaceDocument | object | The updated space document |
Permanently delete a Rocketlane space document by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
spaceDocumentId | number | Yes | ID of the space document to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the space document was deleted |
spaceDocumentId | number | ID of the deleted space document |
List resource allocations in Rocketlane within a date range, with optional member, project, and placeholder filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
startDate | string | Yes | Return allocations that start on or after this date (YYYY-MM-DD) |
endDate | string | Yes | Return allocations that end on or before this date (YYYY-MM-DD) |
pageSize | number | No | Maximum number of allocations per page (defaults to 100) |
pageToken | string | No | Page token from a previous response (valid for 15 minutes) |
includeFields | array | No | Optional fields to include in the response: member, task, placeholder, duration |
includeAllFields | boolean | No | Return all fields in the response |
sortBy | string | No | Field to sort by: startDate, endDate, allocationType, or allocationFor |
sortOrder | string | No | Sort order: ASC or DESC (defaults to DESC) |
match | string | No | Combine filters with AND (all) or OR (any); defaults to all |
memberIdEq | string | No | Return allocations that exactly match this member ID |
memberIdOneOf | string | No | Comma-separated member IDs to match any of |
memberIdNoneOf | string | No | Comma-separated member IDs to exclude |
projectIdEq | string | No | Return allocations that exactly match this project ID |
projectIdOneOf | string | No | Comma-separated project IDs to match any of |
projectIdNoneOf | string | No | Comma-separated project IDs to exclude |
placeholderIdEq | string | No | Return allocations that exactly match this placeholder ID |
placeholderIdOneOf | string | No | Comma-separated placeholder IDs to match any of |
placeholderIdNoneOf | string | No | Comma-separated placeholder IDs to exclude |
| Parameter | Type | Description |
|---|
allocations | array | List of resource allocations |
pagination | object | Pagination details for the result set |
Retrieve a Rocketlane invoice by its ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
invoiceId | number | Yes | Unique identifier of the invoice |
includeFields | array | No | Optional fields to include in the response: notes, attachments |
includeAllFields | boolean | No | Return all fields in the response |
| Parameter | Type | Description |
|---|
invoice | object | The requested invoice |
Search invoices in Rocketlane with date, amount, company, invoice-number, and status filters, sorting, and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
pageSize | number | No | Maximum number of invoices per page (defaults to 100) |
pageToken | string | No | Page token from a previous response (valid for 15 minutes) |
includeFields | array | No | Optional fields to include in the response: notes, attachments |
includeAllFields | boolean | No | Return all fields in the response |
sortBy | string | No | Field to sort by: createdAt or invoiceNumber |
sortOrder | string | No | Sort order: ASC or DESC (defaults to DESC) |
match | string | No | Combine filters with AND (all) or OR (any); defaults to all |
dateOfIssueEq | string | No | Filter by date of issue equal to this date (YYYY-MM-DD) |
dateOfIssueGt | string | No | Filter by date of issue greater than this date (YYYY-MM-DD) |
dateOfIssueGe | string | No | Filter by date of issue greater than or equal to this date (YYYY-MM-DD) |
dateOfIssueLt | string | No | Filter by date of issue less than this date (YYYY-MM-DD) |
dateOfIssueLe | string | No | Filter by date of issue less than or equal to this date (YYYY-MM-DD) |
dueDateEq | string | No | Filter by due date equal to this date (YYYY-MM-DD) |
dueDateGt | string | No | Filter by due date greater than this date (YYYY-MM-DD) |
dueDateGe | string | No | Filter by due date greater than or equal to this date (YYYY-MM-DD) |
dueDateLt | string | No | Filter by due date less than this date (YYYY-MM-DD) |
dueDateLe | string | No | Filter by due date less than or equal to this date (YYYY-MM-DD) |
amountEq | number | No | Filter by total amount equal to this value |
amountGt | number | No | Filter by total amount greater than this value |
amountGe | number | No | Filter by total amount greater than or equal to this value |
amountLt | number | No | Filter by total amount less than this value |
amountLe | number | No | Filter by total amount less than or equal to this value |
amountOutstandingEq | number | No | Filter by amount outstanding equal to this value |
amountOutstandingGt | number | No | Filter by amount outstanding greater than this value |
amountOutstandingGe | number | No | Filter by amount outstanding greater than or equal to this value |
amountOutstandingLt | number | No | Filter by amount outstanding less than this value |
amountOutstandingLe | number | No | Filter by amount outstanding less than or equal to this value |
amountPaidEq | number | No | Filter by amount paid equal to this value |
amountPaidGt | number | No | Filter by amount paid greater than this value |
amountPaidGe | number | No | Filter by amount paid greater than or equal to this value |
amountPaidLt | number | No | Filter by amount paid less than this value |
amountPaidLe | number | No | Filter by amount paid less than or equal to this value |
amountWrittenOffEq | number | No | Filter by amount written off equal to this value |
amountWrittenOffGt | number | No | Filter by amount written off greater than this value |
amountWrittenOffGe | number | No | Filter by amount written off greater than or equal to this value |
amountWrittenOffLt | number | No | Filter by amount written off less than this value |
amountWrittenOffLe | number | No | Filter by amount written off less than or equal to this value |
createdAtEq | number | No | Filter by created timestamp equal to this value (epoch milliseconds) |
createdAtGt | number | No | Filter by created timestamp greater than this value (epoch milliseconds) |
createdAtGe | number | No | Filter by created timestamp greater than or equal to this value (epoch milliseconds) |
createdAtLt | number | No | Filter by created timestamp less than this value (epoch milliseconds) |
createdAtLe | number | No | Filter by created timestamp less than or equal to this value (epoch milliseconds) |
companyIdEq | string | No | Return invoices that exactly match this customer company ID |
companyIdOneOf | string | No | Comma-separated customer company IDs to match any of |
companyIdNoneOf | string | No | Comma-separated customer company IDs to match none of |
invoiceNumberEq | string | No | Return invoices whose invoice number equals this value |
invoiceNumberCn | string | No | Return invoices whose invoice number contains this text |
invoiceNumberNc | string | No | Return invoices whose invoice number does not contain this text |
statusEq | string | No | Return invoices that equal this status (e.g. DRAFT) |
statusOneOf | string | No | Comma-separated statuses to match any of (e.g. DRAFT,PAID) |
statusNoneOf | string | No | Comma-separated statuses to match none of (e.g. DRAFT,PAID) |
| Parameter | Type | Description |
|---|
invoices | array | List of invoices |
pagination | object | Pagination details for the result set |
List line items of a Rocketlane invoice
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
invoiceId | number | Yes | Unique identifier of the invoice |
pageSize | number | No | Maximum number of line items per page (defaults to 100) |
pageToken | string | No | Page token from a previous response (valid for 15 minutes) |
| Parameter | Type | Description |
|---|
lineItems | array | List of invoice line items |
pagination | object | Pagination details for the result set |
List payments recorded against a Rocketlane invoice
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Rocketlane API key |
invoiceId | number | Yes | Unique identifier of the invoice |
pageSize | number | No | Maximum number of payments per page (defaults to 100) |
pageToken | string | No | Page token from a previous response (valid for 15 minutes) |
| Parameter | Type | Description |
|---|
payments | array | List of payments recorded against the invoice |
pagination | object | Pagination details for the result set |
- Category:
tools
- Type:
rocketlane
