Welcome to the Screendesk API! You can use this API to access our endpoints, such as the Screendesk API to get your recordings.

To access our API, you need to be on the Screendesk Enterprise plan.

If you have any questions about the Enterprise plan, you can reach out to the Sales team.

The Screendesk API is REST-based and uses standard HTTP verbs and status codes. The API accepts form-encoded request bodies and returns JSON-encoded responses. All requests should be made over SSL.

If you have any question, please contact the Screendesk support.

API Endpoint

The base URL to access the Screendesk API is https://app.screendesk.io.

For example, to access the recordings endpoint, just add the endpoint to the base URL: https://app.screendesk.io/api/v1/recordings.

API Reference

Authentication

Errors

The Screendesk API uses Personal access tokens to authenticate requests.

Create an access token

To create an access token, sign in to your Screendesk account and go to the "Personal Settings" page. In the “API Tokens” tab click the “Create an API Token” button.

Enter a token name and click on the “Create token” button. Once the token gets created, you will be able to copy the token to your clipboard.

You should now see the new token information in the table. You are able to view the raw token anytime you need to, as well as edit the token name and revoke the token.

How to use your access token

Once you have created your access token, you can use it to make requests to the API. Requests are authenticated using HTTP Bearer Authentication. You must provide the access token in the Authorization header:

Authorization: Bearer {ACCESS_TOKEN}

All responses from the API will include a standard HTTP successful or error status code. The successful status codes are as follows:

For errors, we include extra information as to why the request was not successful. The error response body will have the following format:

{
  "error": {
    "message": "Descriptive information about the error",
    "code": "HTTP error code",
   }
}

For example, if you try to retrieve a recording that does not exist, you will get the following error response:

{
  "error": {
     "message": "Recording not found or does not exist",
     "code": 404,
   }
}

The error status codes, along with their error types, are as follows:

Here you can find a list of the different endpoints available to use across the Screendesk API. Click into each card to learn more.

Recordings