> ## Documentation Index
> Fetch the complete documentation index at: https://sleekplan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List work items

> Returns the workspace's work items, highest priority first. Each row carries its linked posts and votes as totals; fetch the single work item for its brief, posts, evidence, documents and pull requests.

Filters combine. An ID filter that is not a positive whole number matches nothing instead of being ignored, so a typo never widens the list. An unknown `status`, `stage`, `source` or `sort` value is ignored.



## OpenAPI

````yaml /docs/api/openapi-v2.yaml get /work-items
openapi: 3.1.0
info:
  title: Sleekplan API v2
  version: '2.0'
  description: >-
    The `/v2` namespace sits alongside the existing [`/v1`
    API](/docs/api/overview) — it is not a replacement. The same API key
    authenticates both.


    `/v2` accepts **Bearer tokens only**, and carries no workspace ID in the URL
    because the key identifies the workspace. Changes are additive: fields and
    endpoints are added, never removed or renamed.


    See [API v2](/docs/api/v2) for authentication, the error keys, and the rate
    limit.
servers:
  - url: https://api.sleekplan.com/v2
    description: API Version 2
security:
  - BearerAuth: []
tags:
  - name: Group
    description: B2B groups — companies, accounts or teams — and their members.
  - name: Document
    description: >-
      The thinking behind your feedback — a plan, a spec, research, or the
      record of a decision.
  - name: Work item
    description: >-
      What gets worked on next: a brief, evidence and linked posts, moving
      through spec, plan and build.
paths:
  /work-items:
    get:
      tags:
        - Work item
      summary: List work items
      description: >-
        Returns the workspace's work items, highest priority first. Each row
        carries its linked posts and votes as totals; fetch the single work item
        for its brief, posts, evidence, documents and pull requests.


        Filters combine. An ID filter that is not a positive whole number
        matches nothing instead of being ignored, so a typo never widens the
        list. An unknown `status`, `stage`, `source` or `sort` value is ignored.
      operationId: v2-list-work-items
      parameters:
        - in: query
          name: status
          schema:
            type: string
          example: ready,in_progress
          description: >-
            One or more of `needs_decision`, `ready`, `in_progress`,
            `in_review`, `completed`, `held_back`, `closed`, comma-separated.
            Without it, every status.
        - in: query
          name: stage
          schema:
            type: string
            enum:
              - spec
              - plan
              - build
        - in: query
          name: mine
          schema:
            type: integer
            enum:
              - 1
          description: '`1`: only work items the key''s owner owns or is a member of.'
        - in: query
          name: source
          schema:
            type: string
            enum:
              - app
              - api
              - mcp
          description: >-
            Where the work item was created: the dashboard, this API, or an
            agent through the Sleekplan MCP server.
        - in: query
          name: feedback_id
          schema:
            type: integer
          description: >-
            The work item that holds this post. A post belongs to at most one
            work item.
        - in: query
          name: link
          schema:
            type: string
          description: Work items with an evidence entry linking exactly this URL.
        - in: query
          name: search
          schema:
            type: string
            maxLength: 255
          description: >-
            Partial match on the title and the brief. `WI-42` or `42` also finds
            work item 42.
        - in: query
          name: priority_min
          schema:
            type: integer
            minimum: 0
            maximum: 4
          description: Only work items at this priority or higher.
        - in: query
          name: sort
          schema:
            type: string
            default: priority
            enum:
              - priority
              - updated
              - created
          description: Always newest first within the sort.
        - in: query
          name: page
          schema:
            type: integer
            default: 0
        - in: query
          name: per_page
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 30
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/WorkItemListItem'
                      has_more:
                        type: boolean
                      page:
                        type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    WorkItemListItem:
      type: object
      description: >-
        A work item as the list returns it: no brief, and its posts and votes as
        totals.
      properties:
        number:
          type: integer
        key:
          type: string
        title:
          type: string
        priority:
          type: integer
        component:
          type:
            - string
            - 'null'
        status:
          type: string
        status_reason:
          type:
            - string
            - 'null'
        stage:
          type:
            - string
            - 'null'
        goal:
          type:
            - string
            - 'null'
        source:
          type: string
        posts:
          type: integer
        votes:
          type: integer
        active_run:
          type:
            - object
            - 'null'
          description: Who works on it and on which stage, or `null`.
          properties:
            agent:
              type: string
            stage:
              type: string
        created:
          type: string
        updated:
          type: string
    Error:
      type: object
      properties:
        status:
          type: string
          example: error
        data:
          type: object
          properties:
            key:
              type: string
            message:
              type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or non-API-key credential
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The key's user lacks the permission for this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Over 300 requests in 60 seconds
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: '`Authorization: Bearer YOUR_API_KEY`. /v2 accepts no other method.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.