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

# List Projects

`GET /project`

## Request

- Base URL: `https://api.faable.com`
- URL: `https://api.faable.com/project`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://faable.auth.faable.link/authorize`, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - HTTP basic
  - API key in query parameter `apikey`

List Projects

## Query parameters

- `pageSize` number
- `cursor` string
- `next` string
- `count` boolean
- `query` string
- `q` string

## Response `200`

Default Response

- object
  - `next` string, required
  - `results` Project[], required
    - `id` string, required: Project ID
    - `name` string, required
    - `description` string, required
    - `slug` string, required
    - `team` string, required
    - `user_id` string
    - `collaborators` string[], required
    - `members` object[]
      - `user_id` string, required
      - `role` string, required
    - `product_intent` union
      - 'deploy'
      - 'auth'
      - 'undecided'
    - `owner_suspended` boolean
    - `owner_email` string
    - `organization` string, nullable
    - `createdAt` string, required: Project creation date
    - `updatedAt` string: Project updated date
  - `total` integer: Rows matching the whole filter, across every page. Only with `?count=true`.

## Other responses

- `400`: `invalid_query` — The `?query=` FaableQL expression could not be parsed. `invalid_expand` — An `?expand=` path is not allowed on this resource. `search_not_supported` — This resource does not support `?q=`. `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
- `401`: `team_or_scope_required` — Listing needs either a project in the `x-faable-project` header or a global scope on the token. `unauthorized` — The request carries no valid credentials. `invalid_token` — The bearer token is missing, malformed or expired.
- `403`: `forbidden` — The credentials are valid but do not allow this operation. `user_suspended` — The account is suspended. Contact support@faable.com.
- `429`: `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header.
- `500`: `internal_error` — Unexpected server error. Retry later; the request id is logged.
- `503`: `database_unavailable` — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.

---

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