# Coperniq API Documentation

> Official Coperniq API documentation. Build integrations for solar and construction workflows — manage projects, opportunities, work orders, contacts, invoices, and more.

Welcome to the **Coperniq API**, your gateway to integrating project management and field operations into your own applications and workflows.

Use this documentation to explore every endpoint, understand our data model, and ship integrations faster and more reliably.

## What you can build

* **Project & Opportunity Automation**
  Create and update projects and opportunities, sync statuses, and keep your CRM and ERP in sync with Coperniq.

* **Account & Contact Management**
  Keep your customer data consistent across systems, manage contacts, and power your own customer experiences.

* **Work Orders & Field Operations**\
  Schedule crews, track work orders, and connect field activity back to your internal tools or BI stack.

## Key resources

* **Projects (`/projects`)** – Plan, track, and manage jobs from initiation to close.
* **Opportunities (`/opportunities`)** – Capture and manage inbound opportunities or service calls.
* **Accounts & Contacts (`/accounts`, `/contacts`)** – Model organizations, homeowners, and their relationships.
* **Work Orders & Forms (`/work-orders`, `/forms`)** – Coordinate field work and collect structured data.
* **Files & Calls (`/files`, `/calls`) –** Attach documents, photos, and call logs to your records.

Use the **API Reference** in the sidebar to discover all available endpoints, their parameters, and example requests.

> **💡 Naming changes**
>
> We've made key changes to object and endpoint names (e.g. **Requests → Opportunities**, **Clients → Accounts**, **Comments → Notes**).
>
> **Existing endpoints remain supported** and will continue to work until all users have been notified. We recommend updating to the new names when convenient.

> Official Coperniq API documentation. Build integrations for solar and construction project management — projects, opportunities, work orders, invoices, webhooks, and more.

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server

## Docs

- [Coperniq API Documentation](https://docs.coperniq.io/coperniq-api/introduction.md): Official Coperniq API documentation. Build integrations for solar and construction workflows — manage projects, opportunities, work orders, contacts, invoices, and more.
- [Authentication | Coperniq API](https://docs.coperniq.io/coperniq-api/authentication.md): Learn how to authenticate with the Coperniq API using API keys. Generate keys, set request headers, and manage rate limits for your integration.
- [Quick Start | Coperniq API](https://docs.coperniq.io/coperniq-api/quick-start.md): Get started with the Coperniq API in minutes. Create an API key and make your first request to projects, accounts, or opportunities.
- [Webhooks | Coperniq API](https://docs.coperniq.io/coperniq-api/webhooks.md): Receive real-time event notifications from Coperniq via webhooks. Set up outbound webhooks for projects, work orders, appointments, and more.
- [Release Notes](https://docs.coperniq.io/release-notes.md)

## API Docs

- API Key > Authentication [Get API Key](https://docs.coperniq.io/api-key/authentication/get-api-key.md)
- API Reference > Projects [List Projects](https://docs.coperniq.io/api-reference/projects/list-projects.md)
- API Reference > Projects [Search Projects](https://docs.coperniq.io/api-reference/projects/search-projects.md)
- API Reference > Projects [Get Project](https://docs.coperniq.io/api-reference/projects/get-project.md)
- API Reference > Projects [Create Project](https://docs.coperniq.io/api-reference/projects/create-project.md)
- API Reference > Projects [Update Project](https://docs.coperniq.io/api-reference/projects/update-project.md)
- API Reference > Projects [Delete Project](https://docs.coperniq.io/api-reference/projects/delete-project.md)
- API Reference > Opportunities [List Opportunities](https://docs.coperniq.io/api-reference/opportunities/list-opportunities.md)
- API Reference > Opportunities [Search Opportunities](https://docs.coperniq.io/api-reference/opportunities/search-opportunities.md)
- API Reference > Opportunities [Get Opportunity](https://docs.coperniq.io/api-reference/opportunities/get-opportunity.md)
- API Reference > Opportunities [Create Opportunity](https://docs.coperniq.io/api-reference/opportunities/create-opportunity.md)
- API Reference > Opportunities [Update Opportunity](https://docs.coperniq.io/api-reference/opportunities/update-opportunity.md)
- API Reference > Opportunities [Delete Opportunity](https://docs.coperniq.io/api-reference/opportunities/delete-opportunity.md)
- API Reference > Accounts [List Accounts](https://docs.coperniq.io/api-reference/accounts/list-accounts.md)
- API Reference > Accounts [Search Accounts](https://docs.coperniq.io/api-reference/accounts/search-accounts.md)
- API Reference > Accounts [Get Account](https://docs.coperniq.io/api-reference/accounts/get-account.md)
- API Reference > Accounts [Create Account](https://docs.coperniq.io/api-reference/accounts/create-account.md)
- API Reference > Accounts [Update Account](https://docs.coperniq.io/api-reference/accounts/update-account.md)
- API Reference > Accounts [Delete Account](https://docs.coperniq.io/api-reference/accounts/delete-account.md)
- API Reference > Sites [List Sites](https://docs.coperniq.io/api-reference/sites/list-sites.md)
- API Reference > Sites [Get Site](https://docs.coperniq.io/api-reference/sites/get-site.md)
- API Reference > Sites [Create Site](https://docs.coperniq.io/api-reference/sites/create-site.md)
- API Reference > Sites [Move Site to Another Account](https://docs.coperniq.io/api-reference/sites/move-site.md)
- API Reference > Sites [Update Site](https://docs.coperniq.io/api-reference/sites/update-site.md)
- API Reference > Sites [Delete Site](https://docs.coperniq.io/api-reference/sites/delete-site.md)
- API Reference > Assets [List Assets](https://docs.coperniq.io/api-reference/assets/list-assets.md)
- API Reference > Assets [Get Asset](https://docs.coperniq.io/api-reference/assets/get-asset.md)
- API Reference > Assets [Create Asset](https://docs.coperniq.io/api-reference/assets/create-asset.md)
- API Reference > Assets [Update Asset](https://docs.coperniq.io/api-reference/assets/update-asset.md)
- API Reference > Vendors [List Vendors](https://docs.coperniq.io/api-reference/vendors/list-vendors.md)
- API Reference > Vendors [Search Vendors](https://docs.coperniq.io/api-reference/vendors/search-vendors.md)
- API Reference > Vendors [Get Vendor](https://docs.coperniq.io/api-reference/vendors/get-vendor.md)
- API Reference > Vendors [Create Vendor](https://docs.coperniq.io/api-reference/vendors/create-vendor.md)
- API Reference > Vendors [Create Vendor-Project Link](https://docs.coperniq.io/api-reference/vendors/create-vendor-project-link.md)
- API Reference > Vendors [Update Vendor](https://docs.coperniq.io/api-reference/vendors/update-vendor.md)
- API Reference > Vendors [Delete Vendor](https://docs.coperniq.io/api-reference/vendors/delete-vendor.md)
- API Reference > Vendors [Delete Vendor-Project Link](https://docs.coperniq.io/api-reference/vendors/delete-vendor-project-link.md)
- API Reference > AHJs [List AHJs](https://docs.coperniq.io/api-reference/ahjs/list-ahjs.md)
- API Reference > AHJs [Get AHJ](https://docs.coperniq.io/api-reference/ahjs/get-ahj.md)
- API Reference > AHJs [Update AHJ](https://docs.coperniq.io/api-reference/ahjs/update-ahj.md)
- API Reference > Contacts [List Contacts](https://docs.coperniq.io/api-reference/contacts/list-contacts.md)
- API Reference > Contacts [Get Contact](https://docs.coperniq.io/api-reference/contacts/get-contact.md)
- API Reference > Contacts [Create Contact](https://docs.coperniq.io/api-reference/contacts/create-contact.md)
- API Reference > Contacts [Update Contact](https://docs.coperniq.io/api-reference/contacts/update-contact.md)
- API Reference > Contacts [Delete Contact](https://docs.coperniq.io/api-reference/contacts/delete-contact.md)
- API Reference > Notes [List Project Notes](https://docs.coperniq.io/api-reference/notes/list-project-notes.md)
- API Reference > Notes [List Opportunity Notes](https://docs.coperniq.io/api-reference/notes/list-opportunity-notes.md)
- API Reference > Notes [List Account Notes](https://docs.coperniq.io/api-reference/notes/list-account-notes.md)
- API Reference > Notes [List Work Order Notes](https://docs.coperniq.io/api-reference/notes/list-work-order-notes.md)
- API Reference > Notes [Create Project Note](https://docs.coperniq.io/api-reference/notes/create-project-note.md)
- API Reference > Notes [Create Opportunity Note](https://docs.coperniq.io/api-reference/notes/create-opportunity-note.md)
- API Reference > Notes [Create Account Note](https://docs.coperniq.io/api-reference/notes/create-account-note.md)
- API Reference > Notes [Create Work Order Note](https://docs.coperniq.io/api-reference/notes/create-work-order-note.md)
- API Reference > Notes [Update Note](https://docs.coperniq.io/api-reference/notes/update-note.md)
- API Reference > Notes [Delete Note](https://docs.coperniq.io/api-reference/notes/delete-note.md)
- API Reference > Work Orders [List Work Orders](https://docs.coperniq.io/api-reference/work-orders/list-work-orders.md)
- API Reference > Work Orders [List Project Work Orders](https://docs.coperniq.io/api-reference/work-orders/list-project-work-orders.md)
- API Reference > Work Orders [List Opportunity Work Orders](https://docs.coperniq.io/api-reference/work-orders/list-opportunity-work-orders.md)
- API Reference > Work Orders [List Account Work Orders](https://docs.coperniq.io/api-reference/work-orders/list-account-work-orders.md)
- API Reference > Work Orders [Get Work Order](https://docs.coperniq.io/api-reference/work-orders/get-work-order.md)
- API Reference > Work Orders [List Work Order Templates](https://docs.coperniq.io/api-reference/work-orders/list-work-order-templates.md)
- API Reference > Work Orders [Create Project Work Order](https://docs.coperniq.io/api-reference/work-orders/create-project-work-order.md)
- API Reference > Work Orders [Create Opportunity Work Order](https://docs.coperniq.io/api-reference/work-orders/create-opportunity-work-order.md)
- API Reference > Work Orders [Create Account Work Order](https://docs.coperniq.io/api-reference/work-orders/create-account-work-order.md)
- API Reference > Work Orders [Update Project Work Order](https://docs.coperniq.io/api-reference/work-orders/update-project-work-order.md)
- API Reference > Work Orders [Update Opportunity Work Order](https://docs.coperniq.io/api-reference/work-orders/update-opportunity-work-order.md)
- API Reference > Work Orders [Update Account Work Order](https://docs.coperniq.io/api-reference/work-orders/update-account-work-order.md)
- API Reference > Work Orders [Delete Project Work Order](https://docs.coperniq.io/api-reference/work-orders/delete-project-work-order.md)
- API Reference > Work Orders [Delete Opportunity Work Order](https://docs.coperniq.io/api-reference/work-orders/delete-opportunity-work-order.md)
- API Reference > Work Orders [Delete Account Work Order](https://docs.coperniq.io/api-reference/work-orders/delete-account-work-order.md)
- API Reference > Files [Get Project Files](https://docs.coperniq.io/api-reference/files/get-project-files.md)
- API Reference > Files [Get Opportunity Files](https://docs.coperniq.io/api-reference/files/get-request-files.md)
- API Reference > Files [Get Project File](https://docs.coperniq.io/api-reference/files/get-project-file.md)
- API Reference > Files [Get Opportunity File](https://docs.coperniq.io/api-reference/files/get-request-file.md)
- API Reference > Files [Create Project File (from URL)](https://docs.coperniq.io/api-reference/files/upload-project-file-from-url.md)
- API Reference > Files [Create Project File (stream)](https://docs.coperniq.io/api-reference/files/upload-project-file.md)
- API Reference > Files [Create Opportunity File (from URL)](https://docs.coperniq.io/api-reference/files/upload-request-file-from-url.md)
- API Reference > Files [Create Opportunity File (stream)](https://docs.coperniq.io/api-reference/files/upload-request-file.md)
- API Reference > Files [Delete Project File](https://docs.coperniq.io/api-reference/files/delete-project-file.md)
- API Reference > Files [Delete Opportunity File](https://docs.coperniq.io/api-reference/files/delete-request-file.md)
- API Reference > Line Items [List Project Line Items](https://docs.coperniq.io/api-reference/line-items/list-project-line-items.md)
- API Reference > Line Items [Replace Project Line Items](https://docs.coperniq.io/api-reference/line-items/replace-project-line-items.md)
- API Reference > Line Items [Replace Work Order Line Items](https://docs.coperniq.io/api-reference/line-items/replace-work-order-line-items.md)
- API Reference > Forms [List Form Templates](https://docs.coperniq.io/api-reference/forms/list-form-templates.md)
- API Reference > Forms [Get Form Template](https://docs.coperniq.io/api-reference/forms/get-form-template-by-id.md)
- API Reference > Forms [List Project Forms](https://docs.coperniq.io/api-reference/forms/list-project-forms.md)
- API Reference > Forms [List Opportunity Forms](https://docs.coperniq.io/api-reference/forms/list-opportunity-forms.md)
- API Reference > Forms [Get Form](https://docs.coperniq.io/api-reference/forms/get-form.md)
- API Reference > Forms [Create Project Form](https://docs.coperniq.io/api-reference/forms/create-project-form.md)
- API Reference > Forms [Attach file to form field from URL](https://docs.coperniq.io/api-reference/forms/attach-file-to-form-field-from-url.md)
- API Reference > Forms [Update Form](https://docs.coperniq.io/api-reference/forms/update-form.md)
- API Reference > Forms [Update Form Template](https://docs.coperniq.io/api-reference/forms/update-form-template.md)
- API Reference > Quotes [List Quotes](https://docs.coperniq.io/api-reference/quotes/list-quotes.md)
- API Reference > Quotes [Get Opportunity Quotes](https://docs.coperniq.io/api-reference/quotes/get-opportunity-quotes.md)
- API Reference > Quotes [Get Quote](https://docs.coperniq.io/api-reference/quotes/get-quote.md)
- API Reference > Quotes [Get Quote PDF](https://docs.coperniq.io/api-reference/quotes/get-quote-pdf.md)
- API Reference > Quotes [Create Quote](https://docs.coperniq.io/api-reference/quotes/create-quote.md)
- API Reference > Quotes [Send Quote](https://docs.coperniq.io/api-reference/quotes/send-quote.md)
- API Reference > Quotes [Update Quote](https://docs.coperniq.io/api-reference/quotes/update-quote.md)
- API Reference > Quotes [Delete Quote](https://docs.coperniq.io/api-reference/quotes/delete-quote.md)
- API Reference > Invoices [List Invoices](https://docs.coperniq.io/api-reference/invoices/list-invoices.md)
- API Reference > Invoices [Get Invoice](https://docs.coperniq.io/api-reference/invoices/get-invoice.md)
- API Reference > Invoices [Get Project Invoices](https://docs.coperniq.io/api-reference/invoices/get-project-invoices.md)
- API Reference > Invoices [Get Account Invoices](https://docs.coperniq.io/api-reference/invoices/get-account-invoices.md)
- API Reference > Invoices [Create Invoice](https://docs.coperniq.io/api-reference/invoices/create-invoice.md)
- API Reference > Invoices [Update Invoice](https://docs.coperniq.io/api-reference/invoices/update-invoice.md)
- API Reference > Invoices [Delete Invoice](https://docs.coperniq.io/api-reference/invoices/delete-invoice.md)
- API Reference > Payments [List Invoice Payments](https://docs.coperniq.io/api-reference/payments/list-invoice-payments.md)
- API Reference > Payments [Get Invoice Payment](https://docs.coperniq.io/api-reference/payments/get-invoice-payment.md)
- API Reference > Payments [List Bill Payments](https://docs.coperniq.io/api-reference/payments/list-bill-payments.md)
- API Reference > Payments [Get Bill Payment](https://docs.coperniq.io/api-reference/payments/get-bill-payment.md)
- API Reference > Payments [Create Invoice Payment](https://docs.coperniq.io/api-reference/payments/create-invoice-payment.md)
- API Reference > Payments [Create Bill Payment](https://docs.coperniq.io/api-reference/payments/create-bill-payment.md)
- API Reference > Bills [List Bills](https://docs.coperniq.io/api-reference/bills/list-bills.md)
- API Reference > Bills [Get Bill](https://docs.coperniq.io/api-reference/bills/get-bill.md)
- API Reference > Bills [Get Project Bills](https://docs.coperniq.io/api-reference/bills/get-project-bills.md)
- API Reference > Bills [Create Bill](https://docs.coperniq.io/api-reference/bills/create-bill.md)
- API Reference > Bills [Update Bill](https://docs.coperniq.io/api-reference/bills/update-bill.md)
- API Reference > Bills [Delete Bill](https://docs.coperniq.io/api-reference/bills/delete-bill.md)
- API Reference > Reminders [Get Project Reminders](https://docs.coperniq.io/api-reference/reminders/get-project-reminders.md)
- API Reference > Reminders [Get Opportunity Reminders](https://docs.coperniq.io/api-reference/reminders/get-opportunity-reminders.md)
- API Reference > Reminders [Get Account Reminders](https://docs.coperniq.io/api-reference/reminders/get-account-reminders.md)
- API Reference > Reminders [Get Reminder](https://docs.coperniq.io/api-reference/reminders/get-reminder.md)
- API Reference > Reminders [Create Project Reminder](https://docs.coperniq.io/api-reference/reminders/create-project-reminder.md)
- API Reference > Reminders [Create Opportunity Reminder](https://docs.coperniq.io/api-reference/reminders/create-opportunity-reminder.md)
- API Reference > Reminders [Create Account Reminder](https://docs.coperniq.io/api-reference/reminders/create-account-reminder.md)
- API Reference > Reminders [Update Reminder](https://docs.coperniq.io/api-reference/reminders/update-reminder.md)
- API Reference > Reminders [Delete Reminder](https://docs.coperniq.io/api-reference/reminders/delete-reminder.md)
- API Reference > Appointments [Get Opportunity Appointments](https://docs.coperniq.io/api-reference/appointments/get-opportunity-appointments.md)
- API Reference > Appointments [Get Appointment](https://docs.coperniq.io/api-reference/appointments/get-appointment.md)
- API Reference > Appointments [Create Opportunity Appointment](https://docs.coperniq.io/api-reference/appointments/create-opportunity-appointment.md)
- API Reference > Appointments [Update Appointment](https://docs.coperniq.io/api-reference/appointments/update-appointment.md)
- API Reference > Appointments [Delete Appointment](https://docs.coperniq.io/api-reference/appointments/delete-appointment.md)
- API Reference > Calls [List Project Calls](https://docs.coperniq.io/api-reference/calls/list-project-calls.md)
- API Reference > Calls [List Opportunity Calls](https://docs.coperniq.io/api-reference/calls/list-opportunity-calls.md)
- API Reference > Calls [List Account Calls](https://docs.coperniq.io/api-reference/calls/list-account-calls.md)
- API Reference > Calls [Create Project Call](https://docs.coperniq.io/api-reference/calls/create-project-call.md)
- API Reference > Calls [Create Opportunity Call](https://docs.coperniq.io/api-reference/calls/create-opportunity-call.md)
- API Reference > Calls [Create Account Call](https://docs.coperniq.io/api-reference/calls/create-account-call.md)
- API Reference > Catalog Items [List Catalog Items](https://docs.coperniq.io/api-reference/catalog-items/list-catalog-items.md)
- API Reference > Catalog Items [Get Catalog Item](https://docs.coperniq.io/api-reference/catalog-items/get-catalog-item.md)
- API Reference > Catalog Items [Create Catalog Item](https://docs.coperniq.io/api-reference/catalog-items/create-catalog-item.md)
- API Reference > Catalog Items [Update Catalog Item](https://docs.coperniq.io/api-reference/catalog-items/update-catalog-item.md)
- API Reference > Catalog Items [Delete Catalog Item](https://docs.coperniq.io/api-reference/catalog-items/delete-catalog-item.md)
- API Reference > Labels [List Labels](https://docs.coperniq.io/api-reference/labels/list-labels.md)
- API Reference > Labels [Get Label](https://docs.coperniq.io/api-reference/labels/get-label.md)
- API Reference > Labels [Create Label](https://docs.coperniq.io/api-reference/labels/create-label.md)
- API Reference > Taxes [List Taxes](https://docs.coperniq.io/api-reference/taxes/list-taxes.md)
- API Reference > Users [List Users](https://docs.coperniq.io/api-reference/users/list-users.md)
- API Reference > Users [List Roles](https://docs.coperniq.io/api-reference/users/list-roles.md)
- API Reference > Users [List Teams](https://docs.coperniq.io/api-reference/users/list-teams.md)
- API Reference > Users [Invite User](https://docs.coperniq.io/api-reference/users/invite-user.md)
- API Reference > Properties [List Properties](https://docs.coperniq.io/api-reference/properties/list-properties.md)
- API Reference > Workflows [List Workflows](https://docs.coperniq.io/api-reference/workflows/list-workflows.md)
- API Reference > Workflows [Get Workflow](https://docs.coperniq.io/api-reference/workflows/get-workflow.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.coperniq.io/openapi.json)
- [OpenAPI YAML](https://docs.coperniq.io/openapi.yaml)