Release Notes

New: pin and unpin notes

In Coperniq, a pinned note stays at the top of a record’s notes. You can now pin and unpin notes through the API too.

Pin or unpin an existing note with isPinned on PATCH /notes/{note_id}:

{ "isPinned": true }

Updated: POST /users takes a seat and a labor cost

Invite User now matches Invite Members in Coperniq. Along with name, email, role and phone, you can set the member’s seat and labor cost.

{
  "email": "anna.smith@example.com",
  "firstName": "Anna",
  "lastName": "Smith",
  "seatType": "FIELD",
  "roleIds": [3],

Updated: PATCH a work order with labels

You can now set a work order’s labels through the API, the same way you can in Coperniq. This works on the project, opportunity, request, account and client work-order PATCH endpoints, for example PATCH /projects/{project_id}/work-orders/{work_order_id}.

{ "labels": [12, 34] }

New: GET and POST /files/{file_id}/notes

You can now read and add notes (comments) on files, the same way you can on projects and work orders.

• GET /files/{file_id}/notes lists a file’s notes, newest first, with page and page_size (max 100).
• POST /files/{file_id}/notes adds a note. Send body, and optionally replyToId to reply to a note on the same file, or fileIds to attach files.

Docs: creating an API key if you sign in with Google

POST /api-keys needs your Coperniq email and password. If you sign in to Coperniq with Google, your account has no password yet, so the request returns 401.

To set one:

1. On the Coperniq login page, click Forgot password.
2. Enter the email you sign in with and open the reset link we send you.
3. Choose a password.

Updated: GET /users can include deactivated users

Records can still point to people who have since been deactivated, as owner, salesRep, projectManager, createdBy, assignee and so on. Add include_inactive=true to GET /users to return deactivated members alongside active ones, so you can resolve those ids to a name and email.

New: GET /forms

Lists your company’s forms across every project and opportunity, including forms on account work orders, paginated. Use it to sync forms incrementally instead of listing them one record at a time.

Query parameters

New: parentAccountId on accounts

Accounts can now be read and written as sub-accounts of another account.

• Read: returned on GET /accounts, GET /accounts/{account_id}, GET /accounts/search, and the POST/PATCH responses.
• Write: accepted on POST /accounts and PATCH /accounts/{account_id}. Send null on PATCH to unlink an account from its parent.
• Rules: the parent must be an account in your company and must itself be top-level (1 level of nesting). An account that already has sub-accounts cannot become one, and an account cannot be its own parent. Breaking a rule returns 400 with field: "parentAccountId".

Updated: GET /projects, GET /projects/search, GET /opportunities, GET /opportunities/search

List and search responses now include the project manager and owner, sales rep and project manager ids, so a bulk sync no longer needs a follow-up GET per record.

• New fields on every row: ownerId, salesRepId, projectManagerId, and projectManager (null when unset).

Updated: POST /api-keys

Users with a Viewer (view-only) seat in the selected company now get a 403 from POST /api-keys and its legacy alias GET /token, and no key is created. Office and Field seats are unaffected.

• The seat checked is the one in the company the key is for: the company_id you pass, or your default company. A user who is a Viewer in one company and an Office user in another can still create keys for the second company.
• Keys that Viewer users created before this change keep working. A superadmin can find them with GET /api-keys and delete them with DELETE /api-keys/{key_id}.

New: List and delete API keys, and archive API users

Superadmins can now manage their company’s API keys through the API. These endpoints authenticate with Basic Auth (your Coperniq email and password), the same as POST /api-keys, not with an API key. Each one takes an optional company_id for logins that belong to more than one company.

Fixed: status is now returned when reading opportunities

GET /opportunities/{opportunity_id}, GET /opportunities, and GET /opportunities/search now include the opportunity’s status. Create and update already accepted it, but these read endpoints never returned it. The legacy /requests aliases return it too.

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.