The Sigfox API documentation is available publicly or can be obtained through a dedicated endpoint.
Public version
The public API documentation is based on standard permissions (i.e. Device Manager W). To browse this documentation please go to https://support.sigfox.com/apidocs.
Permissions-tailored version
The full API documentation tailored according to the API user permissions can be retrieved as follows.
- Create an API User in the Sigfox backend, from the API Access page. The steps are described here: API credential creation.
- By using the following endpoints you can get the documentation in either JSON or YAML format:
- If you want to display human-readable API documentation, we advise using either ReDoc for the latest features or swagger editor for a quick online overview.
API V2 usage documentation:
API legacy version (V1)
The legacy API version has been deprecated with R9.3, April 27, 2020.
The v1/v2 API traceability matrix is available here:
