{ "aid": "surfly.com:main-2.0", "name": "REST API Reference", "type": "Index", "description": "By using the REST API, you can integrate our Co-browsing technology into your own application or build a thin layer around our technology. You can completely customize Surfly and automate the management of client and agent creation through the REST API.\n\nThe Surfly REST API allows you to integrate the functionality of our dashboard in a programmatic manner. With our API you can do the following things:\n* **Agents** - Manage your agents\n* **Sessions** - Get an overview of all your sessions\n* **Screenshots** - Create screenshots of your co-browsing sessions\n* **Clients** - Create new clients *(reseller only)*\n* **Servers** - Get a list of all available Surfly public cloud servers\n* **History** - Get an overview of sessions history\n* **Webhooks** - Manage your webhooks\n\nBelow you can find detailed code examples illustrating how to make the REST calls. You will need your REST API key (which can be found in the integration panel, just below the widget code).\n\n> The rate limit for making REST API calls is 100 req/min/IP address", "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/surfly.com/main/2.0/apis.json", "tags": [ "surfly.com", "main" ], "created": "2026-04-09", "modified": "2026-04-09", "specificationVersion": "0.19", "access": "3rd-Party", "maintainers": [ { "FN": "Jentic", "X-github": "jentic", "url": "https://github.com/jentic" } ], "apis": [ { "aid": "surfly.com:main-2.0", "name": "REST API Reference", "description": "By using the REST API, you can integrate our Co-browsing technology into your own application or build a thin layer around our technology. You can completely customize Surfly and automate the management of client and agent creation through the REST API.\n\nThe Surfly REST API allows you to integrate the functionality of our dashboard in a programmatic manner. With our API you can do the following things:\n* **Agents** - Manage your agents\n* **Sessions** - Get an overview of all your sessions\n* **Screenshots** - Create screenshots of your co-browsing sessions\n* **Clients** - Create new clients *(reseller only)*\n* **Servers** - Get a list of all available Surfly public cloud servers\n* **History** - Get an overview of sessions history\n* **Webhooks** - Manage your webhooks\n\nBelow you can find detailed code examples illustrating how to make the REST calls. You will need your REST API key (which can be found in the integration panel, just below the widget code).\n\n> The rate limit for making REST API calls is 100 req/min/IP address", "image": "", "baseURL": "https://surfly.com/v2", "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/surfly.com/main/2.0", "version": "2.0", "tags": [ "surfly.com", "main" ], "properties": [ { "type": "OpenAPI", "name": "OpenAPI definition", "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/surfly.com/main/2.0/openapi.json", "mediaType": "application/openapi+json" }, { "type": "GitHubRepo", "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/surfly.com/main/2.0" } ] } ] }