RESTful API

Help Lightning does not provide an official SDK for interacting with the Server API. Help Lightning’s server API is a RESTful API that follows standard pratices and can be interacted with from any programming language.

To use the API, you must first have a valid API Key. Most of the API endpoints also require an authorization token.

The server API provides a wide range of endpoints for interacting with Help Lightning. It allows for managing your account, contacts, and recent calls. It also allows for Site Administrators to manage their entire site, including members, groups, roles, permissions, and calls. It is even possible to initiate calls for the users on your site.

The Server API currently provides to versions: v1 and v1r1, where v1r1 augments the v1 api. You can read more about this in the API v1 vs v1r1 documentation.

Update to date documentation on the endpoints, parameters and responses along with examples are available on the API documentation site, that is automatically generated upon each new release of Help Lightning: