Homepage Screendesk Docs Changelog Pricing Contact

Recordings

PreviousAPI Reference NextUsers

Last updated 4 months ago

Was this helpful?

GET List recordings

get

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

Authorizations

Query parameters

pageintegerOptional

Page number for pagination

Responses

200

Successful response

application/json

401

Unauthorized

get

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

{
  "pagination": {
    "next_page": null,
    "prev_page": null,
    "last_page": 1,
    "page": 1,
    "items": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "count": 1
  },
  "records": [
    {
      "uuid": "text",
      "title": "text",
      "summary": "text",
      "description": "text",
      "metadata": {
        "created_at": "2025-05-31T21:23:39.821Z",
        "updated_at": "2025-05-31T21:23:39.821Z",
        "duration": 1,
        "impressions_count": 1,
        "recording_type": "text",
        "recording_source": "text",
        "url": "text",
        "helpdesk_info": {}
      },
      "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"
      }
    }
  ]
}

GET Get a specific recording

get

Retrieve details of a specific recording by its UUID

Authorizations

Path parameters

uuidstringRequired

UUID of the recording

Responses

200

Successful response

application/json

401

Unauthorized

404

Recording not found

application/json

get

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

{
  "uuid": "text",
  "title": "text",
  "summary": "text",
  "description": "text",
  "metadata": {
    "created_at": "2025-05-31T21:23:39.821Z",
    "updated_at": "2025-05-31T21:23:39.821Z",
    "duration": 1,
    "impressions_count": 1,
    "recording_type": "text",
    "recording_source": "text",
    "url": "text",
    "helpdesk_info": {}
  },
  "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"
  }
}

curl -X PATCH 'https://app.screendesk.io/api/v2/recordings/696cfd3b-b579-45a7-b58a-88ba0984a42b' \
-H 'Authorization: Bearer YOUR_BEARER_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
  "recording": {
    "title": "Updated Title",
    "summary": "New summary",
    "description": "Updated description"
  }
}'

{
  "uuid": "text",
  "title": "text",
  "summary": "text",
  "description": "text",
  "metadata": {
    "created_at": "2025-05-31T21:23:39.821Z",
    "updated_at": "2025-05-31T21:23:39.821Z",
    "duration": 1,
    "impressions_count": 1,
    "recording_type": "text",
    "recording_source": "text",
    "url": "text",
    "helpdesk_info": {}
  },
  "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"
  }
}

GET List recordings

GET Get a specific recording

PATCH Update a recording