---
site: steel.dev
collection: docs
canonical_url: https://steel.dev/docs/reference/api/projects
markdown_url: https://steel.dev/docs/reference/api/projects.md
content_signal: ai-input=yes, ai-train=yes, search=yes
title: Projects API
description: List your organization's projects and get one of them by its ID, with the Steel API.
summary: List your organization's projects and get one of them by its ID, with the Steel API.
type: reference
reviewed: 2026-11-12
prerequisites: []
related:
  - https://steel.dev/docs/reference/api/profiles.md
  - https://steel.dev/docs/reference/api/credentials.md
  - https://steel.dev/docs/reference/api/files.md
  - https://steel.dev/docs/reference/api/extensions.md
  - https://steel.dev/docs/reference/api/api-keys.md
agent_setup: https://setup.steel.dev/install.md
docs_index: https://steel.dev/docs/sitemap.md
---

# Projects API

A project groups your organization's sessions, profiles and API keys. These endpoints list your projects and get one of them. For the base URL and authentication, see [API conventions](https://steel.dev/docs/reference/api). For the error codes, see [Errors](https://steel.dev/docs/reference/errors).

The first example is a complete program. The later examples use its `client`, and the ID of a project in `PROJECT_ID` (cURL), `projectId` (TypeScript), `project_id` (Python and Rust) or `projectID` (Go).

## Endpoints

### List projects

```http
GET /v1/projects
```

Lists the projects that your API key reaches. An organization key gets every project in the organization, and a project key gets only its own project.

This endpoint takes no parameters.

| Field | Type | Description |
| - | - | - |
| `projects` | object\[] | The projects. Each one is a project object, as in [Get a project](https://steel.dev/docs/reference/api/projects#get-a-project). |

**cURL**

```sh
curl https://api.steel.dev/v1/projects \
  -H "steel-api-key: $STEEL_API_KEY"
```

**TypeScript**

```ts file=list-projects.mts
import Steel from "steel-sdk";

const client = new Steel();
const { projects } = await client.projects.list();

for (const project of projects) {
  console.log(project.id, project.name);
}
```

**Python**

```python file=list-projects.py
from steel import Steel

client = Steel()
response = client.projects.list()

for project in response.projects:
    print(project.id, project.name)
```

**Go**

```go file=main.go
package main

import (
	"context"
	"fmt"
	"log"

	"github.com/steel-dev/sdk/go"
)

func main() {
	if err := run(context.Background()); err != nil {
		log.Fatal(err)
	}
}

func run(ctx context.Context) error {
	client := steel.NewClient()
	response, err := client.Projects.List(ctx)
	if err != nil {
		return err
	}

	for _, project := range response.Projects {
		fmt.Println(project.ID, project.Name)
	}
	return nil
}
```

**Rust**

```rust file=src/main.rs
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = steel_rs::Client::new();
    let response = client.projects().list().await?;

    for project in response.projects {
        println!("{} {}", project.id, project.name);
    }
    Ok(())
}
```

See [Projects](https://steel.dev/docs/account/projects).

### Get a project

```http
GET /v1/projects/{id}
```

Returns one project.

| Name | In | Type | Required | Default | Description |
| - | - | - | - | - | - |
| `id` | path | string (uuid) | yes | | The ID of the project. |

| Field | Type | Description |
| - | - | - |
| `id` | string (uuid) | The ID of the project. |
| `name` | string | The name of the project. |
| `slug` | string | Steel's short form of the name: lower-case letters, digits and hyphens, unique in the organization. |
| `isDefault` | boolean | `true` for the organization's default project, which cannot be deleted. |
| `isProduction` | boolean | `true` for a production project, `false` for a development project. |
| `promotedToProductionAt` | string (date-time) or null | When the project became a production project. |
| `createdAt` | string (date-time) | When the project was created. |
| `updatedAt` | string (date-time) | When the project last changed. |

**cURL**

```sh
curl https://api.steel.dev/v1/projects/$PROJECT_ID \
  -H "steel-api-key: $STEEL_API_KEY"
```

**TypeScript**

```ts
const project = await client.projects.retrieve(projectId);
console.log(project.name, project.isDefault);
```

**Python**

```python
project = client.projects.retrieve(project_id)
print(project.name, project.is_default)
```

**Go**

```go
project, err := client.Projects.Get(ctx, projectID)
if err != nil {
	return err
}
fmt.Println(project.Name, project.IsDefault)
```

**Rust**

```rust
let project = client.projects().retrieve(&project_id).await?;
println!("{} {}", project.name, project.is_default);
```

See [Projects](https://steel.dev/docs/account/projects).
