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

# Read a project

`GET /projects/{id}`

## Request

- Base URL: `https://app.vulk.dev/api/v1`
- URL: `https://app.vulk.dev/api/v1/projects/{id}`
- Auth: HTTP bearer

Scope `projects.read`.

## Response `200`

The project, its versions and its addresses.

- Project: `versions` counts the builds; `files` and `bytes` describe the latest one. `siteName` and `liveUrl` are set once the project is published.
  - `id` string, required
  - `title` string, required
  - `folder` string, required
  - `versions` integer, required
  - `versionsWithFiles` integer, required
  - `files` integer, required
  - `bytes` integer, required
  - `lastVersionStatus` string, required: A word such as `delivered` or `failed`.
  - `lastVersionError` string, nullable: An error code when the last version failed.
  - `siteName` string, nullable
  - `previewUrl` string, uri, nullable
  - `liveUrl` string, uri, nullable
  - `url` string, uri, required: The project's page in the editor.

## Other responses

- `401`: No key, a malformed key, or a revoked or expired one (code UNAUTHORIZED).
- `403`: The key lacks the scope the endpoint needs (code FORBIDDEN).
- `404`: No such endpoint, project, operation or file on this account (code NOT_FOUND).
- `429`: Over 60 requests in a minute; wait `retryAfter` seconds (code RATE_LIMITED).

---

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