API Documentation

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:
1. https://api.sigfox.com/v2/doc.json
2. https://api.sigfox.com/v2 /doc.yaml
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.