API reference
Every Org API operation, generated from the committed OpenAPI spec.
- Inspect the presented organization API key context
- Get tenant-specific effective schema
- List active Lead Sources
- List active Sales Types
- Lookup a solarOS resource by External Reference
- Lookup External References in a batch
- Create an External Reference
- Repair an External Reference target
- Delete an External Reference
- List Campaigns
- Create a Campaign
- Get one Campaign
- Update one Campaign
- Get the Project Template manifest JSON Schema
- List supported Project Template manifest item types
- List Report Types available to Project Template manifests
- List Project Templates available as manifests
- Create a Project Template from a manifest
- Get one Project Template as a manifest
- Enable or disable a saved company Project Template
- Validate a Project Template manifest
- List Leads
- Create a Lead
- Get one Lead
- Update one Lead
- Delete one Lead
- Convert one Lead
- List Customers
- Create or link a Customer
- Get one Customer
- Update one Customer
- Create or update a Customer Relationship
- Get one Customer Relationship
- Update one Customer Relationship
- List Properties
- Create or link a Property
- Get one Property
- Add a Link/URL file to a Property
- List Opportunities
- Create an Opportunity
- Get one Opportunity
- Update one Opportunity
- List assignable Team Members
- Create or resolve a draft Team Member
- Get one Team Member
- List a parent-scoped Activity feed
- Create a parent-scoped Activity
- Get one Activity
- Update an API-authored Activity
- Soft-delete an API-authored Activity
- List active Company Quote Types
- List active Quote Templates
- List enabled Project Templates
- List active Work Types
- List Case Categories
- List Projects
- Create a Project container
- Get one Project
- Update a Project container
- List Cases
- Create a Case
- Get one Case
- Update editable Case metadata
- Save Case Field Values
- List External Record Links on a Case
- Create or update an External Record Link on a Case
- Delete an External Record Link from a Case
- List project-contained Work Orders
- Create a project-contained Work Order
- Get one project-contained Work Order
- Update editable Work Order metadata
- Complete a Work Order
- Cancel a Work Order
- List Service Appointments
- Create a Service Appointment
- Create multi-day Service Appointments
- Get one Service Appointment
- Update schedule, assignment, notes, confidence, or window
- Delete an unstarted or cancelled calendar booking
- Dispatch a Service Appointment
- Mark a Service Appointment en route
- Start a Service Appointment
- Complete a Service Appointment
- Cancel a Service Appointment
- List Service Appointment issues
- Create a Service Appointment issue
- Update an unresolved Service Appointment issue
- Resolve a Service Appointment issue
- List Quotes
- Create a draft Quote
- Get one Quote
- Update editable Quote metadata and custom Fields
- Get purpose-built Quote builder content
- Update editable Quote builder content
- Run Quote builder content calculations
- Request Aurora sync for a Quote
- Send a draft Quote through solarOS
- Record external or staff-mediated Quote acceptance
- Create a quote-generated Contract
- List quote-generated Contracts
- Get one quote-generated Contract
- Send a Contract for signature
- Request a Contract signature reminder
- Void a Contract awaiting signatures
- Sync Contract provider status