Welcome to the Coperniq API release notes. This section highlights noteworthy changes across endpoints, schemas, and docs.
Recent highlights
- New: AHJs —
GET /ahjs(search, filter, andlat+lnggeo lookup),GET /ahjs/{id}, andPATCH /ahjs/{id}to update custom property values. v2 mirrors these under/v2with the standard success envelope. - Updated:
GET /properties— now documents theahjrecord type (custom AHJ properties only) and adds anisCustomboolean to every property to distinguish custom columns from built-in standard ones. - New: Sections — line items on projects, invoices, and bills can now be grouped into named
sections(matching quotes and work orders); read responses exposesectionNameper line item. - New: Vendors — full CRUD via
GET/POST /vendors,GET/PATCH/DELETE /vendors/{vendorId},GET /vendors/search, and many-to-many project linking viaPOST/DELETE /projects/{projectId}/vendors/{vendorId}. Vendor-specific fields:vendorType(enum),website, andprojectIds. - New: Labels —
GET /labels(filter bytype),POST /labels,GET /labels/{labelId}.typeisWORK(work orders) orASSET. v2 mirrors these under/v2with the standard success envelope. - New: Assets —
GET /assets(filter byaccount_id),POST /assets,GET/PATCH /assets/{assetId}(setisArchived: truevia PATCH to archive). v2 mirrors these under/v2with the standard success envelope.
Looking for a specific date? See the entries below.
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
templateIdandphaseInstanceId. The response includesid,createdAt,updatedAt,description,position,phaseInstanceId,projectId, andcreatedById. - 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-ordersrequirestemplateIdandphaseInstanceId.
- POST
- Catalogs & Catalog Items
- GET
/catalog-itemsreturns catalogs with their catalog items. - GET
/catalog-items/{catalogItemId}returns a catalog item. - POST
/catalog-itemscreates a catalog item. - PATCH
/catalog-items/{catalogItemId}updates a catalog item.
- GET
- Forms
- GET
/projects/{projectId}/formsreturns a list of the forms on a project. - GET
/forms/{formId}returns the form details, including field values.
- GET
- Projects
- GET
/projects/{projectId}includes an array ofphaseInstances.
- GET
Notes
- The provided
phaseInstanceIdmust belong to the project where the work order is created.
