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

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

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

## Request

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

## Path parameters

- `tenantLocator` string, uuid, required

## Query parameters

- `offset` integer
- `count` integer

## Response `200`

OK

- ListPageResponseWorkplan
  - `listCompleted` boolean, required
  - `items` Workplan[], required
    - `locator` string, ulid, required
    - `name` string, required
    - `workplanState` 'active' | 'discarded', required
    - `items` WorkplanItem[], required
      - `locator` string, ulid, required
      - `associationRole` string
      - `task` TaskCreateRequest
        - `type` string, required
        - `deadlineTime` string, date-time
        - `references` TaskReference[], required
          - `referenceType` 'account' | 'quickQuote' | 'quote' | 'policy' | 'transaction' | 'invoice' | 'underwritingFlag' | 'payment' | 'quoteGroup' | 'inquiry', required
          - `referenceLocator` string, ulid, required
        - `underwritingFlagLocators` string[], required
        - `assignedTo` string, uuid
        - `description` string
        - `source` string
        - `tag` string
        - `labels` string[], required
      - `defaultGroup` string
      - `referenceType` 'account' | 'quickQuote' | 'quote' | 'policy' | 'transaction' | 'invoice' | 'underwritingFlag' | 'payment' | 'quoteGroup' | 'inquiry', required
      - `referenceLocator` string, ulid, required
      - `traversal` 'depthFirst' | 'breadthFirst' | 'none', required
      - `assignToGroup` 'never' | 'ifNotAssigned' | 'always', required
    - `defaultGroup` 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)