---
title: "Get project"
method: GET
path: "/api/projects/{id}"
tags: ["Projects"]
---

# Get project

`GET /api/projects/{id}`

## Request

- Base URL: `https://api.zvid.io`
- URL: `https://api.zvid.io/api/projects/{id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Get a draft project by ID, including its full project JSON.

## Path parameters

- `id` string, required

## Response `200`

Project found

- object
  - `project` Project, required: An editor draft project, including its full project JSON. Open it in the visual editor at https://editor.zvid.io?project=<id>.
    - `id` string, required
    - `userId` integer
    - `name` string, required
    - `payload` RenderPayload (unresolved $ref)
    - `type` 'video' | 'image', required: Derived from the stored payload's type
    - `version` integer, required: Incremented on every update
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `400`: Invalid project ID
- `401`: Unauthorized
- `404`: Project not found

---

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