Skip to main content
GET
Get a project

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

project_id
string
required

Query Parameters

view
enum<string>
default:summary

How much of a project to return from GET /v1/projects/{id}.

Available options:
summary,
full

Response

Successful Response

A project. render_request is populated only for view=full.

id
string
required

Unique project id.

Example:

"proj_01J8QR2K5VKDGN2T4FBM3CZYX7"

name
string
required

Display name.

Example:

"Launch teaser"

version
integer
required

Head version. Bumped on every applied ops batch.

Example:

3

workspace_id
string
required

Owning workspace id.

created_at
string<date-time>
required
updated_at
string<date-time>
required
summary
ProjectSummary · object
required

Compact, always-present view of the head composition.

render_request
RenderRequest · object | null

The full head composition. Present only when requested with view=full.