1 of 2

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.

Recordings

GET List recordings

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

get

/recordings

Authorizations

Query parameters

pageinteger

Page number for pagination

Responses

*/*

cURL

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

200

401

{
  "pagination": {
    "next_page": 1,
    "prev_page": 1,
    "last_page": 1,
    "page": 1,
    "items": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "count": 1
  }
}

Successful response

GET Get a specific recording

Retrieve details of a specific recording by its UUID

get

/recordings/{uuid}

Authorizations

Path parameters

uuidstringrequired

UUID of the recording

Responses

*/*

cURL

curl -X GET 'https://app.screendesk.io/api/v1/recordings/696cfd3b-b579-45a7-b58a-88ba0984a42b' \
-H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
-H 'Content-Type: application/json'

200

401

404

{
  "id": 1,
  "uuid": "text",
  "title": "text",
  "description": "text",
  "created_at": "2025-02-12T16:40:18.303Z",
  "updated_at": "2025-02-12T16:40:18.303Z",
  "vendor": "text",
  "ip_address": "text",
  "timezone": "text",
  "network_type": "text",
  "isp": "text",
  "platform": "text",
  "impressions_count": 1,
  "customer_email": "text",
  "duration": 1,
  "recording_type": "text",
  "recording_source": "text",
  "url": "text",
  "user_email": "text",
  "user_name": "text"
}

Successful response