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

# List projects

`GET /projects`

## Request

- Base URL: `https://api.rendley.com/v1`
- URL: `https://api.rendley.com/v1/projects`
- Auth: API key in header `Authorization`

List all projects in a workspace.

## Query parameters

- `workspace_id` string
- `page` integer
- `limit` integer
- `sort` string

## Response `200`

OK

- object
  - `data` TypesProject[]: Success data
    - `agent_prompt` string: Handoff prompt the editor prefills into the assistant; cleared on send.
    - `agent_skill` string: Handoff workflow skill (a name from GET /agent/skills) the editor pre-selects in the assistant's skill picker alongside AgentPrompt.
    - `created_at` string
    - `created_by` string
    - `deleted_at` string
    - `fit_duration` number
    - `id` string
    - `last_viewed_at` string
    - `name` string
    - `project_json` string
    - `template` TypesTemplateDefinition
      - `fields` TypesTemplateFieldDefinition[]
        - `alias` string: Name the author gave the field in the editor.
        - `clip_id` string: Clip a media field was promoted from.
        - `group` string: The clip, media or canvas the field belongs to.
        - `key` string: Name in POST /projects `fields`; the path when unset.
        - `label` string
        - `path` string, required: Document path, e.g. clips.<id>.text or media.<id>.url.
        - `property_id` string: Editor panel field and right-sidebar step that render it.
        - `step` string
      - `version` integer
    - `template_mode` boolean: Set on projects started from a template: the editor opens the fields form.
    - `thumbnail_url` string
    - `updated_at` string
    - `version` integer
    - `workspace_id` string
  - `error` HttpResponseAPIError
    - `code` string
    - `fields` HttpResponseFieldError[]
      - `field` string
      - `message` string
    - `message` string
  - `meta` unknown

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/rendley/apis/rendley-api.md) - [All operations](https://skmtc.dev/rendley/apis/rendley-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rendley/apis/rendley-api/revisions/7eb8713bbf78?raw)