projects

Get Project

Retrieve a specific project by ID.

Note: If the project has no title (empty or whitespace-only), the response returns the parent account's title instead. The stored value is not modified — this is a read-time fallback only.

get/projects/{project_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/projects/{project_id}
  • Auth: API key in header x-api-key

Path parameters

project_idinteger required

Project identifier

Query parameters

include_virtual_propertiesboolean

Whether to include virtual properties in the response. Defaults to false unless explicitly set to true.

include_archivedboolean

Whether to include archived (inactive) records in the response. By default only active records are returned.

include_contactsboolean

Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.

Response

Project details

tradesTradeType[]

Array of trade types

valuenumber double nullable

Project value

sizenumber double nullable

Project size

workflowIdinteger nullable

Associated workflow ID

accountIdinteger nullable

Associated account ID

status'ACTIVE' | 'ON_HOLD' | 'CANCELLED' | 'COMPLETED'

Status of the project:

  • ACTIVE - Project is active and in progress
  • ON_HOLD - Project is temporarily paused
  • CANCELLED - Project has been cancelled
  • COMPLETED - Project has been completed
lineItemsUpdatedAtstring date-time nullable

Only present on GET /projects and /projects/search when include_line_item_updates=true is passed together with updated_after and/or updated_before. The most recent updatedAt among the project's own scope line items (estimate/scope items; line items on quotes/invoices are excluded). null if the project has no scope line items. Useful for telling whether a row matched the date window via its own updatedAt or via a line item edit.

workflowNamestring

Name of the associated workflow.

Changes

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