Skip to main content

Set a new project up

Category: Project Setup

Creates the project under your company with its name, reference, location, sector, phase, dates and budget, and can apply your standard defaults.

Input Parameters​

ParameterTypeRequiredDescription
Project NameTextYesDisplay name for the new project.
Project ReferenceTextNoInternal reference identifier (e.g. job number).
DescriptionTextNoShort description of the project scope.
LocationTextNoProject site address or location (used for geocoding).
SectorDropdownYesSector classification for the project.
PhaseDropdownYesThe stage the project is at now.
Start DateDateNoPlanned project start date.
End DateDateNoPlanned project end date.
BudgetNumberNoProject budget (numeric value, in the selected currency).
CurrencyDropdownNoCurrency for the budget.
TagsTextNoComma-separated tags to apply to the project.
Project CategoryDropdownNoTop-level category used to pick the right setup task. Building covers vertical construction (resi...
Project SetupDropdownNoWhether to follow creation with a set-up task. The link you get back starts the project with the ...
Project Defaults SnapshotDropdownNoOptionally apply a saved set of project defaults after creation (seeds the registers, templates, ...

Parameter Details​

Project Name

Display name for the new project.

Default: ``

Project Reference

Internal reference identifier (e.g. job number).

Default: ``

Description

Short description of the project scope.

Default: ``

Location

Project site address or location (used for geocoding).

Default: ``

Sector

Sector classification for the project.

Options:

  • residential - Residential
  • commercial - Commercial
  • industrial - Industrial
  • education - Education
  • healthcare - Healthcare
  • infrastructure - Infrastructure
  • rail - Rail
  • water_utilities - Water & Utilities
  • highways - Highways
  • ports - Ports
  • energy - Energy
  • mixed_use - Mixed Use
  • other - Other

Default: ``

Phase

The stage the project is at now.

Options:

  • Initiation / Feasibility - Initiation / Feasibility
  • Concept & Design Development - Concept & Design Development
  • Detailed Design & Approvals - Detailed Design & Approvals
  • Procurement / Tendering - Procurement / Tendering
  • Construction - Construction
  • Commissioning & Handover - Commissioning & Handover
  • Operation & Maintenance - Operation & Maintenance
  • End of Life / Refurbishment - End of Life / Refurbishment
  • Other - Other

Default: Construction

Start Date

Planned project start date.

Default: ``

End Date

Planned project end date.

Default: ``

Currency

Currency for the budget.

Options:

  • GBP - GBP (£)
  • EUR - EUR (€)
  • USD - USD ($)
  • AUD - AUD ($)
  • CAD - CAD ($)

Default: GBP

Tags

Comma-separated tags to apply to the project.

Default: ``

Project Category

Top-level category used to pick the right setup task. Building covers vertical construction (residential, commercial, mixed-use); infrastructure covers linear/civils work (rail, highways, water, ports, energy).

Options:

  • building - Building
  • infrastructure - Infrastructure

Default: building

Project Setup

Whether to follow creation with a set-up task. The link you get back starts the project with the set-up you choose. Full set-up drafts your management documents and needs a pre-construction information document; quick set-up just fills in the project essentials from whatever you have to hand.

Options:

  • full - Full setup — generate my management documents (recommended)
  • basic - Quick setup — just fill in the project essentials
  • none - Skip setup

Default: full

Project Defaults Snapshot

Optionally apply a saved set of project defaults after creation (seeds the registers, templates, dashboards and so on). Choose "None" to start from a blank project.

Options:

  • `` - None — start from a blank project

Default: ``

Outputs​

Summary​

Type: Text/Markdown

Summary

Project Id​

Type: Text/Markdown

Project ID

Project Name​

Type: Text/Markdown

Project Name

Project Url​

Type: Text/Markdown

Open Project

Outputs​

Type: Array

Outputs

Completion Time​

Type: Text/Markdown

Completion Time

Example Use Cases​

Create a residential construction project​

Create a new residential project in the construction phase with GBP budget.

Configuration:

  • Name: Riverside Phase 2
  • Project Reference: JOB-2026-014
  • Description: 12-storey residential block, 84 units.
  • Location: 12 Riverside Way, London
  • Sector: residential
  • Phase: Construction
  • Start Date: 2026-06-01
  • End Date: 2028-03-31
  • Budget: 18500000
  • Currency: GBP
  • Tags: flagship, design-build
  • Project Category: building
  • Setup Mode: full

Tags: project · create · onboarding · setup

Last updated: 2026-08-31