Skip to main contentAPI Reference
The Light API is organized around REST and uses standard HTTP response codes, authentication, and verbs.
Most endpoints accept and return JSON-encoded data in camel case format.
Enum Values and Forward Compatibility
Some fields in this API use enumerated (enum) values to represent specific states or types.
While these enums are fully documented, they are not guaranteed to be exhaustive.
New enum values may be introduced over time as the system evolves.
To maintain forward compatibility:
Always handle unexpected or unknown enum values gracefully.
Avoid assuming the list of values is complete or immutable.
When possible, use string-based comparisons or a safe fallback rather than exhaustive matching.
This policy allows us to extend functionality without introducing breaking changes for consumers who implement robust handling.