API
Analytics
Accessing analytics overview
Accessing analytics overview
Accessing list of rooms
Accessing list of rooms
Find room analytics
Find room analytics
BulkRooms
Find room details
Rooms
Add invitees to room
Add invitees to room
Cancel a scheduled room
Cancel a scheduled room
Create a room
Create a room
Create a limited use token
Delete invitees
Delete invitees
Delete limited use token
Find room information
Find room details
Find room details
Find currently running rooms
Find scheduled rooms
Find scheduled rooms
Send invitations
Terminate a room
Find most shared urls
Update room details
Update room details
Find webhook event details
Accessing analytics overview
[Optional]
averageduration_alltime
integer
average duration of all rooms (in minutes)
[Optional]
averageduration_thismonth
integer
average duration of rooms this month (in minutes)
[Optional]
averageduration_thisweek
integer
average duration of rooms this week (in minutes)
[Optional]
averageduration_today
integer
average duration of rooms today (in minutes)
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
rooms_thismonth
integer
number of rooms this month
[Optional]
rooms_thisweek
integer
number of rooms this week
[Optional]
rooms_today
integer
number of rooms today
[Optional]
rooms_total
integer
total number of rooms
[Optional]
success
boolean
whether the api call was successful
[Optional]
url_latest
string
the last url viewed
[Optional]
url_most_popular
string
the most popular url
Example Request
POST /api/v3/analyticsoverview HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Length: 0
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"averageduration_alltime": 45,
"averageduration_thismonth": 37,
"averageduration_thisweek": 56,
"averageduration_today": 34,
"rooms_thismonth": 234,
"rooms_thisweek": 67,
"rooms_today": 12,
"rooms_total": 1257,
"success": true,
"url_latest": "https://www.samesurf.com",
"url_most_popular": "https://www.google.com"
}
Accessing analytics overview
Gets a overview of the analytics for rooms.
[Optional]
averageduration_alltime
integer
average duration of all rooms (in minutes)
[Optional]
averageduration_thismonth
integer
average duration of this months's rooms (in minutes)
[Optional]
averageduration_thisweek
integer
average duration of this week's rooms (in minutes)
[Optional]
averageduration_today
integer
average duration of today's rooms (in minutes)
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
rooms_thismonth
integer
number of rooms month
[Optional]
rooms_thisweek
integer
number of rooms this week
[Optional]
rooms_today
integer
number of rooms today
[Optional]
rooms_total
integer
total number of rooms
[Optional]
success
boolean
whether the api call was successful
[Optional]
url_latest
string
the last url viewed
[Optional]
url_most_popular
string
the most viewed url
Example Request
POST /api/v2/analyticsoverview HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Length: 0
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"averageduration_alltime": 32,
"averageduration_thismonth": 39,
"averageduration_thisweek": 45,
"averageduration_today": 71,
"rooms_thismonth": 431,
"rooms_thisweek": 236,
"rooms_today": 25,
"rooms_total": 1023,
"success": true,
"url_latest": "https://www.google.com",
"url_most_popular": "https://www.samesurf.com"
}
Accessing list of rooms
[Optional]
end_date
string
end date for filtering rooms
[Optional]
skip
integer
the number of records to skip
[Optional]
start_date
string
start date for filtering rooms
[Optional]
take
integer
the number of records to return
[Optional]
timezone
string
you only need to add a timezone if the event time is not in UTC, example "Europe / London"
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
rooms
array[object]
list of rooms
[Optional]
date
string
room date
[Optional]
duration
integer
room duration
[Optional]
experience
integer
overall experience score for the room
[Optional]
room
string
room name
[Optional]
screenrecordings
integer
number of screen recordings
[Optional]
title
string
room title
[Optional]
version
integer
room version
[Optional]
success
boolean
whether the api call was successful
[Optional]
total_rooms
integer
total number of rooms
Example Request
POST /api/v3/analyticsrooms HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"end_date": "string",
"skip": integer,
"start_date": "string",
"take": integer,
"timezone": "string"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"rooms": [{
"date": "string",
"duration": integer,
"experience": integer,
"room": "string",
"screenrecordings": integer,
"title": "string",
"version": integer
}],
"success": true,
"total_rooms": integer
}
Accessing list of rooms
[Optional]
skip
integer
the number of rooms to skip
[Optional]
take
integer
the number of rooms to return
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
rooms
array[object]
list of rooms
[Optional]
date
string
room date
[Optional]
duration
integer
room duration
[Optional]
name
string
room name
[Optional]
title
string
room title
[Optional]
version
integer
room version
[Optional]
success
boolean
whether the api call was successful
[Optional]
total_rooms
integer
total number of rooms
Example Request
POST /api/v2/analyticsrooms HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"skip": integer,
"take": integer
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"rooms": [{
"date": "string",
"duration": integer,
"name": "string",
"title": "string",
"version": integer
}],
"success": true,
"total_rooms": integer
}
Find room analytics
[Required]
room
string
room name
[Optional]
version
integer
room version number, default is 0
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
events
array[object]
list of room events
[Optional]
data
string
data of event
[Optional]
date
string
date of event
[Optional]
sender
string
sender of event
[Optional]
target
string
target of event
[Optional]
type
string
event type
[Optional]
experience
integer
room experience score
[Optional]
success
boolean
whether the api call was successful
[Optional]
title
string
room title
[Optional]
users
array[object]
list of room users
[Optional]
city
string
user's city
[Optional]
country
string
user's country
[Optional]
experience
integer
user's experience score
[Optional]
guid
string
user guid
[Optional]
host
boolean
whether user was the host
[Optional]
ipaddress
string
user's ip address
[Optional]
joinedat
string
date user joined the room
[Optional]
leftat
string
date user left the room
[Optional]
name
string
user's name
[Optional]
userinformation
array[object]
list of user's information if given
[Optional]
key
string
key of user information
[Optional]
value
string
value of user information
Example Request
POST /api/v3/roomanalytics HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"events": [{
"data": "string",
"date": "string",
"sender": "string",
"target": "string",
"type": "string"
}],
"experience": 96,
"success": true,
"title": "Product training",
"users": [{
"city": "string",
"country": "string",
"experience": integer,
"guid": "string",
"host": boolean,
"ipaddress": "string",
"joinedat": "string",
"leftat": "string",
"name": "string",
"userinformation": [{
"key": "string",
"value": "string"
}]
}]
}
Find room analytics
[Required]
name
string
room name
[Optional]
version
integer
room version number, default is 0
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
events
array[object]
[Optional]
data
string
[Optional]
date
string
[Optional]
sender
string
[Optional]
target
string
[Optional]
type
string
[Optional]
success
boolean
whether the api call was successful
[Optional]
title
string
[Optional]
users
array[object]
[Optional]
city
string
[Optional]
country
string
[Optional]
guid
string
[Optional]
host
boolean
[Optional]
ipaddress
string
[Optional]
joinedat
string
[Optional]
leftat
string
[Optional]
name
string
Example Request
POST /api/v2/roomanalytics HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"name": "123456789",
"version": 1
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"events": [{
"data": "string",
"date": "string",
"sender": "string",
"target": "string",
"type": "string"
}],
"success": true,
"title": "string",
"users": [{
"city": "string",
"country": "string",
"guid": "string",
"host": boolean,
"ipaddress": "string",
"joinedat": "string",
"leftat": "string",
"name": "string"
}]
}
Find room details
[Required]
rooms
array[string]
multiple rooms name
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/bulkroomdetails HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"rooms": ["['123456789', '234567890"]
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Create subscription
Can only be called from reseller subscription
[Required]
name
string
name of the subscription to create, must not already exist
[Optional]
bookmarks
array[object]
[Optional]
link
string
url of bookmark
[Optional]
name
string
name of bookmark
[Optional]
configuration_overrides
array[object]
[Optional]
key
string
[Optional]
value
string
[Optional]
disabled_features
array[string]
[Optional]
licensecount
integer
number of licenses for subscription
Example Request
POST /api/v3/reseller/createsubscription HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"name": "string",
"bookmarks": [{
"link": "string",
"name": "string"
}],
"configuration_overrides": [{
"key": "string",
"value": "string"
}],
"disabled_features": ["string"],
"licensecount": integer
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Delete subscription
Can only be called from reseller subscription
[Required]
name
string
name of the subscription to delete
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/reseller/deletesubscription HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"name": "string"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Create api key
Can only be called from reseller subscription
[Required]
subscription
string
name of the subscription to create the API key for
[Optional]
apiKey
string
API key
[Optional]
ApiKey
string
API key
[Optional]
apiSecret
string
API secret
[Optional]
ApiSecret
string
API secret
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/reseller/createapikey HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"subscription": "string"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"apiKey": "string",
"ApiKey": "string",
"apiSecret": "string",
"ApiSecret": "string",
"success": true
}
Delete api key
Can only be called from reseller subscription
[Required]
apikey
string
api key to delete
[Optional]
force
boolean
force delete even if it's the only api key for the subscription
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/reseller/deleteapikey HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"apikey": "string",
"force": boolean
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Add invitees to room
[Required]
room
string
the room id to add invitees to
[Optional]
emails
string
comma separated list of emails
[Optional]
invitemessage
string
the message to send to the invitees
[Optional]
version
integer
the room version number, default is 0
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/addinvitees HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789",
"emails": "example@example.com,another@exammple.com",
"invitemessage": "We hope you can join us!",
"version": 1
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Add invitees to room
[Required]
name
string
the room id to add invitees to
[Optional]
emails
string
comma separated list of emails
[Optional]
invitemessage
string
the message to send to the invitees
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v2/addinvitees HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"name": "123456789",
"emails": "example@example.com",
"invitemessage": "We hope you can join us!"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Cancel a scheduled room
[Optional]
room
string
name of the room to cancel
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/cancelroom HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Cancel a scheduled room
Cancels a room and emails invitees that it has been cancelled.
[Optional]
name
string
name of the room to cancel
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v2/cancelroom HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"name": "123456789"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Create a room
[Optional]
bookmarks
array[object]
bookmarks to add to the room
[Optional]
link
string
url of bookmark
[Optional]
name
string
name of bookmark
[Optional]
cookies
array[object]
list of cookies to add to the room, this should be added inside the session object rather than here
[Optional]
domain
string
domain of the cookie
[Optional]
httpOnly
boolean
httpOnly flag of the cookie
[Optional]
name
string
name of the cookie
[Optional]
path
string
path of the cookie
[Optional]
secure
boolean
secure flag of the cookie
[Optional]
value
string
value of the cookie
[Optional]
country
string
this is used to work out the best server to host the room, auto = will use your ip to work out country
[Optional]
disabledfeatures
array[string]
features to disable in the room, the options include: MODE_DOCUMENT_SHARE MODE_VIDEO_SHARE MODE_SCREEN_SHARE MODE_LOGOUT TOOLS_SCREEN_RECORDING TOOLS_VIDEO_CHAT TOOLS_AUDIO_CHAT TOOLS_12MANY_VIDEO TOOLS_MOUSE_TRACKING TOOLS_DISCONNECT_USER
[Optional]
eventtime
string
start time of the room
[Optional]
invitees
string
comma separated list of invitees email addresses
[Optional]
invitemessage
string
message to send to invitees
[Optional]
lengthinminutes
integer
room length in minutes
[Optional]
session
object
[Optional]
cookies
array[object]
list of cookies to add to the room
[Optional]
domain
string
domain of the cookie
[Optional]
httpOnly
boolean
httpOnly flag of the cookie
[Optional]
name
string
name of the cookie
[Optional]
path
string
path of the cookie
[Optional]
secure
boolean
secure flag of the cookie
[Optional]
value
string
value of the cookie
[Optional]
opaquedata
array[object]
list of opaque data to add to the room
[Optional]
key
string
[Optional]
value
string
[Optional]
storage
array[object]
list of storage to add to the room
[Optional]
domain
string
[Optional]
name
string
[Optional]
value
string
[Optional]
startmode
string
[Optional]
starturl
string
the url to start the room with
[Optional]
timezone
string
you only need to add a timezone if the event time is not in UTC, example "Europe / London"
[Optional]
title
string
a description of the room, this will show in analytics
[Optional]
userid
integer
the user id of the user creating the room
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
leadertoken
string
[Optional]
privateinvitation
string
[Optional]
publicinvitation
string
[Optional]
room
string
[Optional]
success
boolean
whether the api call was successful
[Optional]
token
string
Example Request
POST /api/v3/create HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"bookmarks": [{
"link": "string",
"name": "string"
}],
"cookies": [{
"domain": "string",
"httpOnly": boolean,
"name": "string",
"path": "string",
"secure": boolean,
"value": "string"
}],
"country": "string",
"disabledfeatures": ["MODE_DOCUMENT_SHARE"],
"eventtime": "22/02/2024 16:30:00",
"invitees": "1234",
"invitemessage": "string",
"lengthinminutes": 60,
"session": {
"cookies": [{
"domain": "string",
"httpOnly": boolean,
"name": "string",
"path": "string",
"secure": boolean,
"value": "string"
}],
"opaquedata": [{
"key": "string",
"value": "string"
}],
"storage": [{
"domain": "string",
"name": "string",
"value": "string"
}]
},
"startmode": "string",
"starturl": "https://www.samesurf.com",
"timezone": "Europe/London",
"title": "Product demonstration",
"userid": 1234
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"leadertoken": "string",
"privateinvitation": "string",
"publicinvitation": "string",
"room": "string",
"success": true,
"token": "string"
}
Create a room
Cancels a room and emails invitees that it has been cancelled.
[Optional]
bookmarks
array[object]
bookmarks to add to the room
[Optional]
link
string
url of bookmark
[Optional]
name
string
name of bookmark
[Optional]
cookies
array[object]
cookies to add to the room on launch
[Optional]
domain
string
domain of the cookie
[Optional]
httpOnly
boolean
httpOnly flag of the cookie
[Optional]
name
string
name of the cookie
[Optional]
path
string
path of the cookie
[Optional]
secure
boolean
secure flag of the cookie
[Optional]
value
string
value of the cookie
[Optional]
country
string
this is used to work out the best server to host the room, auto = will use your ip to work out country
[Optional]
disabledfeatures
array[string]
features to disable in the room, the options include: MODE_DOCUMENT_SHARE MODE_VIDEO_SHARE MODE_SCREEN_SHARE MODE_LOGOUT TOOLS_SCREEN_RECORDING TOOLS_VIDEO_CHAT TOOLS_AUDIO_CHAT TOOLS_12MANY_VIDEO TOOLS_MOUSE_TRACKING TOOLS_DISCONNECT_USER
[Optional]
eventtime
string
start time of the room
[Optional]
invitees
string
comma separated list of invitee emails
[Optional]
invitemessage
string
message to send to invitees
[Optional]
lengthinminutes
integer
length of the room in minutes
[Optional]
starturl
string
url to start the room
[Optional]
timezone
string
you only need to add a timezone if the event time is not in UTC, example "Europe / London"
[Optional]
title
string
name of the room
[Optional]
userid
integer
user id of the room creator
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
leadertoken
string
[Optional]
name
string
[Optional]
privateinvitation
string
[Optional]
publicinvitation
string
[Optional]
success
boolean
whether the api call was successful
[Optional]
token
string
Example Request
POST /api/v2/create HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"bookmarks": [{
"link": "string",
"name": "string"
}],
"cookies": [{
"domain": "string",
"httpOnly": boolean,
"name": "string",
"path": "string",
"secure": boolean,
"value": "string"
}],
"country": "string",
"disabledfeatures": ["string"],
"eventtime": "02/22/2024 16:30:00",
"invitees": "string",
"invitemessage": "string",
"lengthinminutes": integer,
"starturl": "string",
"timezone": "Europe / London",
"title": "string",
"userid": integer
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"leadertoken": "string",
"name": "string",
"privateinvitation": "string",
"publicinvitation": "string",
"success": true,
"token": "string"
}
Create a limited use token
[Required]
room
string
the room name to create the token for
[Required]
usagelimit
integer
the number of times the token can be used, must be at least 1
[Optional]
expiration_date
string
the date and time the token will expire, in ISO 8601 format
[Optional]
expiration_timezone
string
you only need to add a timezone if the event time is not in UTC, example "Europe/London"
[Optional]
isleader
boolean
whether to set the user as the leader of the room
[Optional]
usersinformation
array[object]
a list of key value pairs to set the user's information, available within analytics
[Optional]
key
string
[Optional]
value
string
[Optional]
usersname
string
automatically set the user's name when they enter the room
[Optional]
version
integer
the version number of the room, default is 0
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
guid
string
the guid of the token
[Optional]
link
string
the link to use to enter the room
[Optional]
success
boolean
whether the api call was successful
[Optional]
token
string
the token to use to enter the room
Example Request
POST /api/v3/createlimitedusetoken HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789",
"usagelimit": 1,
"expiration_date": "01/01/2020 00:00:00",
"expiration_timezone": "Europe/London",
"isleader": true,
"usersinformation": [{
"key": "string",
"value": "string"
}],
"usersname": "John Doe"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"guid": "string",
"link": "string",
"success": true,
"token": "eyJhbGciOi"
}
Delete invitees
[Required]
emails
string
comma separated list of emails to delete
[Required]
room
string
name of the room
[Optional]
sendnotification
boolean
whether to send notification to the deleted users
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/deleteinvitees HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"emails": "example@example,example2@example",
"room": "123456789",
"sendnotification": true
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Delete invitees
Delete invitees and optionally send them an email that they've been removed.
[Required]
emails
string
comma separated list of emails to delete
[Required]
name
string
name of the room
[Optional]
sendnotification
boolean
whether to send a notification to the removed invitees
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v2/deleteinvitees HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"emails": "example@example",
"name": "123456789",
"sendnotification": true
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Delete limited use token
[Required]
token
string
token to delete
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/deletelimitedusetoken HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"token": "string"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Find room information
[Required]
room
string
room name
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
leadertoken
string
token for leader
[Optional]
name
string
name of room
[Optional]
privateinvitation
string
invitation link for leader
[Optional]
publicinvitation
string
invitation link for guest
[Optional]
success
boolean
whether the api call was successful
[Optional]
token
string
token for guests
Example Request
POST /api/v2/find HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"leadertoken": "FEDCBA654321",
"name": "123456789",
"privateinvitation": "string",
"publicinvitation": "string",
"success": true,
"token": "ABCDEF123456"
}
Find room details
[Required]
room
string
room name
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
eventtime
string
start time of the room
[Optional]
eventtimeutc
string
start time of the room in UTC
[Optional]
guestguid
string
guid for guests
[Optional]
invitees
array[object]
list of invitees
[Optional]
email
string
email of the invitee
[Optional]
invitemessage
string
message for invitees
[Optional]
leadertoken
string
token for leaders
[Optional]
lengthinminutes
integer
length of the room in minutes
[Optional]
room
string
name of the room
[Optional]
success
boolean
whether the api call was successful
[Optional]
timezone
string
timezone of the room
[Optional]
title
string
title of the room
Example Request
POST /api/v3/roomdetails HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"eventtime": "01/01/2021 18:00:00",
"eventtimeutc": "01/01/2021 19:00:00",
"guestguid": "string",
"invitees": [{
"email": "example@example.com"
}],
"invitemessage": "string",
"leadertoken": "string",
"lengthinminutes": 60,
"room": "123456789",
"success": true,
"timezone": "Europe/London",
"title": "Product training"
}
Find room details
[Required]
name
string
Room name
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
eventtime
string
start time of the room
[Optional]
eventtimeutc
string
start time of the room in UTC
[Optional]
guestguid
string
guest guid of the room
[Optional]
invitees
array[object]
list of invitees
[Optional]
email
string
email address of invitee
[Optional]
invitemessage
string
message to be displayed to the invitee
[Optional]
leadertoken
string
leader token of the room
[Optional]
lengthinminutes
integer
length of the room in minutes
[Optional]
name
string
name of the room
[Optional]
success
boolean
whether the api call was successful
[Optional]
timezone
string
timezone of the room
[Optional]
title
string
title of the room
Example Request
POST /api/v2/roomdetails HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"name": "123456789"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"eventtime": "string",
"eventtimeutc": "string",
"guestguid": "string",
"invitees": [{
"email": "string"
}],
"invitemessage": "string",
"leadertoken": "string",
"lengthinminutes": integer,
"name": "string",
"success": true,
"timezone": "string",
"title": "string"
}
Find currently running rooms
[Optional]
limit
integer
maximum number of rooms to return
[Optional]
skip
integer
number of rooms to skip
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
rooms
array[object]
list of running rooms
[Optional]
privateinvitation
string
leader invitation link
[Optional]
publicinvitation
string
guest invitation link
[Optional]
room
string
name of the room
[Optional]
starttime
string
start time of the room
[Optional]
title
string
title of the room
[Optional]
success
boolean
whether the api call was successful
[Optional]
totalrooms
integer
total number of running rooms
Example Request
POST /api/v3/runningrooms HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"limit": 10,
"skip": 10
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"rooms": [{
"privateinvitation": "string",
"publicinvitation": "string",
"room": "123456789",
"starttime": "01/01/2021 18:00:00",
"title": "Product training"
}],
"success": true,
"totalrooms": integer
}
Find scheduled rooms
[Optional]
userid
integer
optionally filter by user id
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
rooms
array[object]
list of scheduled rooms
[Optional]
eventtime
string
start time of the room
[Optional]
eventtimeutc
string
start time of the room in UTC
[Optional]
lengthinminutes
integer
length of the room in minutes
[Optional]
room
string
name of the room
[Optional]
timezone
string
timezone of the room
[Optional]
title
string
title of the room
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/scheduledrooms HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"rooms": [{
"eventtime": "01/01/2021 18:00:00",
"eventtimeutc": "01/01/2021 19:00:00",
"lengthinminutes": 60,
"room": "123456789",
"timezone": "Europe/London",
"title": "Product training"
}],
"success": true
}
Find scheduled rooms
[Optional]
userid
integer
optionally filter by user id
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
rooms
array[object]
list of scheduled rooms
[Optional]
eventtime
string
start time of room
[Optional]
eventtimeutc
string
start time of room in UTC
[Optional]
lengthinminutes
integer
length of room in minutes
[Optional]
name
string
name of room
[Optional]
timezone
string
timezone of room
[Optional]
title
string
title of room
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v2/scheduledrooms HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"userid": user_id
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"rooms": [{
"eventtime": "01/01/2021 09:00:00",
"eventtimeutc": "01/01/2021 12:00:00",
"lengthinminutes": 60,
"name": "123456789",
"timezone": "America/New_York",
"title": "Sales meeting"
}],
"success": true
}
Send invitations
Sends an invitation to a user, you must provide an email or phone number, or both
[Optional]
from_email
string
email address to send the invitation from
[Optional]
from_name
string
name of the sender
[Optional]
htmlmessage
string
html of the message
[Optional]
subject
string
subject of the message
[Optional]
textmessage
string
text version of the message
[Optional]
to_email
string
email address to send the invitation to
[Optional]
to_sms
string
phone number to send the invitation to
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/sendinvitation HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"from_email": "string",
"from_name": "string",
"htmlmessage": "string",
"subject": "string",
"textmessage": "string",
"to_email": "example@example.com",
"to_sms": "string"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Terminate a room
[Required]
room
string
name of the room to terminate
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/terminateroom HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Update room details
[Required]
room
string
name of the room to update
[Optional]
bookmarks
array[object]
new list of bookmarks
[Optional]
link
string
url of bookmark
[Optional]
name
string
name of bookmark
[Optional]
cookies
array[object]
new list of cookies
[Optional]
domain
string
domain of the cookie
[Optional]
httpOnly
boolean
httpOnly flag of the cookie
[Optional]
name
string
name of the cookie
[Optional]
path
string
path of the cookie
[Optional]
secure
boolean
secure flag of the cookie
[Optional]
value
string
value of the cookie
[Optional]
disabledfeatures
array[string]
new list of disabled features
[Optional]
eventtime
string
new event time
[Optional]
lengthInMinutes
integer
new length in minutes
[Optional]
timezone
string
new timezone
[Optional]
title
string
new title for room
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/updateroom HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789",
"bookmarks": [{
"link": "string",
"name": "string"
}],
"cookies": [{
"domain": "string",
"httpOnly": boolean,
"name": "string",
"path": "string",
"secure": boolean,
"value": "string"
}],
"disabledfeatures": ["string"],
"eventtime": "01/01/2020 00:00:00",
"lengthInMinutes": 60,
"timezone": "Europe/London",
"title": "New name"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"success": true
}
Update room details
[Required]
name
string
name of the room to udpate
[Optional]
bookmarks
array[object]
new list of bookmarks
[Optional]
link
string
url of bookmark
[Optional]
name
string
name of bookmark
[Optional]
cookies
array[object]
new list of cookies
[Optional]
domain
string
domain of the cookie
[Optional]
httpOnly
boolean
httpOnly flag of the cookie
[Optional]
name
string
name of the cookie
[Optional]
path
string
path of the cookie
[Optional]
secure
boolean
secure flag of the cookie
[Optional]
value
string
value of the cookie
[Optional]
disabledfeatures
array[string]
new list of disabled features
[Optional]
eventtime
string
new start time for the room
[Optional]
lengthInMinutes
integer
new length in minutes for the room
[Optional]
timezone
string
new timezone for the room
[Optional]
title
string
new title for the room
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
leadertoken
string
[Optional]
name
string
[Optional]
privateinvitation
string
[Optional]
publicinvitation
string
[Optional]
success
boolean
whether the api call was successful
[Optional]
token
string
Example Request
POST /api/v2/updateroom HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"name": "123456789",
"bookmarks": [{
"link": "string",
"name": "string"
}],
"cookies": [{
"domain": "string",
"httpOnly": boolean,
"name": "string",
"path": "string",
"secure": boolean,
"value": "string"
}],
"disabledfeatures": ["string"],
"eventtime": "01/01/2024 10:00:00",
"lengthInMinutes": 60,
"timezone": "Europe/London",
"title": "New title"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"leadertoken": "string",
"name": "string",
"privateinvitation": "string",
"publicinvitation": "string",
"success": true,
"token": "string"
}
Find webhook event details
[Optional]
guid
string
guid of webhook event
[Optional]
date
string
event date
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
eventdetails
event details
[Optional]
eventtype
string
event type
[Optional]
room
string
room name
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/webhookevent HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"guid": "string"
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"date": "string",
"eventdetails": ,
"eventtype": "string",
"room": "string",
"success": true
}
Create screenshot public link
Creates a public link for the screenshot of the screen recording, if both width and height aren't set, the original image size is returned.
[Required]
room
string
room name
[Optional]
height
integer
optional height of the image
[Optional]
recording
integer
number of the recording
[Optional]
validfor
integer
how long the link is valid for in minutes
[Optional]
width
integer
optional width of the image
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
link
string
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/screenrecordingimage HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789",
"height": integer,
"recording": 2,
"validfor": 60,
"width": integer
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"link": "string",
"success": true
}
Create video public link
[Required]
room
string
name of the room
[Optional]
recording
integer
number of the recording
[Optional]
validfor
integer
how long the link is valid for in minutes
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
link
string
public link to the recording
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/screenrecordingpubliclink HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789",
"recording": 2,
"validfor": 60
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"link": "string",
"success": true
}
Create thumbnail public link
[Required]
room
string
name of the room
[Optional]
recording
integer
number of the recording
[Optional]
validfor
integer
how long the link is valid for in minutes
[Optional]
error
string
the error message if the api call was not successful
[Optional]
errorcode
enum
the error code if the api call was not successful
[Optional]
0
NoError
[Optional]
100
Unknown error
[Optional]
101
Invalid JWT Token
[Optional]
102
Invalid Room Name
[Optional]
103
Room has already been used
[Optional]
104
There are invalid email addresses
[Optional]
105
You must specify a starturl, e.g. {"starturl": "http://www.google.com"}
[Optional]
106
You must provide a timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
107
You must provide a valid timezone in IANA format, e.g. {"timezone": "Europe/London"}
[Optional]
108
The time was in an invalid format, please provide a date in the ISO 8601 format, e.g. 2016-10-30T12:00:00
[Optional]
109
Screen recording not found
[Optional]
110
Failed to create public link
[Optional]
111
Failed to create image
[Optional]
112
invalid token
[Optional]
113
Webhook event not found
[Optional]
114
Subscription already exists
[Optional]
115
Name was not specified
[Optional]
116
This call can only be made by a reseller subscription
[Optional]
117
Incorrect reseller subscription
[Optional]
118
Subscription not found
[Optional]
119
Api key not found
[Optional]
120
One api key is required for the dashboard to correctly function, you can force the api key to be deleted by adding force = true to the api call
[Optional]
121
Failed to create subscription
[Optional]
122
Event time must be in the future
[Optional]
123
Length must be at least one if it is specified
[Optional]
124
License count must be greater than zero
[Optional]
125
Usage limit must be at least one
[Optional]
127
Subject must not be empty
[Optional]
link
string
public link to the thumbnail
[Optional]
success
boolean
whether the api call was successful
Example Request
POST /api/v3/screenrecordingthumbnail HTTP/1.1
Host: api.samesurf.com
Authorization: Bearer YOUR-BEARER-TOKEN
Content-Type: application/json
{
"room": "123456789",
"recording": 2,
"validfor": 60
}
Example Response
HTTP/1.1 200 OK
Date: Wed, 21 May 2025 04:58:00 GMT
Transfer-Encoding: chunked
Content-Type: application/json
{
"link": "string",
"success": true
}