Overview
Welcome to the Screendesk API! You can use this API to access our endpoints, such as the Screendesk API to get your recordings.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Welcome to the Screendesk API! You can use this API to access our endpoints, such as the Screendesk API to get your recordings.
Authorization: Bearer {ACCESS_TOKEN}{
"error": {
"message": "Descriptive information about the error",
"code": "HTTP error code",
}
}{
"error": {
"message": "Recording not found or does not exist",
"code": 404,
}
}{
"pagination": {
"next_page": "...",
"prev_page": "...",
"last_page": "...",
"page": "...",
"items": "...",
"pages": "...",
"from": "...",
"to": "...",
"count": "..."
},
"records": [
...
]
}GET /api/v2/users{
"pagination": {
"next_page": 2,
"last_page": 5,
"page": 1,
"items": 100,
"pages": 5,
"from": 1,
"to": 100,
"count": 450
},
"users": [
...
]
}GET /api/v2/users?page=2roles field in user objects contains an object with role names as keys and boolean values indicating whether the role is assigned to the user within the current account.trueroles{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": <integer>,
"Resources": [
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "<string>",
"userName": "<string>",
"name": {
"formatted": "<string>",
"givenName": "<string>",
"familyName": "<string>"
},
"emails": [
{
"primary": true,
"value": "<string>",
"type": "work"
}
],
"active": <boolean>,
"roles": [<string>]
},
// ... more users
]
}{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"id": "<string>"
"userName": "<string>",
"name": {
"givenName": "<string>",
"familyName": "<string>"
},
"emails": [
{
"value": "<string>",
"primary": true,
"type": "work"
}
],
"externalId": "<string>",
"active": <boolean>,
"roles": {
"admin": <boolean>,
"member": <boolean>,
"editor": <boolean>
}
}{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
"detail": "<string>",
"status": "400"
}"roles": {
"admin": false,
"member": true,
"editor": false
}{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "john.doe@example.com",
"name": {
"givenName": "John",
"familyName": "Doe"
},
"emails": [
{
"value": "john.doe@example.com",
"primary": true,
"type": "work"
}
],
"active": true,
"roles": {
"admin": true,
"member": true,
"editor": false
}
}API token obtained from Screendesk account settings
Page number (defaults to 1)
1Filter by an exact helpdesk ticket, conversation, issue, or object ID.
Results include a normalized metadata.helpdesk_info.ticket_id.
Optionally restrict ticket_id to one helpdesk provider.
freshchat is accepted as an alias for freshdesk_chat.
A paginated list of recordings
Total number of records
Current page number
Number of items per page
Total number of pages
Next page number (absent if on last page)
Previous page number (absent if on first page)
Last page number
Index of the first item on this page
Index of the last item on this page
Recording duration in seconds
Number of times the recording has been viewed
The type of recording
Human-readable source label (e.g. "Zendesk Ticket", "Intercom Operator")
Public URL to view the recording
Current Zendesk follow-up ticket ID when it differs from ticket_id
Raw console log output captured during the recording
Call duration in seconds (inferred from started_at and ended_at)
Invalid ticket search parameters
Error message
Invalid or missing API token
Error message
API access not enabled or insufficient permissions
Error message
API token obtained from Screendesk account settings
The recording's UUID
Recording details
Recording duration in seconds
Number of times the recording has been viewed
The type of recording
Human-readable source label (e.g. "Zendesk Ticket", "Intercom Operator")
Public URL to view the recording
Current Zendesk follow-up ticket ID when it differs from ticket_id
Raw console log output captured during the recording
Call duration in seconds (inferred from started_at and ended_at)
Invalid or missing API token
Error message
API access not enabled or insufficient permissions
Error message
Resource not found
Error message
API token obtained from Screendesk account settings
The recording's UUID
The recording title
A short summary
A detailed description
Updated recording
Recording duration in seconds
Number of times the recording has been viewed
The type of recording
Human-readable source label (e.g. "Zendesk Ticket", "Intercom Operator")
Public URL to view the recording
Current Zendesk follow-up ticket ID when it differs from ticket_id
Raw console log output captured during the recording
Call duration in seconds (inferred from started_at and ended_at)
Invalid or missing API token
Error message
API access not enabled or insufficient permissions
Error message
Resource not found
Error message
Validation error
Error message
API token obtained from Screendesk account settings
The recording's UUID
The recording video file
Attachment filename for the downloaded video
attachment; filename="customer-bug-report-00000000-0000-0000-0000-000000000000.mp4"File size in bytes
Invalid or missing API token
Error message
API access not enabled or insufficient permissions
Error message
Resource not found
Error message
Video file is not available yet
Error message
API token obtained from Screendesk account settings
The recording's UUID
Transcript segment page number (defaults to 1)
1Recording transcript and its current availability status
Detected BCP 47 language code when available
Total number of records
Current page number
Number of items per page
Total number of pages
Next page number (absent if on last page)
Previous page number (absent if on first page)
Last page number
Index of the first item on this page
Index of the last item on this page
Invalid or missing API token
Error message
API access not enabled or insufficient permissions
Error message
Resource not found
Error message
API token obtained from Screendesk account settings
A paginated list of users
Total number of records
Current page number
Number of items per page
Total number of pages
Next page number (absent if on last page)
Previous page number (absent if on first page)
Last page number
Index of the first item on this page
Index of the last item on this page
The user's role in the account
Invalid or missing API token
Error message
API access not enabled or insufficient permissions
Error message
API token obtained from Screendesk account settings
The email address to search for
User details
The user's role in the account
Missing email parameter
Error message
Invalid or missing API token
Error message
API access not enabled or insufficient permissions
Error message
Resource not found
Error message
{
"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-08-05T16:33:09.102Z",
"updated_at": "2026-08-05T16:33:09.102Z",
"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",
"active_ticket_id": "text",
"user_id": "text",
"operator_id": "text",
"customer_id": "text",
"issue_id": "text",
"object_id": "text"
}
},
"technical_details": {
"vendor": "text",
"ip_address": "text",
"timezone": "text",
"network_type": "text",
"isp": "text"
},
"console_logs": "text",
"customer": {
"email": "name@gmail.com"
},
"user": {
"email": "name@gmail.com",
"name": "text"
},
"room_insights": {
"started_at": "2026-08-05T16:33:09.102Z",
"ended_at": "2026-08-05T16:33:09.102Z",
"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-08-05T16:33:09.102Z",
"left_at": "2026-08-05T16:33:09.102Z"
}
]
}
}
]
}{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"title": "text",
"summary": "text",
"description": "text",
"metadata": {
"created_at": "2026-08-05T16:33:09.102Z",
"updated_at": "2026-08-05T16:33:09.102Z",
"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",
"active_ticket_id": "text",
"user_id": "text",
"operator_id": "text",
"customer_id": "text",
"issue_id": "text",
"object_id": "text"
}
},
"technical_details": {
"vendor": "text",
"ip_address": "text",
"timezone": "text",
"network_type": "text",
"isp": "text"
},
"console_logs": "text",
"customer": {
"email": "name@gmail.com"
},
"user": {
"email": "name@gmail.com",
"name": "text"
},
"room_insights": {
"started_at": "2026-08-05T16:33:09.102Z",
"ended_at": "2026-08-05T16:33:09.102Z",
"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-08-05T16:33:09.102Z",
"left_at": "2026-08-05T16:33:09.102Z"
}
]
}
}binary{
"recording_uuid": "123e4567-e89b-12d3-a456-426614174000",
"status": "ready",
"language": "text",
"speaker_map": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"pagination": {
"count": 1,
"page": 1,
"items": 1,
"pages": 1,
"next_page": 1,
"prev_page": 1,
"last_page": 1,
"from": 1,
"to": 1
},
"segments": [
{
"start_seconds": 1,
"end_seconds": 1,
"text": "text",
"sentences": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}
]
}GET /api/v2/recordings HTTP/1.1
Host: app.screendesk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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-08-05T16:33:09.102Z",
"updated_at": "2026-08-05T16:33:09.102Z",
"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",
"active_ticket_id": "text",
"user_id": "text",
"operator_id": "text",
"customer_id": "text",
"issue_id": "text",
"object_id": "text"
}
},
"technical_details": {
"vendor": "text",
"ip_address": "text",
"timezone": "text",
"network_type": "text",
"isp": "text"
},
"console_logs": "text",
"customer": {
"email": "name@gmail.com"
},
"user": {
"email": "name@gmail.com",
"name": "text"
},
"room_insights": {
"started_at": "2026-08-05T16:33:09.102Z",
"ended_at": "2026-08-05T16:33:09.102Z",
"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-08-05T16:33:09.102Z",
"left_at": "2026-08-05T16:33:09.102Z"
}
]
}
}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"
}
}GET /api/v2/recordings/{uuid}/download HTTP/1.1
Host: app.screendesk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
GET /api/v2/recordings/{uuid}/transcript HTTP/1.1
Host: app.screendesk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
GET /api/v2/users 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
},
"users": [
{
"email": "name@gmail.com",
"name": "text",
"has_profile_picture": true,
"created_at": "2026-08-05T16:33:09.102Z",
"updated_at": "2026-08-05T16:33:09.102Z",
"role": "admin",
"notifications": {
"notify_first_view": "Enabled",
"notify_all_recordings": "Enabled",
"notify_own_recordings": "Enabled"
}
}
]
}GET /api/v2/users/search?email=name%40gmail.com HTTP/1.1
Host: app.screendesk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"email": "name@gmail.com",
"name": "text",
"has_profile_picture": true,
"created_at": "2026-08-05T16:33:09.102Z",
"updated_at": "2026-08-05T16:33:09.102Z",
"role": "admin",
"notifications": {
"notify_first_view": "Enabled",
"notify_all_recordings": "Enabled",
"notify_own_recordings": "Enabled"
}
}