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

# List Projects

`GET /projects`

## Query parameters

- `search` string — Search string to find projects
- `ids` string[] — The ID of a project to search for
- `names` string[] — The name of the project
- `owner` string[] — Owner of the project
- `public` boolean — Boolean check for public/private projects
- `permissions` string[] — Filter by permission on given resource
- `sort_by` 'created_at' | 'updated_at' | 'name' — An enumeration.
- `sort_order` 'ascending' | 'descending' — An enumeration.
- `page` integer — Page number starting from 1
- `per-page` integer — Number of items per page

## Response `200`

Retrieved

- ProjectList — A list response from a pagination request
  - `page` integer, required — The current page the pagination request is on
  - `per_page` integer, required — The number of pages per pagination request
  - `next_page` integer — The next page, if this on is not the last
  - `page_count` integer, required — The total number of pages
  - `total_count` integer, required — The total number of resources matching the list request
  - `resources` Project[], required
    - `name` string, required — The name of the project. Must be unique to a given owner
    - `description` string — A description of the project
    - `public` boolean — Whether or not a project is publicly viewable
    - `id` string, required — The project ID
    - `owner` AccountPublic, required
      - `id` string, required
      - `account_type` string, required
      - `name` string, required
      - `display_name` string
      - `description` string
      - `picture_url` string — https://robohash.org/ladybugbot
    - `permissions` UserPermission, required
      - `admin` boolean — The user has admin permission to this resource
      - `write` boolean — The user has write permission on this resource
      - `read` boolean — The user has read permission on this resource
    - `slug` string, required — The project name in slug format
    - `usage` Usage
      - `start` string, date-time, required — The start date for this usage aggregation
      - `end` string, date-time, required — The end date for this usage aggregation
      - `cpu` number — cpu usage
      - `memory` number — memory usage
      - `succeeded` integer — succeeded usage
      - `failed` integer — failed usage
      - `daily_usage` DailyUsage[] — daily breakdown of usage
        - `date` string, date-time, required — The day this usage was aggregated for
        - `cpu` number — cpu usage
        - `memory` number — memory usage
        - `succeeded` integer — succeeded usage
        - `failed` integer — failed usage

## Other responses

- `400` — Invalid request
- `403` — Access forbidden
- `422` — Validation Error
- `500` — Server error

---

[API](https://skmtc.net/pollination/apis/pollination-server.md) · [All operations](https://skmtc.net/pollination/apis/pollination-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pollination/pollination-server/revisions/c1f3c6d96b31/schema)