openapi: 3.0.1
info:
title: Rocketlane Comments Projects API
description: Rocketlane API
version: '1.0'
servers:
- url: https://api.rocketlane.com/api
description: Production
- url: https://api.nitro.run/api
description: Staging
- url: https://project.api.orbits.run/api
description: Orbits
security:
- api-key:
- 'read : write'
tags:
- name: Projects
description: Endpoints for projects resource
paths:
/1.0/projects/{projectId}:
get:
tags:
- Projects
summary: Get project by Id
operationId: get-project
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
- name: includeFields
in: query
description: 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.
required: false
style: form
explode: false
schema:
type: array
items:
type: string
enum:
- annualizedRecurringRevenue
- projectFee
- allocatedHours
- allocatedMinutes
- budgetedHours
- percentageBudgetedHoursConsumed
- percentageBudgetConsumed
- billableHours
- billableMinutes
- nonBillableHours
- nonBillableMinutes
- trackedHours
- trackedMinutes
- progressPercentage
- startDateActual
- dueDateActual
- currentPhase
- autoAllocation
- sources
- inferredProgress
- plannedDuration
- projectAgeInDays
- customersInvited
- customersJoined
- externalReferenceId
- metrics
- remainingMinutes
- remainingHours
- name: includeAllFields
in: query
description: 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.
required: false
schema:
type: boolean
example: true
responses:
'200':
description: The requested action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPublicAPIResponseEntity'
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
put:
tags:
- Projects
summary: Update project by Id
operationId: update-project
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
- name: includeFields
in: query
description: 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.
required: false
style: form
explode: false
schema:
type: array
items:
type: string
enum:
- annualizedRecurringRevenue
- projectFee
- allocatedHours
- allocatedMinutes
- budgetedHours
- percentageBudgetedHoursConsumed
- percentageBudgetConsumed
- billableHours
- billableMinutes
- nonBillableHours
- nonBillableMinutes
- trackedHours
- trackedMinutes
- progressPercentage
- startDateActual
- dueDateActual
- currentPhase
- autoAllocation
- sources
- inferredProgress
- plannedDuration
- projectAgeInDays
- customersInvited
- customersJoined
- externalReferenceId
- metrics
- remainingMinutes
- remainingHours
- name: includeAllFields
in: query
description: 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.
required: false
schema:
type: boolean
example: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPublicUpdateAPIRequestEntity'
responses:
'200':
description: The requested action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPublicAPIResponseEntity'
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
'500':
description: This error denotes that there is an error that occured within our servers. The response body could help narrow down the cause for the error by our support team.
content:
application/json:
schema:
$ref: '#/components/schemas/serverErrorErrorlist'
delete:
tags:
- Projects
summary: Delete project by Id
operationId: delete-project
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
responses:
'204':
description: The resource was successfully removed from the database.
content:
application/json:
schema:
type: string
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
/1.0/projects/{projectId}/unassign-placeholders:
post:
tags:
- Projects
summary: Un assign placeholders from an user in a project
operationId: unassign-placeholders
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlaceholderRemoveMappingPublicAPIRequestEntity'
required: true
responses:
'200':
description: The requested action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPublicPlaceholdersAPIResponseEntity'
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
/1.0/projects/{projectId}/remove-members:
post:
tags:
- Projects
summary: Remove members from a project
operationId: remove-members
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveMembersPublicAPIRequestEntity'
required: true
responses:
'200':
description: The requested action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPublicTeamMembersAPIResponseEntity'
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
/1.0/projects/{projectId}/import-template:
post:
tags:
- Projects
summary: Import a template to a project
operationId: import-template
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProjectImportPublicAPIRequestEntity'
required: true
responses:
'200':
description: The requested action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPublicImportTemplateAPIResponseEntity'
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
/1.0/projects/{projectId}/get-placeholders:
post:
tags:
- Projects
summary: Get placeholders
description: This endpoint can be used to search for placeholders across project. The response body is paginated and you can control the pagination using the `limit` and `pageToken` parameters.
operationId: get-placeholders
parameters:
- name: projectId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: The requested action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/ExampleAPIResponsePlaceholders'
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
/1.0/projects/{projectId}/assign-placeholders:
post:
tags:
- Projects
summary: Assign placeholders to an user in a project
operationId: assign-placeholders
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlaceholderMappingPublicAPIRequestEntity'
required: true
responses:
'200':
description: The requested action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPublicPlaceholdersAPIResponseEntity'
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
/1.0/projects/{projectId}/archive:
post:
tags:
- Projects
summary: Archive project by Id
operationId: archiveProject
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
responses:
'204':
description: The resource was successfully removed from the database.
content:
application/json:
schema:
type: string
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
/1.0/projects/{projectId}/add-members:
post:
tags:
- Projects
summary: Add members to a project
operationId: add-members
parameters:
- name: projectId
in: path
description: The project's unique, system-generated identifier, which can be used to identify the project globally.
required: true
schema:
minimum: 0
type: integer
format: int64
default: 1
example: 200
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectAddMembersPublicRequest'
required: true
responses:
'200':
description: The requested action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectPublicTeamMembersAPIResponseEntity'
'400':
description: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestErrorlist'
'401':
description: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedErrorlist'
'404':
description: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundErrorlist'
/1.0/projects:
get:
tags:
- Projects
summary: Get all projects
operationId: get-all-projects
parameters:
- name: pageSize
in: query
description: 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.
schema:
minimum: 0
type: number
format: int32
example: 100
- name: pageToken
in: query
description: 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.
schema:
type: string
example: 59c12a42-dd10-11ed-afa1-0242ac120002
- name: includeFields
in: query
description: 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.
style: form
explode: false
schema:
type: array
items:
type: string
enum:
- annualizedRecurringRevenue
- projectFee
- allocatedHours
- allocatedMinutes
- budgetedHours
- percentageBudgetedHoursConsumed
- percentageBudgetConsumed
- billableHours
- billableMinutes
- nonBillableHours
- nonBillableMinutes
- trackedHours
- trackedMinutes
- progressPercentage
- startDateActual
- dueDateActual
- currentPhase
- autoAllocation
- sources
- inferredProgress
- plannedDuration
- projectAgeInDays
- customersInvited
- customersJoined
- externalReferenceId
- metrics
- remainingMinutes
- remainingHours
- name: includeAllFields
in: query
description: 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.
schema:
type: boolean
example: true
- name: sortBy
in: query
description: For sorting the responses by the provided field, use the sortBy parameter.
schema:
type: string
enum:
- projectName
- startDate
- dueDate
- startDateActual
- dueDateActual
- annualizedRecurringRevenue
- projectFee
- name: sortOrder
in: query
description: The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.
schema:
type: string
enum:
- ASC
- DESC
- name: match
in: query
description: You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.
schema:
type: string
enum:
- all
- any
- name: startDate.gt
in: query
description: You can use this param to provide a date and the responses will contain projects whose date are greater than the given start date.
schema:
type: string
example: '2023-03-28'
- name: startDate.eq
in: query
description: You can use this param to provide a date and the responses will contain exact matches of projects that match the given start date.
schema:
type: string
example: '2023-03-28'
- name: startDate.lt
in: query
description: You can use this param to provide a date and the responses will contain projects whose date are less than the given start date.
schema:
type: string
example: '2023-03-28'
- name: startDate.ge
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: startDate.le
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: dueDate.gt
in: query
description: You can use this param to provide a date and the responses will contain projects whose date are greater than the given due date.
schema:
type: string
example: '2023-03-28'
- name: dueDate.eq
in: query
description: You can use this param to provide a date and the responses will contain exact matches of projects that match the given due date.
schema:
type: string
example: '2023-03-28'
- name: dueDate.lt
in: query
description: You can use this param to provide a date and the responses will contain projects whose date are less than the given due date.
schema:
type: string
example: '2023-03-28'
- name: dueDate.ge
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: dueDate.le
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: startDateActual.gt
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: startDateActual.eq
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: startDateActual.lt
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: startDateActual.ge
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: startDateActual.le
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: dueDateActual.gt
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: dueDateActual.eq
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: dueDateActual.lt
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: dueDateActual.ge
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: dueDateActual.le
in: query
description: 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.
schema:
type: string
example: '2023-03-28'
- name: createdAt.gt
in: query
description: You can
# --- truncated at 32 KB (156 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rocketlane/refs/heads/main/openapi/rocketlane-projects-api-openapi.yml