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
Get Client
Returns a client specified belonging to a workspace
Authorizations
Workspace secret API key, found in the workspace settings page (top left).
Path Parameters
The ID of the client to retrieve
Response
Client data
List of hrefs the client can access.
/overview, /home, /convos, /analytics, /kb, /settings Password for the client's dashboard (used as password to signin on dashboard).
The email address of the client (used as username to signin on dashboard).
The unique identifier for the client.
Indicates if the client is an organization admin.
The name of the client.
The org ID associated with the client.
List of organization users.
List of hrefs the client can access.
/overview, /home, /convos, /analytics, /kb, /settings Password for the client's dashboard (used as password to signin on dashboard).
The email address of the client (used as username to signin on dashboard).
The unique identifier for the client.
Indicates if the client is an organization admin.
The name of the client.
The org ID associated with the client.
List of organization users.
List of hrefs the client can access.
/overview, /home, /convos, /analytics, /kb, /settings Password for the client's dashboard (used as password to signin on dashboard).
The email address of the client (used as username to signin on dashboard).
The unique identifier for the client.
Indicates if the client is an organization admin.
The name of the client.
Notification settings for the client.
The org ID associated with the client.
List of organization users.
List of hrefs the client can access.
/overview, /home, /convos, /analytics, /kb, /settings Password for the client's dashboard (used as password to signin on dashboard).
The email address of the client (used as username to signin on dashboard).
The unique identifier for the client.
Indicates if the client is an organization admin.
The name of the client.
Notification settings for the client.
The org ID associated with the client.
List of organization users.
The owner user/workspace uid associated with the client.
URL to the square photo of the client.
The owner user/workspace uid associated with the client.
URL to the square photo of the client.
The owner user/workspace uid associated with the client.
URL to the square photo of the client.
The owner user/workspace uid associated with the client.
URL to the square photo of the client.