Get Org Clients
API Reference
API Documentation
V3
- Get Started
- 📁 Workspaces
- 🤖 Agents
- Calls & Numbers
- 🔨 Tools
- ✖️ Variables
- 👥 Leads
- 🧠 Knowledge Base
Agents
- Introduction
- GETGet Agent
- POSTCreate/Edit Agent
- DELDelete Agent
- POSTChat Interact
- POSTConfigure State
- 🧠 Knowledge Base
- 💬 Conversations
- 📊 Analytics
Workspaces
- GETGet Workspace
- POSTEdit Workspace
- DELDelete Workspace
- 💼 Agency
- 🏢 Orgs
- 🤝 Clients
Get Org Clients
Returns all organizations associated with the bearer token
GET
/
v2
/
orgs
curl --request GET \
--url https://eu-vg-edge.moeaymandev.workers.dev/v2/orgs \
--header 'Authorization: Bearer <token>'{
"success": true,
"message": "Organizations retrieved successfully",
"data": [
{
"ID": "<string>",
"userId": "<string>",
"name": "<string>",
"preferredLanguage": "<string>",
"squarePhotoURL": "<string>",
"widgetIDs": [
"<string>"
],
"adminIDs": [
"<string>"
],
"canSelfEdit": true,
"disallowAnyTags": true,
"dashboardLayout": "vertical",
"lastModified": 123
}
]
}Authorizations
Workspace secret API key, found in the workspace settings page (top left).
Response
200
application/json
Organizations retrieved
Array of organization objects
The name of the organization client.
The unique identifier for the organization client.
The owner user/workspace uid associated with the org client.
Preferred language for the client ISO6391 code (fr for french, no for norwegian).
URL to the square photo of the organization client.
List of agent IDs associated with the organization client.
List of admin IDs associated with the organization client.
Indicates if the organization clients can self-edit.
Indicates if any tags are disallowed.
Layout of the dashboard.
Available options:
vertical, horizontal Timestamp indicating when the organization client was last modified.
curl --request GET \
--url https://eu-vg-edge.moeaymandev.workers.dev/v2/orgs \
--header 'Authorization: Bearer <token>'{
"success": true,
"message": "Organizations retrieved successfully",
"data": [
{
"ID": "<string>",
"userId": "<string>",
"name": "<string>",
"preferredLanguage": "<string>",
"squarePhotoURL": "<string>",
"widgetIDs": [
"<string>"
],
"adminIDs": [
"<string>"
],
"canSelfEdit": true,
"disallowAnyTags": true,
"dashboardLayout": "vertical",
"lastModified": 123
}
]
}