Sub-User Management

List sub-users

Returns a list of all sub-users of your workspace's company. Each sub-user includes its assigned chatbots' names, not just their IDs. The response is an empty array when the workspace has no SSO company.

Requires the SSO Login add-on (see plans) and a workspace API key; without the add-on, or with a chatbot-scoped key, the request gets a 403.

get/sub-users

Request

  • Base URL: https://api.chat-data.com/api/v2
  • URL: https://api.chat-data.com/api/v2/sub-users
  • Auth: HTTP bearer

Response

Successful response.

_idstring required

The unique identifier of the sub-user.

companystring required

The ID of the company this sub-user belongs to.

emailstring email required

The sub-user's email address.

namestring

The sub-user's display name.

avatarstring

URL of the sub-user's avatar image, or an empty string if none is set.

permissionsstring[] required

Permissions granted to this sub-user.

analyticsDashboardSectionsstring[]

Analytics dashboard sections visible to this sub-user.

hasPasswordboolean required

Whether the sub-user has a password configured (the actual password is never returned).

hasGoogleboolean required

Whether the sub-user has signed in with a linked Google account (the Google ID is never returned). It stays false when Google sign-in is only enabled.

createdAtstring date-time

Timestamp when the sub-user was created.

lastLoginAtstring date-time

Timestamp of the sub-user's last sign-in. Absent until they first sign in.

Example response

[
  {
    "_id": "6650f1c2a9e4b83d2c7a1f9a",
    "company": "6650f1c2a9e4b83d2c7a1f3c",
    "email": "jane@chat-data.com",
    "name": "Jane Doe",
    "avatar": "https://example.blob.core.windows.net/chatfiles/6650f1c2a9e4b83d2c7a1f9a/avatar.png",
    "chatbotIds": [
      {
        "_id": "6650f1c2a9e4b83d2c7a1f05",
        "name": "Support Bot"
      },
      {
        "_id": "6650f1c2a9e4b83d2c7a1f06",
        "name": "Sales Assistant"
      }
    ],
    "permissions": [
      "read",
      "train"
    ],
    "analyticsDashboardSections": [
      "Overview",
      "Messages Timeline",
      "Chats"
    ],
    "hasPassword": true,
    "createdAt": "2026-10-14T09:30:00.000Z",
    "lastLoginAt": "2026-10-14T10:15:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.