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

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 .

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 “” 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 . You must provide the access token in the Authorization header:

All endpoints require authentication. Ensure you include the appropriate authentication headers with each request.

Please contact [email protected] to get a token for SCIM. Token cannot be obtained through the Screendesk dashboard.

Some methods return paginated results. The formatting of a paginated result is always:

The pagination object contains metadata about the current page and links to other pages. The records array contains the actual data for the current page.

Pagination Fields

This document outlines the SCIM (System for Cross-domain Identity Management) API endpoints for user management. The API uses SCIM 2.0 schemas and conventions.

Base URL

https://app.screendesk.io/api/v2/scim/

List Users

Retrieves a list of all users for the current account.

• URL: /Users

• Method: GET

• Response:

  • Code: 200 OK

  • Content:

Get User

Retrieves a specific user by their SCIM ID or external ID.

• URL: /Users/:id

• Method: GET

• URL Parameters: id=[string]

Create User

Creates a new user in the system.

• URL: /Users

• Method: POST

• Data Params:

Update User

Updates an existing user's information.

• URL: /Users/:id (SCIM ID or external ID)

• Method: PUT

• URL Parameters: id=[string]

5. Delete User

Deletes a user from the system.

• URL: /Users/:id

• Method: DELETE

• URL Parameters: id=[string]

Error Responses

In case of errors, the API will respond with an appropriate HTTP status code and a JSON object containing error details:

Common error scenarios:

• User not found: 404 Not Found

• Invalid input: 422 Unprocessable Entity

• Attempting to delete account owner: 403 Forbidden

Notes

• The API uses SCIM 2.0 schemas and conventions.

• User passwords are automatically generated and not returned in responses.

• The active field in user objects indicates whether the user account is currently active.

Overriding Roles

When creating or updating a user, you can override the default roles by including a roles object in your request. The roles object should contain boolean values for each role you want to set:

• If you don't include the roles object, the default roles will be applied (admin: false, member: true, editor: false).

• If you include the roles object but omit a role, it will be set to false by default.

Example:

This request would create a user with both admin and member roles, but without the editor role.

• When creating or updating users, email validation is skipped to accommodate various SCIM client behaviors.

• The account owner cannot be deleted through this API.

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.

Objects