Smappee API


These pages will provide you all information about the Smappee REST API.


Before you can use the different API methods, you will have to authenticate yourself to the Smappee cloud. The authentication mechanism is based on oauth2 specification, for more information on the oauth2 spec see:

Following calls are available to manage the authentication:

 Both calls need a "Client_id" and "Client_secret" which are user specific. For personal use, access to the API is free and credentials can be obtained by contacting For commercial usage, it is based on a recurring fee and credentials can be obtained by contacting

API methods


To support future changes and maintain backwards compatibility, we keep different versions of the API online. The different versions can be distinguished by the vX (where X is the version number) in the URL. The differences between the different versions are explained the different pages that are dedicated to one API call.

Common pitfalls