How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Genesys Screen Monitoring API

Real-time screen monitoring

Genesys Screen Monitoring API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Screen Monitoring. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 11 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

11 operations 8 paths 11 schemas 2 DELETE5 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Screen Monitoring API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Screen Monitoring 11

Real-time screen monitoring

GET
/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}
Get a conversation-level screen monitoring session object using the supplied screenMonitoringId.
getConversationParticipantScreenmonitorsSession 3 params → 200400401403404408409413
DELETE
/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}
Stop a conversation-level screen monitoring session.
deleteConversationParticipantScreenmonitorsSession 3 params → 204400401403404408409413
POST
/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions
Start a conversation-level screen monitoring session.
postConversationParticipantScreenmonitorsSessions 2 params → 200400401403404408409413
GET
/api/v2/screenmonitors/users/{userId}/sessions
Get all screen monitoring sessions for the supplied userId.
getScreenmonitorsUserSessions 1 param → 200400401403404408409413
GET
/api/v2/screenmonitors/sessions/details
Get the details of all screen monitoring sessions for the current organization.
getScreenmonitorsSessionsDetails → 200400401403404408409413
POST
/api/v2/screenmonitors/sessions/users/details
Get screen monitor session details for one or more users.
postScreenmonitorsSessionsUsersDetails 1 param → 200400401403404408409413
GET
/api/v2/screenmonitors/settings
Get the Screen Monitor Settings for the Organization
getScreenmonitorsSettings → 200400401403404408409413
PUT
/api/v2/screenmonitors/settings
Update the Screen Monitor Settings for the Organization
putScreenmonitorsSettings 1 param → 204400401403404408409413
GET
/api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}
Get an agent-level screen monitoring session object using the supplied screenMonitoringId.
getUserScreenmonitorsSession 2 params → 200400401403404408409413
DELETE
/api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}
Stop an agent-level screen monitoring session.
deleteUserScreenmonitorsSession 2 params → 204400401403404408409413
POST
/api/v2/users/{userId}/screenmonitors/sessions
Start an agent-level screen monitoring session.
postUserScreenmonitorsSessions 1 param → 200400401403404408409413

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ErrorBody (11 properties), ScreenMonitoringSession (8 properties), Detail (4 properties), Limit (3 properties). Each schema is shown below with its type and property counts.

ScreenMonitoringSessionEntityListing
object
1 property
ErrorBody
object
11 properties
AddressableEntityRef
object
2 properties
ScreenMonitoringUserDetails
object
2 properties 1 required
ScreenMonitoringDetails
object
1 property 1 required
ScreenMonitoringSession
object
8 properties 4 required
ScreenMonitorSettings
object
2 properties
Limit
object
3 properties
StartScreenMonitorResponseBody
object
1 property
ScreenMonitoringUserDetailsEntityListing
object
1 property
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-screen-monitoring-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

This is an independent, third-party profile of Genesys Screen Monitoring API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.