## Get a workgroup

`GET /v1/workgroups/:id`

Returns a workgroup by identifier with all its fields.

## Parameters

| Parameter | Type | Req. | Default | Description |
|----------|-----|:-----:|-----------|---------|
| `id` (path) | number | ★ yes | — | Workgroup identifier. List: [`GET /v1/workgroups`](./list.md) |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/workgroups/85" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/workgroups/85" \
  -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/workgroups/85', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Group:', data.name, '— members:', data.membersCount)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/workgroups/85', {
  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.id` | number | Workgroup identifier (read-only) |
| `data.name` | string | Name |
| `data.description` | string \| null | Description |
| `data.active` | boolean | Whether the group is active |
| `data.visible` | boolean | Whether the group is visible in shared lists |
| `data.opened` | boolean | Whether it is open for joining without an invitation |
| `data.ownerId` | number | Owner (responsible person) identifier. List: [`GET /v1/users`](/docs/entities/users) |
| `data.subjectId` | number | Subject identifier |
| `data.subjectName` | string | Subject name (read-only) |
| `data.membersCount` | number | Number of members (read-only) |
| `data.dateCreate` | string | Creation date, ISO 8601 (read-only) |
| `data.dateUpdate` | string | Last update date, ISO 8601 (read-only) |
| `data.dateActivity` | string | Last activity date, ISO 8601 (read-only) |
| `data.archived` | boolean | Whether it is archived |
| `data.isProject` | boolean | Whether it is a project with tasks and deadlines |
| `data.isExtranet` | boolean | Extranet group — with access for external users |
| `data.keywords` | string \| null | Keywords |
| `data.siteId` | string | Bitrix24 account site identifier, for the main site — `s1` (read-only) |
| `data.imageUrl` | string \| null | Group avatar URL (read-only) |

## Response example

```json
{
  "success": true,
  "data": {
    "id": 85,
    "siteId": "s1",
    "name": "New product development team",
    "description": "Internal infrastructure project",
    "dateCreate": "2026-03-20T06:45:10.000Z",
    "dateUpdate": "2026-03-20T06:45:10.000Z",
    "active": true,
    "visible": true,
    "opened": false,
    "archived": false,
    "subjectId": 1,
    "ownerId": 1271,
    "keywords": null,
    "membersCount": 2,
    "dateActivity": "2026-03-20T06:45:10.000Z",
    "subjectName": "Workgroups",
    "isProject": true,
    "isExtranet": false,
    "imageUrl": null
  }
}
```

## Error response example

404 — a workgroup with this id does not exist:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "workgroup 999999 not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | A workgroup with the specified `id` was not found |
| 401 | `MISSING_API_KEY` | `X-Api-Key` was not passed |
| 401 | `INVALID_API_KEY` | An invalid key was passed |
| 403 | `SCOPE_DENIED` | The key is missing the `sonet_group` scope |

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

## Known specifics

- A non-numeric `id` (for example `abc`) returns `404 ENTITY_NOT_FOUND`, not `400` — take this into account when handling validation errors on the client.
- To change a workgroup's subject, pass a numeric `subjectId` in [`PATCH /v1/workgroups/:id`](./update.md). The `subjectName` field is read-only — an attempt to pass it in the PATCH body returns `400 READONLY_FIELD`.

## See also

- [List workgroups](./list.md)
- [Create a workgroup](./create.md)
- [Update a workgroup](./update.md)
- [Delete a workgroup](./delete.md)
- [Workgroup fields](./fields.md)