For AI agents: markdown of this page — /docs-content-en/entities/workgroups/list.md documentation index — /llms.txt

List workgroups

GET /v1/workgroups

Returns a list of Bitrix24 account workgroups with support for filtering, sorting and automatic pagination.

Parameters

Parameter Type Req. Default Description
filter (query) object no — Filtering by fields from GET /v1/workgroups/fields.
Filtering syntax. Example: ?filter[archived]=N
select (query) array no — List of fields in the response. Names — from GET /v1/workgroups/fields.
sort (query) object no — Sorting: sort[<field>]=ASC|DESC. Example: ?sort[dateCreate]=DESC.
limit (query) number no 50 Maximum records in the response. Up to 5000 allowed.
offset (query) number no 0 Offset from the start of the selection.

For limit > 50 Vibecode automatically paginates the request on the server side. The maximum is 5000 records per call. If more match the filter — meta.hasMore will be true.

Get projects only

A single collection stores both workgroups and projects. The isProject field distinguishes them: true — a project, false — an ordinary workgroup. To select projects, pass filter[isProject]=Y.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/workgroups?limit=3" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/workgroups?limit=3" \
  -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?limit=3', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Found ${meta.total} workgroups`)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/workgroups?limit=3', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
success boolean Always true on success
data array Array of workgroups (all fields — see Workgroup fields)
meta.total number Total number of records matching the filter
meta.hasMore boolean Whether there are more records beyond limit

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 85,
      "siteId": "s1",
      "name": "Marketing 2026",
      "description": null,
      "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
    },
    {
      "id": 83,
      "siteId": "s1",
      "name": "New product development team",
      "description": null,
      "dateCreate": "2026-03-20T06:41:07.000Z",
      "dateUpdate": "2026-03-20T06:41:07.000Z",
      "active": true,
      "visible": true,
      "opened": false,
      "archived": false,
      "subjectId": 1,
      "ownerId": 1269,
      "keywords": null,
      "membersCount": 1,
      "dateActivity": "2026-03-20T06:41:07.000Z",
      "subjectName": "Workgroups",
      "isProject": true,
      "imageUrl": "https://cdn-ru.bitrix24.com/example/disk/avatar.jpg",
      "isExtranet": false
    },
    {
      "id": 81,
      "siteId": "s1",
      "name": "Regional office launch",
      "description": null,
      "dateCreate": "2026-03-20T06:29:07.000Z",
      "dateUpdate": "2026-03-20T06:29:07.000Z",
      "active": true,
      "visible": true,
      "opened": false,
      "archived": false,
      "subjectId": 1,
      "ownerId": 1271,
      "keywords": null,
      "membersCount": 1,
      "dateActivity": "2026-03-20T06:29:07.000Z",
      "subjectName": "Workgroups",
      "isProject": true,
      "isExtranet": false
    }
  ],
  "meta": {
    "total": 33,
    "hasMore": true
  }
}

Error response example

401 — no authorization key:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Errors

HTTP Code Description
401 MISSING_API_KEY The X-Api-Key header was not passed
401 INVALID_API_KEY The provided key was not recognized
403 SCOPE_DENIED The key is missing the sonet_group scope
429 RATE_LIMITED Request limit exceeded

Full list of common API errors — Errors.

Known specifics

Boolean fields in the filter accept Y / N. In the response the same fields come back as true / false, but when filtering use filter[active]=Y / filter[archived]=N. The values true / false in the filter will not produce matches and will not raise an error.

A % prefix in the field name — substring search. ?filter[%name]=Marketing will find all groups whose name contains "Marketing". Without the prefix the filter requires an exact match.

limit = 0 returns all records, not an empty array. For an empty selection use a filter that is guaranteed to find nothing.

See also