Documentation

List groups

GET/api/bot/groups

Lists all agent groups in your organization. Use group IDs when transferring chats.

Response

200 OK

[
  {
    "id": "grp_sales_001",
    "name": "Sales",
    "agentCount": 5,
    "isDefault": false
  },
  {
    "id": "grp_support_001",
    "name": "Support",
    "agentCount": 12,
    "isDefault": true
  }
]

Response fields

Parameter	Type	Description
`id`	`string`	Unique group identifier
`name`	`string`	Display name of the group
`agentCount`	`number`	Number of agents assigned to this group
`isDefault`	`boolean`	Whether this is the organization’s default group

Default group

There's always exactly one default group. Chats routed without a specific group target go to the default.

Using groups with transfer

terminal

# First, list groups to find the right ID
curl https://app.bx-livechat.com/api/bot/groups \
  -H "Authorization: Bearer bxl_pat_aB7XyZ..."

# Then transfer a chat to that group
curl -X POST https://app.bx-livechat.com/api/bot/transfer \
  -H "Authorization: Bearer bxl_pat_aB7XyZ..." \
  -H "Content-Type: application/json" \
  -d '{
    "chatId": "clxyz1234567890abc",
    "targetGroupId": "grp_sales_001"
  }'

Transfer chat Self-docs