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.

Catalog items: new categories & trade groups

What’s new?

  • Catalog items are now backed by typed categories and trade groups:
    • category uses Product/Service categories (e.g., PV_MODULE, BATTERY_SYSTEM, INSTALLATION, MAINTENANCE).
    • tradeGroup is an enum (ENERGY, MECHANICAL, ELECTRICAL, PLUMBING, LOW_VOLTAGE, ENVELOPE, OTHER).
  • The GET /catalog-items endpoint now returns a flat list of catalog items instead of nested catalogs.
  • POST /catalog-items and PATCH /catalog-items/{catalogItemId} validate payloads against the new category + tradeGroup rules.

Impact

  • Generated docs show complete dropdowns for tradeGroup and category, making catalog item creation and updates easier and safer.