## List participants

`GET /v1/bots/:botId/chats/:dialogId/users`

Returns the list of chat participants. The bot must be a participant of the chat.

## Parameters

| Parameter | Type | Required | Default | Description |
|----------|-----|:-----:|-----------|---------|
| `botId` (path) | number | yes | — | Bot ID. List: [`GET /v1/bots`](/docs/bots/management/list) |
| `dialogId` (path) | string | yes | — | Group chat ID in the form `chatXXX`. It arrives in the `data.chat.dialogId` field of the [`POST /v1/bots/:botId/chats`](/docs/bots/chats/create) response and in the `chat.dialogId` field of [bot events](/docs/bots/events/bot-events) |
| `limit` (query) | number | no | `50` | Number of records (1-200) |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/bots/42/chats/chat456/users?limit=100" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/bots/42/chats/chat456/users?limit=100" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/bots/42/chats/chat456/users?limit=100', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Participants:', data.length)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/bots/42/chats/chat456/users?limit=100', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of participants |
| `data[].id` | number | User ID |
| `data[].active` | boolean | Whether the account is active |
| `data[].name` | string | Full name |
| `data[].firstName` | string | First name |
| `data[].lastName` | string | Last name. An empty string if not set |
| `data[].workPosition` | string | Job title. An empty string if not set |
| `data[].color` | string | Avatar color in HEX format, for example `#29619b` |
| `data[].avatar` | string | Avatar URL. An empty string if no avatar is set |
| `data[].gender` | string | Gender: `M` — male, `F` — female, an empty string — not specified |
| `data[].birthday` | string | Date of birth. An empty string if not specified |
| `data[].extranet` | boolean | Whether the user is an external user of the `extranet` type |
| `data[].bot` | boolean | Whether the user is a bot |
| `data[].connector` | boolean | Open Channels user |
| `data[].externalAuthId` | string | External authentication code of the account. `bot` for a bot |
| `data[].internalAccount` | boolean | Whether this is an internal account in Bitrix24. `false` for a bot |
| `data[].intranetUser` | boolean | Employee of the Bitrix24 account. `false` for a bot |
| `data[].status` | string | Status: `online`, `away`, `dnd` |
| `data[].idle` | boolean | Whether the user is idle |
| `data[].lastActivityDate` | string \| false | Time of the last activity in ISO 8601 format. `false` if there was no activity |
| `data[].mobileLastDate` | string \| false | Time of the last sign-in from the mobile app. `false` if there was none |
| `data[].desktopLastDate` | string \| false | Time of the last sign-in from the desktop app. `false` if there was none |
| `data[].absent` | boolean \| string | `false` or the date the absence ends |
| `data[].departments` | number[] | Department IDs. List: `GET /v1/departments`. An empty array for a bot |
| `data[].phones` | object \| false | Phone numbers. Keys are `work_phone`, `personal_mobile`, `inner_phone`, and the object holds only the filled ones. `false` if there are no phone numbers |
| `data[].type` | string | User type: `user`, `bot`, `extranet` |
| `data[].website` | string | Website. An empty string if not specified |
| `data[].email` | string | Email. An empty string if not specified |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "active": true,
      "name": "John Smith",
      "firstName": "John",
      "lastName": "Smith",
      "workPosition": "Manager",
      "color": "#df532d",
      "avatar": "",
      "gender": "M",
      "birthday": "",
      "extranet": false,
      "bot": false,
      "connector": false,
      "externalAuthId": "socservices",
      "internalAccount": true,
      "intranetUser": true,
      "status": "online",
      "idle": false,
      "lastActivityDate": "2026-10-14T15:44:48+00:00",
      "mobileLastDate": false,
      "desktopLastDate": false,
      "absent": false,
      "departments": [1, 47],
      "phones": {
        "personal_mobile": "10000000000",
        "inner_phone": "111"
      },
      "type": "user",
      "website": "",
      "email": "user@example.com"
    },
    {
      "id": 42,
      "active": true,
      "name": "Support",
      "firstName": "Support",
      "lastName": "",
      "workPosition": "Chatbot",
      "color": "#58cc47",
      "avatar": "",
      "gender": "M",
      "birthday": "",
      "extranet": false,
      "bot": true,
      "connector": false,
      "externalAuthId": "bot",
      "internalAccount": false,
      "intranetUser": false,
      "status": "online",
      "idle": false,
      "lastActivityDate": false,
      "mobileLastDate": false,
      "desktopLastDate": false,
      "absent": false,
      "departments": [],
      "phones": false,
      "type": "bot",
      "website": "",
      "email": ""
    }
  ]
}
```

## Error response example

403 — the bot is not a participant of the chat:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Access denied"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `INVALID_BOT_ID` | `botId` is not a number |
| 404 | `BOT_NOT_FOUND` | No bot found with this ID |
| 403 | `BOT_ACCESS_DENIED` | The bot belongs to another API key |
| 403 | `BITRIX_ACCESS_DENIED` | The bot is not a participant of the chat |
| 422 | `BITRIX_ERROR` | Another Bitrix24 error, text in `message` |
| 403 | `SCOPE_DENIED` | The API key does not have the `imbot` scope |
| 410 | `BOT_DISABLED` | The bot is disabled and does not process API calls. How to restore it — [Bot disabled](/docs/bots/troubleshooting#bot-disabled-bot_disabled) |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [Add participants](/docs/bots/chats/user-add)
- [Remove a participant](/docs/bots/chats/user-delete)
- [Add managers](/docs/bots/chats/manager-add)
- [Bot platform](/docs/bots)
- [Limits and optimization](/docs/optimization)