Reference

Reference material for solarOS: shared terms, the values a record's status can hold, permissions, webhook events, error codes, and limits.

• Glossary: terms used across solarOS.
• Status values: the values the API returns in status fields.
• Permissions: every permission and which roles include it.
• Webhook events: the events an organization webhook can subscribe to.
• Error codes: every error code the API can return.
• Limits: numeric ceilings such as rate limits and plan capacity.

If you're building an integration, the API contract itself, endpoints, request and response fields, authentication, and webhooks, is documented separately in the API reference.