Recordings

List recordings

get

Returns a paginated list of recordings. Members see only their own recordings; admins see all recordings in the account.

Authorizations

BearerAuth

AuthorizationstringRequired

API token obtained from Screendesk account settings

Query parameters

pageinteger · min: 1Optional

Page number (defaults to 1)

Default: 1

Responses

200

A paginated list of recordings

application/json

401

Invalid or missing API token

application/json

403

API access not enabled or insufficient permissions

application/json

get/recordings

HTTPcURLJavaScriptPython

GET /api/v2/recordings HTTP/1.1
Host: app.screendesk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pagination": {
    "count": 1,
    "page": 1,
    "items": 1,
    "pages": 1,
    "next_page": 1,
    "prev_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  },
  "records": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "title": "text",
      "summary": "text",
      "description": "text",
      "metadata": {
        "created_at": "2026-07-16T04:55:08.655Z",
        "updated_at": "2026-07-16T04:55:08.655Z",
        "duration": 1,
        "impressions_count": 1,
        "recording_type": "Received",
        "recording_source": "text",
        "url": "https://example.com",
        "helpdesk_info": {
          "platform": "zendesk",
          "conversation_id": "text",
          "ticket_id": "text",
          "user_id": "text",
          "operator_id": "text",
          "customer_id": "text",
          "issue_id": "text"
        }
      },
      "technical_details": {
        "vendor": "text",
        "ip_address": "text",
        "timezone": "text",
        "network_type": "text",
        "isp": "text"
      },
      "console_logs": "text",
      "customer": {
        "email": "[e-mail]"
      },
      "user": {
        "email": "[e-mail]",
        "name": "text"
      },
      "room_insights": {
        "started_at": "2026-07-16T04:55:08.655Z",
        "ended_at": "2026-07-16T04:55:08.655Z",
        "duration": 1,
        "total_participant_minutes": 1,
        "total_unique_participants": 1,
        "participants_insights": [
          {
            "participant_id": "text",
            "display_name": "text",
            "role": "text",
            "browser": "text",
            "os": "text",
            "device": "text",
            "device_type": "text",
            "user_agent": "text",
            "joined_at": "2026-07-16T04:55:08.655Z",
            "left_at": "2026-07-16T04:55:08.655Z"
          }
        ]
      }
    }
  ]
}

Get a recording

get

Returns a single recording by UUID.

Authorizations

BearerAuth

AuthorizationstringRequired

API token obtained from Screendesk account settings

Path parameters

uuidstring · uuidRequired

The recording's UUID

Responses

200

Recording details

application/json

uuidstring · uuidOptional

titlestring · nullableOptional

summarystring · nullableOptional

descriptionstring · nullableOptional

console_logsstring · nullableOptional

Raw console log output captured during the recording

401

Invalid or missing API token

application/json

403

API access not enabled or insufficient permissions

application/json

404

Resource not found

application/json

get/recordings/{uuid}

HTTPcURLJavaScriptPython

GET /api/v2/recordings/{uuid} HTTP/1.1
Host: app.screendesk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "summary": "text",
  "description": "text",
  "metadata": {
    "created_at": "2026-07-16T04:55:08.655Z",
    "updated_at": "2026-07-16T04:55:08.655Z",
    "duration": 1,
    "impressions_count": 1,
    "recording_type": "Received",
    "recording_source": "text",
    "url": "https://example.com",
    "helpdesk_info": {
      "platform": "zendesk",
      "conversation_id": "text",
      "ticket_id": "text",
      "user_id": "text",
      "operator_id": "text",
      "customer_id": "text",
      "issue_id": "text"
    }
  },
  "technical_details": {
    "vendor": "text",
    "ip_address": "text",
    "timezone": "text",
    "network_type": "text",
    "isp": "text"
  },
  "console_logs": "text",
  "customer": {
    "email": "[e-mail]"
  },
  "user": {
    "email": "[e-mail]",
    "name": "text"
  },
  "room_insights": {
    "started_at": "2026-07-16T04:55:08.655Z",
    "ended_at": "2026-07-16T04:55:08.655Z",
    "duration": 1,
    "total_participant_minutes": 1,
    "total_unique_participants": 1,
    "participants_insights": [
      {
        "participant_id": "text",
        "display_name": "text",
        "role": "text",
        "browser": "text",
        "os": "text",
        "device": "text",
        "device_type": "text",
        "user_agent": "text",
        "joined_at": "2026-07-16T04:55:08.655Z",
        "left_at": "2026-07-16T04:55:08.655Z"
      }
    ]
  }
}

