API Documentation
V3
- Get Started
- Workspaces
- Agents
Agents
- Introduction
- GETGet Agent
- POSTCreate/Edit Agent
- DELDelete Agent
- POSTChat Interact
- POSTConfigure State
- 🧠 Knowledge Base
- 💬 Conversations
- 📊 Analytics
Workspaces
🤝 Clients
Get Clients
Returns all clients associated with the bearer token
GET
/
v2
/
clients
Copy
curl --request GET \
--url https://eu-vg-edge.moeaymandev.workers.dev/v2/clients \
--header 'Authorization: Bearer <token>'
Copy
{
"success": true,
"message": "Clients retrieved successfully",
"data": [
{
"ID": "<string>",
"ownerID": "<string>",
"orgUsers": [
"<any>"
],
"orgId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"email": "<string>",
"dashboardPassword": "<string>",
"canAccess": [
"/overview"
],
"isOrgAdmin": true,
"notificationsSettings": {
"notifyThrough": "email",
"notifyIf": "all"
}
}
]
}
Authorizations
Workspace secret API key, found in the workspace settings page (top left).
Response
200
application/json
Clients retrieved
The response is of type object
.
Copy
curl --request GET \
--url https://eu-vg-edge.moeaymandev.workers.dev/v2/clients \
--header 'Authorization: Bearer <token>'
Copy
{
"success": true,
"message": "Clients retrieved successfully",
"data": [
{
"ID": "<string>",
"ownerID": "<string>",
"orgUsers": [
"<any>"
],
"orgId": "<string>",
"name": "<string>",
"squarePhotoURL": "<string>",
"email": "<string>",
"dashboardPassword": "<string>",
"canAccess": [
"/overview"
],
"isOrgAdmin": true,
"notificationsSettings": {
"notifyThrough": "email",
"notifyIf": "all"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.