All Sqreen API endpoints require authentication with a Sqreen API key. You can find instructions above for getting your key.

Once you have an account, you can retrieve your API key from the API tab in your account dashboard. You'll want to copy it so you can paste it into the interactive documentation below.

To authenticate API calls in your own code, add a header to your HTTP request called X-API-Key whose value is your API key. For example, if your API key is TODO_API_KEY_HERE, you would add the following header to your request:


With curl, this would look like:


Attempts to call the Sqreen API without a valid API key specified in this way will be denied with a 401 error.