Release Notes

Welcome to the Coperniq API release notes. This section highlights noteworthy changes across endpoints, schemas, and docs.

Recent highlights

  • New: Object naming aligned with Coperniq UI — clients are now accounts, requests are now opportunities, and comments are now notes.
  • New: Retrieve archived records by passing include_archived=true on any GET list or get-by-ID endpoint for projects, opportunities, accounts, and workflows.
  • New: Form template endpoints — GET /form-templates and GET /form-templates/{formTemplateId} — let you retrieve workflow templates and their structure.
  • New: PATCH /form-templates/{formTemplateId} — update a form template’s name, layout, assignee, collaborators, labels, and due date configuration.
  • New: Streamed file uploads for projects and opportunities with binary-safe handling

Documentation updates

  • Clarified file upload usage, binary limits, and recommended large-file approach
  • Documented full TradeGroup, ProductCategory, and ServiceCategory enums for catalog items and wired them into the public schemas.

Looking for a specific date? See the entries below.

September 23, 2025

Today’s release focuses on improving Work Orders creation, tightening schemas, and cleaning up the docs.

What’s new?

  • Create Work Order: You can now create a work order under a specific phase instance using templateId and phaseInstanceId. The response includes id, createdAt, updatedAt, description, position, phaseInstanceId, projectId, and createdById.
  • Full CRUD on Catalog Items: You can now, get, create, update, and delete catalog items in your company settings.
  • Form Retrieval: You can now get forms on a project and get form details.
  • Project Phase Instances: Getting a project by ID now includes the phase instances for that project.

Changes

  • Work Orders
    • POST /projects/{projectId}/work-orders requires templateId and phaseInstanceId.
  • Catalogs & Catalog Items
    • GET /catalog-items returns catalogs with their catalog items.
    • GET /catalog-items/{catalogItemId} returns a catalog item.
    • POST /catalog-items creates a catalog item.
    • PATCH /catalog-items/{catalogItemId} updates a catalog item.
  • Forms
    • GET /projects/{projectId}/forms returns a list of the forms on a project.
    • GET /forms/{formId} returns the form details, including field values.
  • Projects
    • GET /projects/{projectId} includes an array of phaseInstances.

Notes

  • The provided phaseInstanceId must belong to the project where the work order is created.