projects

List Projects

Retrieve a paginated list of projects.

Supports:

  • Pagination (page_size, page)
  • Date filtering (updated_after, updated_before, optionally widened to project-level line item edits via include_line_item_updates)
  • Phase entry/exit date filtering (entered_phase_id+entered_after/entered_before, exited_phase_id+exited_after/exited_before)
  • Sorting (order_by)
  • Field search (title, address, primaryName, primaryPhone, primaryEmail)
  • Full text search (q)

Note: updated_after/updated_before also match projects whose custom property values changed within the window.

Note: If a 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. Title-based search (title query param, full-text q, or the /projects/search endpoint with prop=title&op=contains) also matches projects whose own title is null/empty when the parent account's title matches the search term.

Note: entered_phase_id/exited_phase_id identify a phase template (shared across all projects on a workflow), not a specific phase instance. Use the phaseTemplateId from a GET /projects/{project_id} response to find the id for a given phase. When either filter is used, each row also includes a compact phaseTimeline (phaseTemplateId, startedAt, completedAt); use GET /projects/{project_id} for the full phaseInstances with names/positions/SLA.

get/projects

Request

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

Query parameters

page_sizeinteger

Number of items per page (max 100)

pageinteger

Page number (1-based)

string date
OR
string date-time

Filter items updated after this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

string date
OR
string date-time

Filter items updated before this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

include_line_item_updatesboolean

Requires updated_after and/or updated_before to also be passed — has no effect on its own. When true, widens that window to also match projects whose project-level line items (estimate/scope items) were added or edited in the window, and adds a lineItemsUpdatedAt field to each returned project (the most recent updatedAt among its own scope line items, null if none). Line items on quotes/invoices are excluded. Deletions and reorders are not detected. Ordering remains on the project's own updatedAt, so this flag is not a replacement for a full change-feed. Default: false. Only applies to project list/search endpoints.

entered_phase_idinteger

Phase template ID to filter by phase-entry date. Required when entered_after or entered_before is provided. Given alone (no date bounds), matches records that ever entered this phase.

entered_afterstring

Only include records that entered the phase given by entered_phase_id on or after this date/timestamp. Accepts a date (2026-07-01) or a full ISO 8601 timestamp (2026-07-01T00:00:00Z). Requires entered_phase_id.

entered_beforestring

Only include records that entered the phase given by entered_phase_id before this date/timestamp (exclusive). Accepts a date (2026-08-01) or a full ISO 8601 timestamp (2026-08-01T00:00:00Z). Requires entered_phase_id.

exited_phase_idinteger

Phase template ID to filter by phase-exit date. Required when exited_after or exited_before is provided. Given alone (no date bounds), matches records that have exited this phase at any point.

exited_afterstring

Only include records that exited the phase given by exited_phase_id on or after this date/timestamp. Accepts a date (2026-07-01) or a full ISO 8601 timestamp (2026-07-01T00:00:00Z). Requires exited_phase_id.

exited_beforestring

Only include records that exited the phase given by exited_phase_id before this date/timestamp (exclusive). Accepts a date (2026-08-01) or a full ISO 8601 timestamp (2026-08-01T00:00:00Z). Requires exited_phase_id. On opportunities, combine with exited_phase_id set to a "Closed - Won"-style phase template to find deals that closed within a date range.

order_by'asc' | 'desc'

Sort order for results

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.

qstring

Full text search query

titlestring

Title search query

addressstring

Address search query

primaryNamestring

Contact name search query

primaryPhonestring

Contact phone search query

primaryEmailstring

Contact email search query

Response

List of projects

idinteger

Unique identifier

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Timestamp of the most recent update to the record, including changes to its custom property values.

titlestring

Record title/name

descriptionstring nullable

Record description

addressstring[]

Record location/address

isActiveboolean

Whether the record is active

primaryEmailstring email nullable

Primary contact email

primaryPhonestring nullable

Primary contact phone

numberinteger

Record number (e.g., 1234)

customobject

Custom fields

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.