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

# List projects

`GET /projects`

## Request

- Base URL: `https://api.grapesjs.com/v1`
- URL: `https://api.grapesjs.com/v1/projects`
- Auth: HTTP bearer

Returns projects with page-based pagination.

## Query parameters

- `page` integer
- `pageSize` integer
- `type` 'web' | 'email'
- `isTemplate` boolean

## Response `200`

Projects listed successfully

- ListProjectsResult
  - `items` ProjectSummary[], required: Projects in the current page.
    - `id` string, required: Project ID.
    - `name` string, required: Project name.
    - `description` string, nullable, required: Short project description.
    - `type` 'web' | 'email', required
    - `isTemplate` boolean, required: Whether the project is marked as a template.
    - `createdAt` string, date-time, required: Project creation date and time.
    - `updatedAt` string, date-time, required: Last project update date and time.
    - `previewUrl` string, nullable: URL of the project preview image.
    - `publishedUrl` string, nullable: Published project URL. `null` means the project is not published.
    - `lastPublishedAt` string, date-time, nullable, required: Last publish date and time.
  - `total` integer, required: Total number of matching projects.
  - `page` integer, required: Current page index.
  - `pageSize` integer, required: Number of items per page.

## Other responses

- `400`: Invalid request
- `401`: Unauthorized
- `500`: Server error

---

[API](https://skmtc.dev/grapesjs/apis/studio-platform-api.md) - [All operations](https://skmtc.dev/grapesjs/apis/studio-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/grapesjs/apis/studio-platform-api/revisions/acc4ffe35e2d?raw)
