---
title: "List projects"
method: GET
path: "/projects"
tags: ["Projects"]
---

# List projects

`GET /projects`

## Request

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

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

## Query parameters

- `status` 'active' | 'paused' | 'on_hold' | 'completed' | 'archived'
- `limit` integer
- `cursor` string

## Response `200`

A page of projects.

- object
  - `data` Project[]
    - `id` string
    - `name` string
    - `description` string, nullable
    - `status` 'active' | 'paused' | 'on_hold' | 'completed' | 'archived'
    - `projectType` 'kanban' | 'content'
    - `dueDate` integer, nullable: Epoch ms.
    - `leadAgentId` string, nullable
    - `productId` string, nullable
    - `taskCount` 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)