Rocketlane Projects API is one of 13 APIs that Rocketlane publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
12 operations
across 9 paths,
and defines 63 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 3 base URLs: https://api.rocketlane.com/api, https://api.nitro.run/api, https://project.api.orbits.run/api.
The identity and technical contract details declared by the specification.
Example404
object
2 properties
unauthorizedErrorlist
object
1 property
ProjectFinancialsPublicResponse
object
This section addresses the financial aspects of the projects and the associated fields.
6 properties
MembersPublicAPI
object
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…
3 properties
Example500
object
2 properties
PlaceholderMappingUserPublicAPIRequestEntity
object
The member from the project to assign/replace the placeholder with. If the placeholder's type is CUSTOMER, then the assigning user needs to be a customer user.
2 properties
ProjectPublicImportTemplateAPIResponseEntity
object
19 properties
ProjectCustomerUserPublicAPI
object
The project customers.
4 properties
ProjectPublicTeamMembersAPIResponseEntity
object
18 properties
ProjectStatusPublicResponse
object
The project status value along with the label will be present here.
2 properties
CustomerCompanyProjectPublicResponse
object
Company details for the invoice
3 properties
ImportPublicAPIResponseEntity
object
Sources denotes the project templates involved in creation/ imported post creation of the project.
4 properties
ProjectPhasePublicLiteAPIResponseEntity
object
The phases that are currently marked as in progress are available here.
2 properties
ProjectFieldPublicRequestAPIEntity
object
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 c…
2 properties
ProjectOwnerUserPublicAPI
object
The project owner is mandatory to be specified along with the project creation. The owner gets access to everything in the project and can be used to control t…
4 properties
PlaceholderPublicResponseForExample
object
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…
7 properties
badRequestErrorlist
object
1 property
ProjectImportPublicAPIRequestEntity
object
3 properties
2 required
ProjectPublicAPIResponseEntity
object
45 properties
ProjectVendorUserPublicAPI
object
The team member who last updated the invoice
4 properties
CustomerCompanyProjectPublicRequest
object
This field is required to identify the customer as part of the request. The customer's name is case-sensitive, and an exact match is required for further proce…
2 properties
ProjectResponseMembersResponse
object
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…
3 properties
ExampleAPIResponseProjects
object
2 properties
ProjectRateCardPublicResponse
object
Rate cards allow you to standardise bill rates to be charged depending on the roles of the project's resources. If the rate card chosen does not include the bi…
2 properties
ProjectOwnerCreatePublicRequest
object
The project owner gets access to everything in the project and can be used to control the activities that happens in the project. Note: Changing the owner can…
4 properties
FixedFeeFinancialsPublicRequest
object
This section addresses the financial aspects of the Fixed Fee contract type projects and its associated fields.
1 property
1 required
Example400
object
3 properties
ProjectFinancialsMetrics
object
The metrics used to evaluate and assess the financial aspects of projects.
10 properties
RemoveMembersPublicAPIRequestEntity
object
1 property
1 required
PlaceholderMappingPublicAPIResponseEntity
object
The list of placeholders and the user mappings.
7 properties
ProjectRateCardPublicRequest
object
Rate cards allow you to standardise bill rates to be charged depending on the roles of the project's resources. If the rate card chosen does not include the bi…
1 property
ExamplePaginationPlaceholders
object
Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages.
5 properties
ProjectPublicCreatedByResponse
object
The team member who created the project.
4 properties
ProjectPublicUpdatedByResponse
object
The team member who updated the project
4 properties
ProjectOwnerUserPublicResponse
object
The project owner is the team member who has access to everything in the project and is in charge of managing it. Any team member can be assigned as the projec…
4 properties
ProjectPlaceholderResponsePublicAPI
object
Placeholder
2 properties
SubscriptionFinancialsPublicRequest
object
This section addresses the financial aspects of the Subscription contract type projects and its associated fields.
5 properties
5 required
ProjectPublicUpdateAPIRequestEntity
object
12 properties
ProjectPartnerCompanyPublicAPIResponseEntity
object
The partners field contains list of partner companies.
3 properties
PlaceholderRemoveMappingPublicAPIRequestEntity
object
1 property
1 required
Example401
object
2 properties
TimeAndMaterialFinancialsPublicResponse
object
This section addresses the financial aspects of the Time & Material contract type projects and its associated fields.
2 properties
serverErrorErrorlist
object
1 property
ProjectUsersPublicAPI
object
The team members from your organization working on the project.
4 properties
ProjectFieldPublicResponseAPIEntity
object
Fields lists the custom project fields whose values were provided during project creation or updated later. Refer these [examples](https://developer.rocketlane…
4 properties
ProjectPublicStatusRequest
object
The value of the project status can be specified here and this is essential to keep track of the project.
1 property
ProjectPartnerCompanyPublicAPIRequestEntity
object
The partners field is used to specify partner companies.
2 properties
ExampleAPIResponsePlaceholders
object
2 properties
SubscriptionFinancialsPublicResponse
object
This section addresses the financial aspects of the Subscription contract type projects and its associated fields.
5 properties
ProjectPublicAPIRequestEntity
object
22 properties
3 required
RolePublicAPIPlaceholderResponseEntity
object
The role of the placeholder.
2 properties
ProjectPublicPlaceholdersAPIResponseEntity
object
19 properties
ExamplePaginationProjects
object
Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages.
5 properties
PlaceholderMappingUserPublicAPIResponseEntity
object
The member from the project to assign/replace the placeholder with.
5 properties
TimeAndMaterialFinancialsPublicRequest
object
This section addresses the financial aspects of the Time & Material contract type projects and its associated fields.
2 properties
notFoundErrorlist
object
1 property
ProjectFinancialDetailsPublicRequest
object
This section addresses the financial aspects of the projects and the associated fields.
4 properties
1 required
ProjectAddMembersPublicRequest
object
2 properties
ProjectPublicAPIPlaceholderResponseEntity
object
The project of the placeholder.
2 properties
ProjectPublicAPIResponseExampleEntity
object
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…
45 properties
ProjectCustomerChampionUserPublicAPI
object
The Customer champion is the team member in charge of project management and representing the customer's team.
4 properties
PlaceholderMappingPublicAPIRequestEntity
object
2 properties
2 required
FixedFeeFinancialsPublicResponse
object
This section addresses the financial aspects of the Fixed Fee contract type projects and its associated fields.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Rocketlane publishes across the network.
