---
title: "List deliverables"
method: GET
path: "/deliverables"
tags: ["Planning"]
---

# List deliverables

`GET /deliverables`

## Request

- Base URL: `https://app.pencil.ink/api/v1`
- URL: `https://app.pencil.ink/api/v1/deliverables`
- Auth: HTTP bearer

## Query parameters

- `projectId` string
- `iterationId` string
- `status` string
- `limit` integer
- `cursor` string

## Response `200`

A page of resources.

- object
  - `data` DurableObject[]
    - `id` string
    - `displayId` union
      - string
      - number
    - `name` string
    - `title` string
    - `status` string
    - `kind` 'requirement' | 'user_story': Requirement subtype. Legacy rows are returned as requirement.
    - `personaId` string, nullable
    - `storyActor` string, nullable
    - `storyGoal` string, nullable
    - `storyBenefit` string, nullable
    - `acceptanceCriteria` string[]
    - `storySentence` string, nullable
    - `createdAt` integer, nullable: Epoch ms.
    - `updatedAt` integer, nullable: Epoch ms.
  - `pagination` Pagination
    - `nextCursor` string, nullable: Cursor for the next page, or null when there are no more results.
    - `hasMore` boolean

## Other responses

- `400`: Malformed request or invalid field (`validation_error`).
- `401`: Missing or invalid API key (`unauthorized`).
- `429`: Rate limit exceeded (`rate_limited`).

---

[API](https://skmtc.dev/pencil/apis/pencil-public-api.md) · [All operations](https://skmtc.dev/pencil/apis/pencil-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pencil/apis/pencil-public-api/revisions/2b842698b76d?raw)