Sign in
Projects

Create a new project

Creates a new project within a given space.

post/v1/spaces/{spaceId}/projects

Path parameters

spaceIdinteger required

ID of the space

Headers

X-Org-Idinteger required

Organization ID

Request body

namestring required

Name of the project

descriptionstring

Description of the project

isPublicboolean

Indicates if the project is public

startDatestring date-time

Start date of the project

dueDatestring date-time

Due date of the project

statusstring

Status of the project

prioritystring

Priority of the project

healthstring

Health of the project

projectTagsstring[]

List of tags associated with the project

contactinteger

Contact ID associated with the project

actualStartDatestring date-time

Actual start date of the project

actualEndDatestring date-time

Actual end date of the project

allocatedBudgetnumber double

Budget allocated for the project

billableCostnumber double

Billable cost of the project so far

nonBillableCostnumber double

Non-billable cost of the project so far

actualCostnumber double

Actual cost of the project (billable + non-billable)

projectTypestring

Commercial model of the project. One of FIXED_FEE, TIME_AND_MATERIAL, RETAINER. Nullable for legacy/undecided projects.

contractValuenumber double

Contract value for Fixed Fee projects (client-facing amount). Required semantically when projectType=FIXED_FEE.

alertThresholdPercentinteger

Percentage of contract or NTE cap consumed at which the project is flagged AT_RISK. 1..100. Shared by FIXED_FEE (dollars) and TIME_AND_MATERIAL (hours).

nteCapHoursinteger

Not-to-exceed cap in milliseconds for Time & Material projects (matches actualHours unit). Required semantically when projectType=TIME_AND_MATERIAL.

retainerBudgetPeriodstring

Retainer budget period. One of MONTHLY, QUARTERLY, ANNUALLY. Required semantically when projectType=RETAINER.

retainerBudgetedHoursinteger

Per-cycle hour budget in milliseconds for Retainer projects (matches actualHours unit). Required semantically when projectType=RETAINER.

retainerFeenumber double

Per-cycle retainer fee in USD (base currency; converted at read). Required semantically when projectType=RETAINER.

retainerCountHoursModestring

Which time entries count toward the retainer hour bucket. One of BOTH, BILLABLE_ONLY, NON_BILLABLE_ONLY. Defaults to BOTH.

retainerCountCostModestring

Which time entries count toward the retainer cost total. One of BOTH, BILLABLE_ONLY, NON_BILLABLE_ONLY. Defaults to BOTH.

retainerCycleAnchorstring date

First day of the first retainer cycle in yyyy-MM-dd format. Falls back to project startDate, then createdTime, then today.

Example request

{
  "name": "Project Alpha",
  "description": "This is a sample project",
  "isPublic": true,
  "startDate": "2023-01-01",
  "dueDate": "2023-12-31",
  "status": "In Progress",
  "priority": "High",
  "health": "Good",
  "projectTags": [
    "tag1",
    "tag2"
  ],
  "contact": 12345,
  "actualStartDate": "2023-01-05",
  "actualEndDate": "2023-12-15",
  "allocatedBudget": 500000,
  "billableCost": 200000,
  "nonBillableCost": 50000,
  "actualCost": 250000,
  "projectType": "FIXED_FEE",
  "contractValue": 45000,
  "alertThresholdPercent": 80,
  "nteCapHours": 720000000,
  "retainerBudgetPeriod": "MONTHLY",
  "retainerBudgetedHours": 540000000,
  "retainerFee": 8000,
  "retainerCountHoursMode": "BOTH",
  "retainerCountCostMode": "BOTH",
  "retainerCycleAnchor": "2024-01-01"
}

Response

OK

Changes

Changed in 2 of the 10 revisions of this API.1233

  • 2e610947dac4232See the full diff
    • ●

      removed the request property totalCost

      request-property-removed

    • ●

      removed the optional property data/totalCost from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property actualCost

      new-optional-request-property

    • ○

      added the new optional request property alertThresholdPercent

      new-optional-request-property

    • ○

      added the new optional request property contractValue

      new-optional-request-property

    • ○

      added the new optional request property nteCapHours

      new-optional-request-property

    • ○

      added the new optional request property projectType

      new-optional-request-property

    • ○

      added the new optional request property retainerBudgetPeriod

      new-optional-request-property

    • ○

      added the new optional request property retainerBudgetedHours

      new-optional-request-property

    • ○

      added the new optional request property retainerCountCostMode

      new-optional-request-property

    • ○

      added the new optional request property retainerCountHoursMode

      new-optional-request-property

    • ○

      added the new optional request property retainerCycleAnchor

      new-optional-request-property

    • ○

      added the new optional request property retainerFee

      new-optional-request-property

    • ○

      added the optional property data/actualCost to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/alertThresholdPercent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/capUsedPercent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/contractValue to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/margin to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/marginPercent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/nteCapHours to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/overageHours to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/projectType to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/projectTypeLocked to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerBudgetPeriod to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerBudgetUsedPercent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerBudgetedHours to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerCountCostMode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerCountHoursMode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerCycleAnchor to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerFee to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerOverageHours to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/retainerTotalCost to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/spentPercent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/thresholdAlertRecipients to the response with the 200 status

      response-optional-property-added

  • 237f5bbd402911See the full diff
    • ▲

      removed the media type application/hal+json for the response with the status 200

      response-media-type-removed

    • ○

      added the media type application/vnd.hal+json for the response with the status 200

      response-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog