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

# List projects

`GET /v1/projects`

## Request

- Base URL: `https://api.ybug.io`
- URL: `https://api.ybug.io/v1/projects`
- Auth: HTTP bearer

Retrieves a paginated list of projects available to the API token across all teams. Use the `archived` query parameter to switch between active and archived projects.

## Query parameters

- `page` integer
- `page_size` integer
- `archived` boolean

## Response `200`

Successful retrieval of the list of projects.

- ProjectList
  - `projects` Project[]
    - `id` string
    - `name` string
    - `status` 'active' | 'archived'
    - `team_id` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `is_widget_installed` boolean
  - `meta` PaginationMeta: Metadata for the paginated response.
    - `total_count` integer: The total number of items available across all pages.
    - `page` integer: The current page number being returned (starts at 1).
    - `page_size` integer: Number of items per page (25 by default, max 100).
    - `last_page` boolean: True if this is the final page of results.

## Other responses

- `401`: Unauthorized. Missing or invalid API token.
- `403`: Forbidden. The user does not have permission to access the resource, or the operation is restricted by the account plan.
- `429`: Too Many Requests. The rate limit for the client has been exceeded.
- `500`: Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/ybug/apis/ybug-api.md) · [All operations](https://skmtc.dev/ybug/apis/ybug-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ybug/apis/ybug-api/revisions/50f50cb05459?raw)