---
title: "List ideas"
method: GET
path: "/ideas"
tags: ["Ideas"]
---

# List ideas

`GET /ideas`

## Request

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

Requires a `read` (or `write`) key.

## Query parameters

- `status` 'open' | 'planning' | 'promoted' | 'archived'
- `customerId` string
- `limit` integer
- `cursor` string

## Response `200`

A page of ideas.

- object
  - `data` Idea[]
    - `id` string
    - `title` string
    - `summary` string, nullable
    - `status` 'open' | 'planning' | 'promoted' | 'archived'
    - `projectId` string, nullable
    - `productId` string, nullable
    - `customerId` string, nullable
    - `featureId` string, nullable
    - `tags` string[]
    - `promotedTaskCount` integer
    - `createdAt` integer: 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)