Authentication

To use our REST API, you will need a secret API key. If the API is enabled for your account, you will find this in the Co-Browsing API dashboard. You can only copy the API key once before it is hidden. You will need to update the API key if you lose access to it.

To authenticate your requests, set a X-Api-Key header with your API key as the value. If authorization is unsuccessful, your request will fail.

Authentication Errors

{
  "status": "error",
  "error": "invalid_api_key"
}

HTTP Code	Error	Meaning
401	invalid_api_key	The API key provided was not found / no API key was provided.
401	no_subscription	The team's subscription has now expired.
401	api_not_enabled	The team's subscription does not include API access.
401	please_contact_team	The team's access has been restricted due to unauthorized usage.