1 of 3

API Reference

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

Recordings

Users

GET List users

Retrieve a paginated list of users for the authenticated user's account

GEThttps://app.screendesk.io/api/v2/users

Authorization

Query parameters

pageinteger

Page number for pagination

Response

Successful response

Body

paginationPaginationV2 (object)

next_pagenullable integer

prev_pagenullable integer

last_pageinteger

pageinteger

itemsinteger

pagesinteger

frominteger

tointeger

countinteger

usersarray of UserV2 (object)

emailstring

namestring

has_avatarboolean

rolestring

notificationsobject

notify_first_viewenum

EnabledDisabled

notify_new_account_recordingenum

EnabledDisabled

notify_new_recordingenum

EnabledDisabled

created_atstring (date-time)

updated_atstring (date-time)

Request

curl -X GET 'https://app.screendesk.io/api/v2/users?page=1' \
-H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
-H 'Content-Type: application/json'

Response

{
  "pagination": {},
  "users": [
    {
      "email": "text",
      "name": "text",
      "has_avatar": false,
      "role": "text",
      "notifications": {
        "notify_first_view": "Enabled",
        "notify_new_account_recording": "Enabled",
        "notify_new_recording": "Enabled"
      },
      "created_at": "2024-11-21T13:36:06.585Z",
      "updated_at": "2024-11-21T13:36:06.585Z"
    }
  ]
}

GET Search for a specific user

Search for a specific user by their email

GEThttps://app.screendesk.io/api/v2/users/search

Authorization

Query parameters

email*string

Email of the user to search for

Response

Successful response

Body

emailstring

namestring

has_avatarboolean

rolestring

notificationsobject

notify_first_viewenum

EnabledDisabled

notify_new_account_recordingenum

EnabledDisabled

notify_new_recordingenum

EnabledDisabled

created_atstring (date-time)

updated_atstring (date-time)

Request

curl -X GET 'https://app.screendesk.io/api/v2/users/search?email=user@example.com' \
-H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
-H 'Content-Type: application/json'

Response

{
  "email": "text",
  "name": "text",
  "has_avatar": false,
  "role": "text",
  "notifications": {
    "notify_first_view": "Enabled",
    "notify_new_account_recording": "Enabled",
    "notify_new_recording": "Enabled"
  },
  "created_at": "2024-11-21T13:36:06.585Z",
  "updated_at": "2024-11-21T13:36:06.585Z"
}

{
  "uuid": "text",
  "title": "text",
  "summary": "text",
  "description": "text",
  "metadata": {
    "created_at": "2024-11-21T13:36:06.585Z",
    "updated_at": "2024-11-21T13:36:06.585Z",
    "recording_type": "text",
    "recording_source": "text",
    "url": "text"
  },
  "technical_details": {
    "vendor": "text",
    "ip_address": "text",
    "timezone": "text",
    "network_type": "text",
    "isp": "text"
  },
  "console_logs": "text",
  "customer": {
    "email": "text"
  },
  "user": {
    "email": "text",
    "name": "text"
  }
}

{
  "pagination": {},
  "records": [
    {
      "uuid": "text",
      "title": "text",
      "summary": "text",
      "description": "text",
      "metadata": {
        "created_at": "2024-11-21T13:36:06.585Z",
        "updated_at": "2024-11-21T13:36:06.585Z",
        "recording_type": "text",
        "recording_source": "text",
        "url": "text"
      },
      "technical_details": {
        "vendor": "text",
        "ip_address": "text",
        "timezone": "text",
        "network_type": "text",
        "isp": "text"
      },
      "console_logs": "text",
      "customer": {
        "email": "text"
      },
      "user": {
        "email": "text",
        "name": "text"
      }
    }
  ]
}

API Reference

Objects

Recordings

Users

Users

GET List users

GET Search for a specific user

Recordings

GET List recordings

GET Get a specific recording

GET Search for a specific user

GET List users

GET Get a specific recording

GET List recordings

API Reference

Objects