REST API

Build cobrowsing into your own product

Everything the UserView dashboard does, your own code can do too. Find a visitor, start a session, or embed the viewer directly in the tool your agents already use — no plugin, no separate console.

Read the API docs Talk to the Team

What you can do with it

Most teams never need this — the standard install puts cobrowsing on your site in one snippet. The API is for when you want cobrowsing to happen somewhere else: inside a tool your agents already use, inside a product you sell, or as part of a process you want to run automatically.

Let agents start a session without leaving their tools

Add a “View screen” button straight into your helpdesk, CRM or internal admin. The agent clicks it where they already are, instead of switching to another console and searching for the customer.

Put cobrowsing inside a product you sell

If you sell software to other businesses, you can embed the session viewer in your own product under your own branding. Your customers get cobrowsing without ever seeing UserView.

Trigger sessions from your own workflows

Start, end or clean up sessions from your own systems — for example ending a session automatically when a ticket closes, or removing visitor records on a schedule you control.

Pull session data into your own reporting

List past sessions and account usage to feed your own dashboards, rather than reading numbers off ours.

Building this takes a developer and a few hours, not a project. The rest of this page is the technical detail they’ll need.

What you can build

The API covers the whole session lifecycle, from finding the person who needs help to ending the session and cleaning up afterwards.

Find the right visitor

Search by email, name or your own identifiers, or list everyone currently active on your site. Pull a single visitor's details when you already know who you're looking for.

GET /listGET /visitors/{id}

Start a session from your own code

Generate a secure watch link for a visitor and hand it to an agent — no dashboard round trip. Unlike the standard watch link, a generated one can be used without the agent holding a UserView account.

POST /visitors/{id}/watch_url

Embed cobrowsing in your product

Issue a viewer token and render the session inside your own application, so agents never leave the tool they already work in. This is the route for white-label and embedded builds.

POST /visitors/{id}/viewer_token

Manage sessions and data

End a live session, list past sessions with filtering, look up an agent by email or external ID, and delete visitor records on request — useful for automating your own retention rules.

GET /cobrowsing_sessions/listDELETE /visitors/{id}/sessionGET /agents/lookupDELETE /visitors/{id}

Base URL

https://api.upscope.io/v1.4/

Authentication

X-Api-Key header

Format

JSON over HTTPS

Authentication

Send your API key in an X-Api-Key header on every request. This is a private key and belongs on your server — it is not the public key you put in the browser snippet.

A failed request returns 401 with a reason: invalid_api_key, no_subscription, api_not_enabled or please_contact_team. If you see api_not_enabled, the API isn’t switched on for your account yet — get in touch and we’ll enable it.

# List recently active visitors
curl https://api.upscope.io/v1.4/list \
  -H "X-Api-Key: YOUR_API_KEY"

# Generate a watch link for one visitor
curl -X POST \
  https://api.upscope.io/v1.4/visitors/{visitor_id}/watch_url \
  -H "X-Api-Key: YOUR_API_KEY"

Endpoints

Paths are relative to https://api.upscope.io/v1.4/.

Method	Path	Purpose
GET	/usage	Account usage statistics
GET	/list	Search visitors, or list recently active ones
GET	/visitors/{visitor_id}	Retrieve one visitor's details
POST	/visitors/{visitor_id}/watch_url	Generate a secure link to view their screen
POST	/visitors/{visitor_id}/viewer_token	Token to embed cobrowsing in your own app
DELETE	/visitors/{visitor_id}/session	End an active session
DELETE	/visitors/{visitor_id}	Remove a visitor
DELETE	/visitors?all=true	Remove all offline visitors
GET	/agents/lookup	Look up an agent by email or external ID
GET	/cobrowsing_sessions/list	List sessions, with filtering
POST	/onpremise/token	Authorise an on-premise session

Object types, search options and embedded session control are covered in the full API documentation.

Works on-premise too

Running UserView on your own servers doesn’t mean giving up the API. Sessions are authorised through a dedicated endpoint so the same integrations keep working.

On-premise setup docs

Prefer the SDK?

If you only need cobrowsing on your own site, the JavaScript and mobile SDKs are a smaller lift — one snippet, no server code. The API is for embedding, automating or white-labelling.

SDK installation docs

Transform Your Customer Support

Join hundreds of companies using UserView to deliver faster, more effective customer support experiences.

Talk to the Team Free Trial