The Organization API ("Org API") is solarOS's server-to-server API for your own organization's data: leads, customers, properties, opportunities, quotes, contracts, projects, work orders, service appointments, and more. It's the API a script, integration, or AI agent uses to read and write data in your solarOS organization.
Base URL: https://app.solaros.io/api/v1
Every request needs an API key. See Authentication to create one. Every response follows a consistent envelope and error shape. See Errors. If you're migrating data from another CRM, see Migrate from another CRM.
Full endpoint reference
Every operation the Org API exposes (request/response shapes, required scopes, and curl/JavaScript/Python code samples for each one) is generated straight from the committed OpenAPI spec:
Browse the full API reference →
No CORS support
The Org API has no CORS headers and doesn't support OPTIONS preflight
requests. It's designed for server-to-server calls (curl, a backend script,
a serverless function), not for calling directly from JavaScript running in
a customer's browser on a third-party site.
Versioning
The API is versioned by URL path only (/api/v1/...). There's no
header-based version negotiation and no deprecation/Sunset headers today;
a breaking change to an endpoint gets a dated changelog entry instead.