v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB

Projects

Get project by Id

get/1.0/projects/{projectId}

Path parameters

projectIdinteger required

The project's unique, system-generated identifier, which can be used to identify the project globally.

Query parameters

includeFieldsstring[]

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.

includeAllFieldsboolean

Example:true

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.

Response

The requested action was successfully executed.

projectIdinteger

The project's unique, system-generated identifier, which can be used to identify the project globally.

projectNamestring

The name of the project.

startDatestring

On this date the project's execution officially begins. If sources (templates) are mentioned in the request, the start date is required. For projects without any defined sources, it may be empty. The format for the start date is YYYY-MM-DD.

dueDatestring

The day on which the project's execution is planned to be completed. The due date is not required and can be left blank. If sources (templates) are included as part of the project creation, the project's due date will be calculated depending on the duration of the specified sources. For projects where both startDate and dueDate are specified, the latter must be on or after the given startDate. The format for the due date is YYYY-MM-DD.

createdAtinteger

The time when the project was created. The referenced time will be in epoch millis.

updatedAtinteger

The time when the project was updated. Any changes that's related to the project are captured and specified here in epoch millis.

archivedboolean

The field archived denotes whether the project is archived or not. If the project is archived, there's an option to un-archive the project.

visibility'EVERYONE' | 'MEMBERS' | 'GROUP'

Set visibility parameters to restrict who can see your project. There are two options: EVERYONE and MEMBERS. Selecting EVERYONE allows all team members from your firm to view the project, while selecting MEMBER restricts access to only those team members who have been specifically invited.

currency'AFN' | 'ALL' | 'DZD' | 'ARS' | 'AMD' | 'AUD' | 'AZN' | 'BHD' | 'BDT' | 'BYN' | 'BZD' | 'BOB' | 'BAM' | 'BWP' | 'BRL' | 'GBP' | 'BND' | 'BGN' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DJF' | 'DOP' | 'EGP' | 'ERN' | 'EEK' | 'ETB' | 'EUR' | 'GEL' | 'GHS' | 'GTQ' | 'GNF' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'LVL' | 'LBP' | 'LYD' | 'LTL' | 'MOP' | 'MKD' | 'MGA' | 'MYR' | 'MUR' | 'MXN' | 'MDL' | 'MAD' | 'MZN' | 'MMK' | 'NAD' | 'NPR' | 'TWD' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PKR' | 'PAB' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'SAR' | 'RSD' | 'SGD' | 'SOS' | 'ZAR' | 'KRW' | 'LKR' | 'SDG' | 'SEK' | 'CHF' | 'SYP' | 'TZS' | 'THB' | 'TOP' | 'TTD' | 'TND' | 'TRY' | 'USD' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'XOF' | 'YER' | 'ZMK' | 'ZWL'

The currency for handling the project’s financials. You can only specify a currency for a project that is added at the account level. Please note that the project’s currency cannot to changed once set.

startDateActualstring

The date on which the project status is changed to in progress. The status can be either the default said status (in progress) or custom statuses that are categorised as in progress. It can be null for projects that have not yet begun. The format for the actual start date is YYYY-MM-DD.

dueDateActualstring

The date when project status gets changed to completed. The status can be either the default provided status (completed) or a custom status that is labelled under the Completed category. It will be null if the project is yet to be completed. The format for the actual due date is YYYY-MM-DD.

annualizedRecurringRevenueinteger

Indicates the value of the recurring revenue of the customer's subscriptions for a single calendar year.

projectFeeinteger

The total fee that is charged for the project.

budgetedHoursnumber double

Budgeted hours represent the total hours allocated for project execution. This value can be edited at any point throughout the project's duration. You can enter the budgeted hours in decimal form, including both hours and minutes, with up to two decimal places of precision. Eg: 1.65 hrs = 1h 39m(1.65h * 60m = 99m).

percentageBudgetedHoursConsumednumber double

The budgeted hours consumed percentage.

percentageBudgetConsumednumber double

The budget consumed percentage.

trackedHoursinteger

The number of hours tracked as part of submitted time-entries are captured here and computed in hours.

trackedMinutesnumber double

The number of minutes tracked as part of submitted time-entries are captured here and computed in minutes.

allocatedHoursinteger

If the project has allocations against say users or placeholders, it is collected and computed in hours.

allocatedMinutesnumber double

If the project has allocations against say users or placeholders, it is collected and computed in minutes.

billableHoursinteger

If the project has time entries tracked under billable, it is collected and computed in hours.

billableMinutesnumber double

If the project has time entries tracked under billable, it is collected and computed in minutes.

nonBillableHoursinteger

If the project has time entries tracked under non-billable, it is collected and computed in hours.

nonBillableMinutesnumber double

If the project has time entries tracked under non-billable, it is collected and computed in minutes.

remainingHoursinteger