Update a recording

patch

Updates a recording's title, summary, or description. Admin only.

Authorizations

BearerAuth

AuthorizationstringRequired

API token obtained from Screendesk account settings

Path parameters

uuidstring · uuidRequired

The recording's UUID

Body

application/json

Responses

200

Updated recording

application/json

uuidstring · uuidOptional

titlestring · nullableOptional

summarystring · nullableOptional

descriptionstring · nullableOptional

console_logsstring · nullableOptional

Raw console log output captured during the recording

401

Invalid or missing API token

application/json

403

API access not enabled or insufficient permissions

application/json

404

Resource not found

application/json

422

Validation error

application/json

patch/recordings/{uuid}

HTTPcURLJavaScriptPython

PATCH /api/v2/recordings/{uuid} HTTP/1.1
Host: app.screendesk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "recording": {
    "title": "text",
    "summary": "text",
    "description": "text"
  }
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "summary": "text",
  "description": "text",
  "metadata": {
    "created_at": "2026-07-16T04:55:08.655Z",
    "updated_at": "2026-07-16T04:55:08.655Z",
    "duration": 1,
    "impressions_count": 1,
    "recording_type": "Received",
    "recording_source": "text",
    "url": "https://example.com",
    "helpdesk_info": {
      "platform": "zendesk",
      "conversation_id": "text",
      "ticket_id": "text",
      "user_id": "text",
      "operator_id": "text",
      "customer_id": "text",
      "issue_id": "text"
    }
  },
  "technical_details": {
    "vendor": "text",
    "ip_address": "text",
    "timezone": "text",
    "network_type": "text",
    "isp": "text"
  },
  "console_logs": "text",
  "customer": {
    "email": "[e-mail]"
  },
  "user": {
    "email": "[e-mail]",
    "name": "text"
  },
  "room_insights": {
    "started_at": "2026-07-16T04:55:08.655Z",
    "ended_at": "2026-07-16T04:55:08.655Z",
    "duration": 1,
    "total_participant_minutes": 1,
    "total_unique_participants": 1,
    "participants_insights": [
      {
        "participant_id": "text",
        "display_name": "text",
        "role": "text",
        "browser": "text",
        "os": "text",
        "device": "text",
        "device_type": "text",
        "user_agent": "text",
        "joined_at": "2026-07-16T04:55:08.655Z",
        "left_at": "2026-07-16T04:55:08.655Z"
      }
    ]
  }
}

Download a recording video

get

Streams the best available video file for a recording through the Screendesk API. The response body is the video binary, not JSON.

Screendesk returns the edited file when available, then the processed file, and finally the original upload. Use this endpoint for API/backend downloads such as curl, scripts, or server-side integrations.

Authorizations

BearerAuth

AuthorizationstringRequired

API token obtained from Screendesk account settings

Path parameters

uuidstring · uuidRequired

The recording's UUID

Responses

200

The recording video file

video/mp4video/webmvideo/quicktimeapplication/octet-stream

Responsestring · binary

401

Invalid or missing API token

application/json

403

API access not enabled or insufficient permissions

application/json

404

Resource not found

application/json

409

Video file is not available yet

application/json

get/recordings/{uuid}/download

HTTPcURLJavaScriptPython

GET /api/v2/recordings/{uuid}/download HTTP/1.1
Host: app.screendesk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary