Skip to main content
GET
/
api
/
webchats
List all webchat configurations
curl --request GET \
  --url https://your-instance.example.com/api/webchats \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "_id": "67d3a0b0c0d0e0f0a0b0c0d0",
      "name": "Marketing site widget",
      "organizationId": "65a0e0e0e0e0e0e0e0e0e0e0",
      "isEnabled": true,
      "primaryColor": "#1F2937"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Webchat configurations returned

Response from GET /api/webchats.

​
data
object[]
required

Webchat configurations in the calling organization, newest-first.