Number of hours left to complete the project or task based on tracked and budgeted hours.

remainingMinutesinteger

Number of minutes left to complete the project or task and complements RemainingHours.

progressPercentageinteger

The progress percentage is computed based on the number of tasks that are completed vs the total number of tasks in the project. This can be used to track how much the project has progressed over time.

autoAllocationboolean

The field autoAllocation defines whether Auto Allocation is enabled for the project or not. If auto allocation is enabled, instead of adding it manually, the allocations are computed from the tasks duration, effort and the assignees specified in the project.

plannedDurationInDaysinteger

The difference between startDate and dueDate is computed and stored in days as plannedDurationInDays.

inferredProgress'ON_TRACK' | 'AHEAD_OF_TIME' | 'RUNNING_LATE' | 'NONE'

The inferredProgress can be used to know whether the project's progress is as per the expectation. For eg: the value ON_TRACK specifies that the project is in good state and not further action would be necessary to track the progress of it, whereas the value RUNNING_LATE means that the project state deviates from the original plan and needs immediate attention.

projectAgeInDaysinteger

If both the project actual dates (startDateActual and dueDateActual) are available, the difference is computed and shown in days. If dueDateActual isn't available, then the value is computed by the difference of today's date and the available date under startDateActual. The value will be null or not present if startDateActual is not available.

customersInvitedinteger

Reflects the number of customers that have been invited to the project.

customersJoinedinteger

CustomersJoined tracks the actual number of customers who joined the project after being invited. It is mostly used to track customer engagement.

externalReferenceIdstring

An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency.

Example response

{
  "projectId": 201,
  "projectName": "Acme onboarding",
  "startDate": "2023-03-28",
  "dueDate": "2023-03-28",
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000,
  "owner": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "teamMembers": {
    "members": [
      {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      }
    ],
    "customers": [
      {
        "emailId": "rachel.green@acme.com",
        "userId": 301,
        "firstName": "Rachel",
        "lastName": "Green"
      }
    ],
    "customerChampion": {
      "emailId": "ruth.bell@acme.com",
      "userId": 302,
      "firstName": "Ruth",
      "lastName": "Bell"
    }
  },
  "status": {
    "value": 2,
    "label": "In progress"
  },
  "fields": [
    {
      "fieldId": 201,
      "fieldLabel": "MRR",
      "fieldValue": "1000",
      "fieldValueLabel": "1000"
    }
  ],
  "customer": {
    "companyId": 201,
    "companyName": "Acme Inc",
    "companyUrl": "https://www.acme.com"
  },
  "partnerCompanies": [
    {
      "companyId": 301,
      "companyName": "Modert Inc",
      "companyUrl": "https://www.modert.com"
    }
  ],
  "visibility": "EVERYONE",
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "currency": "USD",
  "financials": {
    "fixedFeeContract": {
      "fixedFee": 100
    },
    "timeAndMaterialContract": {
      "rateCard": {
        "rateCardId": 21,
        "rateCardName": "US Project rate"
      },
      "projectBudget": 100
    },
    "subscriptionContract": {
      "subscriptionFrequency": "MONTHLY",
      "subscriptionStartDate": "2023-03-28",
      "periodMinutes": 60,
      "periodBudget": 10000,
      "noOfPeriods": 10
    },
    "metrics": {
      "actualRevenue": 10000,
      "estimatedRevenue": 200000,
      "actualCost": 200,
      "estimatedCost": 200,
      "actualProfit": 200,
      "estimatedProfit": 200,
      "actualProfitMargin": 200,
      "estimatedProfitMargin": 200,
      "estimateAtCompletion": 200,
      "estimationToCompletionInHours": 200
    }
  },
  "startDateActual": "2023-03-28",
  "dueDateActual": "2023-03-28",
  "annualizedRecurringRevenue": 10000,
  "projectFee": 100000,
  "budgetedHours": 10.5,
  "percentageBudgetedHoursConsumed": 42,
  "percentageBudgetConsumed": 42,
  "trackedHours": 530,
  "trackedMinutes": 530,
  "allocatedHours": 500,
  "allocatedMinutes": 500,
  "billableHours": 500,
  "billableMinutes": 500,
  "nonBillableHours": 500,
  "nonBillableMinutes": 500,
  "remainingHours": 530,
  "remainingMinutes": 530,
  "progressPercentage": 42,
  "currentPhases": [
    {
      "phaseId": 201,
      "phaseName": "Go live"
    }
  ],
  "sources": [
    {
      "prefix": "APAC",
      "startDate": "2023-03-28",
      "templateId": 201,
      "templateName": "Simple Onboarding"
    }
  ],
  "plannedDurationInDays": 24,
  "inferredProgress": "RUNNING_LATE",
  "projectAgeInDays": 38,
  "customersInvited": 5,
  "customersJoined": 12,
  "externalReferenceId": "pr_8171"
}