List and Retrieve Workspace Members via ChatbotX API

Workspace members are the agents and administrators who have access to your ChatbotX workspace. This page covers two endpoints: listing all members in the workspace (with pagination and keyword search) and fetching a single member by their unique ID. Each member record includes their user profile, role, and granular permission settings.

List Workspace Members

Retrieve a paginated list of all members in your workspace.

GET /api/v1/members

Query Parameters

integer

The page number to retrieve. Must be 1 or greater.

integer

Number of members to return per page. Must be 1 or greater.

string

Filter members by name or email address.

Code Examples

curl --request GET \
  --url 'https://app.chatbotx.io/api/v1/members?page=1&perPage=20' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.chatbotx.io/api/v1/members"

params = {"page": 1, "perPage": 20}
headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, params=params, headers=headers)
print(response.json())

const options = {
  method: 'GET',
  headers: { Authorization: 'Bearer <token>' }
};

fetch('https://app.chatbotx.io/api/v1/members?page=1&perPage=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 200 OK with a data array of member objects and a pageCount.

array

required

Array of workspace member objects.

Show data item fields

string

required

Unique identifier for the workspace membership record.

string

required

The ID of the workspace this membership belongs to.

string

required

The ID of the user account associated with this member.

object

required

Granular permission flags for the member. Includes superAdmin, analytics, flows, contacts, onlyAssignedContacts, emailAndPhone, broadcast, and ecommerce.

object

required

The user’s profile details including id, name, and image.

string

required

ISO 8601 timestamp for when the member was added to the workspace.

string

required

ISO 8601 timestamp for when the member record was last updated.

number

required

Total number of pages available for the current perPage value.

Example Response

{
  "data": [
    {
      "id": "mem_001",
      "workspaceId": "42",
      "userId": "usr_agent_01",
      "permissions": {
        "superAdmin": false,
        "analytics": true,
        "flows": true,
        "contacts": true,
        "onlyAssignedContacts": false,
        "emailAndPhone": true,
        "broadcast": true,
        "ecommerce": false
      },
      "user": {
        "id": "usr_agent_01",
        "name": "Jane Smith",
        "image": "https://cdn.chatbotx.io/avatars/jane.png"
      },
      "createdAt": "2023-06-01T08:00:00Z",
      "updatedAt": "2024-01-10T09:30:00Z"
    }
  ],
  "pageCount": 2
}

Get Member by ID

Retrieve the full profile and permissions for a single workspace member.

GET /api/v1/members/{memberId}

Path Parameters

string

required

The numeric ID of the workspace member to retrieve. Must match the pattern \d+.

Code Examples

curl --request GET \
  --url https://app.chatbotx.io/api/v1/members/mem_001 \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.chatbotx.io/api/v1/members/mem_001"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)
print(response.json())

const options = {
  method: 'GET',
  headers: { Authorization: 'Bearer <token>' }
};

fetch('https://app.chatbotx.io/api/v1/members/mem_001', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 200 OK with a single member object.

string

required

Unique identifier for the workspace membership record.

string

required

The workspace this member belongs to.

string

required

The associated user account ID.

string

required

The member’s role in the workspace. One of owner or agent.

object

required

Granular permission flags. Includes superAdmin, analytics, flows, contacts, onlyAssignedContacts, emailAndPhone, broadcast, and ecommerce.

object

required

The user’s profile including id, name, and image.

string

required

ISO 8601 timestamp for when the member was added.

string

required

ISO 8601 timestamp for when the member record was last modified.

Example Response

{
  "id": "mem_001",
  "workspaceId": "42",
  "userId": "usr_agent_01",
  "role": "agent",
  "permissions": {
    "superAdmin": false,
    "analytics": true,
    "flows": true,
    "contacts": true,
    "onlyAssignedContacts": false,
    "emailAndPhone": true,
    "broadcast": true,
    "ecommerce": false
  },
  "user": {
    "id": "usr_agent_01",
    "name": "Jane Smith",
    "image": "https://cdn.chatbotx.io/avatars/jane.png"
  },
  "createdAt": "2023-06-01T08:00:00Z",
  "updatedAt": "2024-01-10T09:30:00Z"
}

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

List and Retrieve Workspace Members via ChatbotX API

List Workspace Members

Query Parameters

Code Examples

Response

Example Response

Get Member by ID

Path Parameters

Code Examples

Response

Example Response

​List Workspace Members

​Query Parameters

​Code Examples

​Response

​Example Response

​Get Member by ID

​Path Parameters

​Code Examples

​Response

​Example Response

List Workspace Members

Query Parameters

Code Examples

Response

Example Response

Get Member by ID

Path Parameters

Code Examples

Response

Example Response