---
title: "GET /work-management/{tenantLocator}/workgroups/list"
method: GET
path: "/work-management/{tenantLocator}/workgroups/list"
---

# GET /work-management/{tenantLocator}/workgroups/list

`GET /work-management/{tenantLocator}/workgroups/list`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/work-management/{tenantLocator}/workgroups/list`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/work-management/:tenantLocator/workgroups/list/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required

## Query parameters

- `user` string, uuid
- `offset` integer
- `count` integer

## Response `200`

OK

- ListPageResponseWorkgroupResponse
  - `listCompleted` boolean, required
  - `items` WorkgroupResponse[], required
    - `locator` string, ulid, required
    - `name` string, required
    - `workgroupState` 'active' | 'discarded', required
    - `subgroups` WorkgroupResponse[], required
    - `users` string[], required
    - `entities` string[], required
    - `tasks` string[], required
    - `parent` string, ulid
    - `region` string
    - `tag` string
    - `createdBy` string, uuid, required
    - `createdAt` string, date-time, required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)