Release Notes

New: Units, measurements, and quantity-calculation fields on catalog items

Catalog items now expose the same unit and measurement-driven quantity calculation available in the Coperniq UI.

GET/POST/PATCH /catalog-items responses and request bodies gain:

POST /api-keys (and its legacy alias GET /token) now accepts an optional company_id query parameter, for accounts where the same login belongs to more than one company. Your company ID can be found in the URL after logging in to the Coperniq UI: https://app.coperniq.io/{company_id}/inbox.

POST /api-keys?company_id=123

Notes

• A recognised public field name that doesn’t apply to the record type you’re searching (for example value on an account, or trades on a vendor) now returns 400 naming the field, instead of an empty 200. If you were relying on an empty result for one of these, you’ll now get an explicit error — which is the point: an empty list was indistinguishable from “no matches”.
• A field name the API does not recognise as a standard field is still treated as a possible custom property, unchanged. An empty result there still means “no records matched” — we can’t tell a typo from a real custom property name without knowing your company’s columns, so only fields we can prove don’t apply are rejected.
• trades holds a list of values, so a scalar comparison matches if any entry equals your value. Range and substring operators are rejected with a 400 rather than silently matching nothing.

Added CRUD for project folders.

• GET /projects/{project_id}/folders — list root-level folders (not nested in another folder), plus workflow phase rows. Pass include_archived=true to include archived folders (default false).
• GET /opportunities/{opportunity_id}/folders — same functionality as list project folders.
• POST /projects/{project_id}/folders - create folder.
• POST /opportunities/{opportunity_id}/folders - create folder.
• GET /folders/{folder_id} — get by id.
• PATCH /folders/{folder_id} — rename, archive/unarchive (isActive), or move (set parentId/phaseInstanceId) — moving isn’t a separate operation.
• DELETE /folders/{folder_id} — delete (also removes any subfolders and their files).
• GET /folders/{folder_id}/contents — list a folder’s direct children (subfolders, files, forms).
• GET /phases/{phase_instance_id}/contents — list a phase’s direct children, same shape as folder contents.

You can now use the API to create the form PDF similar to what an automation email would send.

• POST /forms/{form_id}/pdf to export a form to PDF.
• Optional body fields: imagesOnly, imagesInRow (0-6), includeImageMetadata.
• Returns { pdfBase64, contentType, name }.

Added a Technical Details page (between Quick Start and Webhooks in the sidebar). Rate limits moved there from the Authentication page — same content, new home. Also added a new Archiving records section: most records can be archived instead of permanently deleted — use that object’s PATCH endpoint and set isActive to false (some resources still use isArchived; check the endpoint reference).

Added POST /work-orders/{work_order_id}/forms to create a form instance directly on a work order, closing the gap where forms could only be created on projects and opportunities.

templateId is required. The form is created with its template’s name — a work order already sits in a phase, so phaseInstanceId is not accepted on this endpoint; the form inherits its placement from the work order’s parent element instance. The response includes workOrderId alongside projectId for correlation, and (when present) phaseInstanceId/phaseTemplateId.

Added POST /opportunities/{opportunity_id}/forms to create a form instance directly on an opportunity, mirroring the existing POST /projects/{project_id}/forms. templateId is required, name is optional (defaults to the template’s name), and opportunities cannot be assigned to a phase, so phaseInstanceId is not accepted or returned on this endpoint.

The response from both create-form endpoints now also returns templateId, name, createdAt, and updatedAt directly on the top-level object.

Work order update endpoints now accept isActive in the request body. Set isActive: false to archive a work order, or isActive: true to unarchive it — handled independently of any other fields in the same request.

Work order response payloads now also return isActive. The existing isArchived field is deprecated but still returned for backward compatibility — no breaking change.

updated_after/updated_before on GET /projects (v1 and v2), GET /projects/search, and the other v1 list endpoints (requests/deals, clients/accounts, vendors) now also match records whose custom property values changed within the window. This is always on; there is no new query param.

The updatedAt field on a returned record now reflects the most recent change to that record, including changes to its custom property values.

New: Account file endpoints

Manage files on an account, mirroring the existing project/opportunity file endpoints.

Improved: Phase instance timestamps on GET /opportunities/{opportunity_id}

Each entry in phaseInstances now includes startedAt and completedAt, matching the projects endpoint. Use these to compute time-in-stage or close dates without a separate lookup.

• Only populated on GET /opportunities/{opportunity_id}; the list and search endpoints do not return phaseInstances and are unaffected.
• completedAt is null for the phase the opportunity currently occupies and any that have not been started.

New: Utility endpoints

Read and update the global utility list, mirroring the existing AHJ endpoints — utilities are seeded globally with no per-company scoping except for the custom properties.

New: isPrimary and full contact detail

contacts[] on accounts, projects, and opportunities now returns id, name, title, description, emails, phones, and isPrimary for every contact (previously just id/emails/phones on accounts, and nothing at all on projects/opportunities).

• isPrimary is true for exactly one contact — the one at the lowest position (the first element you send on create/update). At most one contact is ever primary.
• Projects and opportunities now return contacts too — their own contacts, independent of and not inherited from the parent account’s. Set them on create/update via the contacts request field, same as accounts. Pass include_contacts=true on GET /projects, GET /projects/search, GET /projects/{project_id}, and the equivalent /opportunities endpoints to include it — same as accounts.
• POST/PATCH responses always include contacts for accounts, projects, and opportunities — not gated behind include_contacts like GET is.

New: Timesheet (time entry) endpoints

Create, read, update, and delete timesheets — time entries logged by a worker against a project, account, or opportunity (and optionally a work order).

New: Bill payment endpoints

Record and retrieve payments against a bill, mirroring the existing invoice payment endpoints.

New: AHJ (Authorities Having Jurisdiction) endpoints

Look up jurisdictions and manage their custom property values through the public API.

Line items can now be grouped into named sections — the same grouping you see on quotes and in the Coperniq UI — across project line items, invoices, and bills.

Envelope product categories

17 new ProductCategory values are now available when creating or updating a catalog item with type=PRODUCT:

ROOF_COVERING, ROOF_UNDERLAYMENT, ROOF_MEMBRANE, ROOF_FLASHING, ROOF_VENT, WALL_CLADDING, WALL_TRIM, WEATHER_BARRIER, WINDOW, EXTERIOR_DOOR, SKYLIGHT, OPENING_FLASHING, GUTTER, DOWNSPOUT, INSULATION, SEALANT, SHEATHING.

Manage labels that can be applied to work orders and assets.