API Reference

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve project

$client->projects->retrieve(string project): Project

GET/v0/projects/{project}

Retrieve a project by name.

ParametersExpand Collapse

project: string

ReturnsExpand Collapse

Project

string configRepo

?string displayName

Object_ object

string org

string slug

list<Target> targets

Retrieve project

PHP

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'staging');

$project = $client->projects->retrieve(project: 'project');

var_dump($project);

200 example

{
  "config_repo": "config_repo",
  "display_name": "display_name",
  "object": "project",
  "org": "org",
  "slug": "slug",
  "targets": [
    "node"
  ]
}

Returns Examples

200 example

{
  "config_repo": "config_repo",
  "display_name": "display_name",
  "object": "project",
  "org": "org",
  "slug": "slug",
  "targets": [
    "node"
  ]
}