Projects

Create project

Creates a new project.

post/projects

Request

  • Base URL: https://app.buildworkpro.com/api/v1
  • URL: https://app.buildworkpro.com/api/v1/projects
  • Auth: HTTP bearer

Headers

Idempotency-Keystring uuid

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Request body

namestring required
projectNumberstring
contactIdinteger nullable
projectTypestring nullable
status'planning' | 'in_progress' | 'on_hold' | 'closeout' | 'completed' | 'cancelled'
prioritystring nullable
descriptionstring nullable
siteAddressstring nullable
siteCitystring nullable
siteStatestring nullable
siteZipCodestring nullable
architectNamestring nullable

Architect or engineer of record; printed in the pay application's "Via architect / engineer" cell.

architectProjectNumberstring nullable

The architect's own project number, printed on the pay application and its continuation sheet.

contractForstring nullable

Scope line printed in the pay application's "Contract for" cell (e.g. "Structural steel — Phase 2").

assignedTointeger nullable
templateIdinteger

Optional project template ID. The project is created with the template's phases, tasks and checklist subtasks already in place. Create only — PATCH ignores it.

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.