Get Client

GET

clients

{client_id}

curl --request GET \
  --url https://eu-vg-edge.moeaymandev.workers.dev/v2/clients/{client_id} \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "Client 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

Authorization

string

header

required

Workspace secret API key, found in the workspace settings page (top left).

Path Parameters

client_id

string

required

The ID of the client to retrieve

Response

200

application/json

Client retrieved

success

boolean

Example:

true

message

string

Example:

"Client retrieved successfully"

data

object

Client data

data.ID

string

The unique identifier for the client.

data.ownerID

string

The owner user/workspace uid associated with the client.

data.orgUsers

object[]

List of organization users.

data.orgUsers.ID

string

The unique identifier for the client.

data.orgUsers.ownerID

string

The owner user/workspace uid associated with the client.

data.orgUsers.orgUsers

object[]

List of organization users.

data.orgUsers.orgUsers.ID

string

The unique identifier for the client.

data.orgUsers.orgUsers.ownerID

string

The owner user/workspace uid associated with the client.

data.orgUsers.orgUsers.orgUsers

object[]

List of organization users.

data.orgUsers.orgUsers.orgId

string

The org ID associated with the client.

data.orgUsers.orgUsers.name

string

The name of the client.

data.orgUsers.orgUsers.squarePhotoURL

string

URL to the square photo of the client.

data.orgUsers.orgUsers.email

string

The email address of the client (used as username to signin on dashboard).

data.orgUsers.orgUsers.dashboardPassword

string

Password for the client's dashboard (used as password to signin on dashboard).

data.orgUsers.orgUsers.canAccess

enum<string>[]

List of hrefs the client can access.

Available options:

/overview,

/home,

/convos,

/analytics,

/kb,

/settings

data.orgUsers.orgUsers.isOrgAdmin

boolean

Indicates if the client is an organization admin.

data.orgUsers.orgUsers.notificationsSettings

object

Notification settings for the client.

data.orgUsers.orgId

string

The org ID associated with the client.

data.orgUsers.name

string

The name of the client.

data.orgUsers.squarePhotoURL

string

URL to the square photo of the client.

data.orgUsers.email

string

The email address of the client (used as username to signin on dashboard).

data.orgUsers.dashboardPassword

string

Password for the client's dashboard (used as password to signin on dashboard).

data.orgUsers.canAccess

enum<string>[]

List of hrefs the client can access.

Available options:

/overview,

/home,

/convos,

/analytics,

/kb,

/settings

data.orgUsers.isOrgAdmin

boolean

Indicates if the client is an organization admin.

data.orgUsers.notificationsSettings

object

Notification settings for the client.

data.orgId

string

The org ID associated with the client.

data.name

string

The name of the client.

data.squarePhotoURL

string

URL to the square photo of the client.

data.email

string

The email address of the client (used as username to signin on dashboard).

data.dashboardPassword

string

Password for the client's dashboard (used as password to signin on dashboard).

data.canAccess

enum<string>[]

List of hrefs the client can access.

Available options:

/overview,

/home,

/convos,

/analytics,

/kb,

/settings

data.isOrgAdmin

boolean

Indicates if the client is an organization admin.

data.notificationsSettings

object

Notification settings for the client.

New Client Edit Client

curl --request GET \
  --url https://eu-vg-edge.moeaymandev.workers.dev/v2/clients/{client_id} \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "Client 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"
    }
  }
}

API Documentation

V3

Agents

Workspaces

Authorizations

Path Parameters

Response