List Workspace Agent Teams via the ChatbotX REST API

Teams in ChatbotX let you group agents together so they can be assigned to conversations collectively. Use this endpoint to list all teams in your workspace. Each team record includes its members along with their user profile details, making it easy to understand your support team structure programmatically.

GET /api/v1/teams

Code Examples

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

import requests

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

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/teams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 200 OK with a data array of team objects.

Response Fields

array

required

Array of team objects in the workspace.

Show data item fields

string

required

Unique identifier for the team.

string

required

Display name of the team.

string

required

The workspace this team belongs to.

array

required

Array of team membership records, each containing:

id — unique membership record ID
inboxTeamId — the team this record belongs to
userId — the ID of the user
user — the user’s full profile, including id, name, email, image, emailVerified, and isAnonymous

string

required

ISO 8601 timestamp for when the team was created.

string

required

ISO 8601 timestamp for when the team was last updated.

Example Response

{
  "data": [
    {
      "id": "team_001",
      "name": "Technical Support",
      "workspaceId": "42",
      "createdAt": "2023-03-10T07:00:00Z",
      "updatedAt": "2024-02-01T11:00:00Z",
      "inboxTeamMembers": [
        {
          "id": "tm_001",
          "inboxTeamId": "team_001",
          "userId": "usr_agent_01",
          "user": {
            "id": "usr_agent_01",
            "name": "Jane Smith",
            "email": "jane@acme.com",
            "image": "https://cdn.chatbotx.io/avatars/jane.png",
            "emailVerified": true,
            "isAnonymous": false,
            "createdAt": "2023-01-20T08:00:00Z",
            "updatedAt": "2024-01-10T09:30:00Z"
          }
        }
      ]
    }
  ]
}

⌘I

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

List Workspace Agent Teams via the ChatbotX REST API

Code Examples

Response

Response Fields

Example Response

​Code Examples

​Response

​Response Fields

​Example Response

Code Examples

Response

Response Fields

Example Response