---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Projects"
description: "The `projects` collection of Sylphx Access: A Project groups environments and the Resources in them."
type: reference
product: platform
summary: "A Project groups environments and the Resources in them."
updated: 2026-09-28
order: 900
---

A Project groups environments and the Resources in them.

**Service** Sylphx Access · **Resource type** `access.sylphx.com/Project` · **Name pattern** `orgs/{org}/projects/{project}` · **Shape** `spec_status`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}`. |
| `uid` | `string` | `prj_<cell><ulid>`; equals the name segment. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ProjectSpec` | Desired state. Required. |
| `status` | `ProjectStatus` | Observed state. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/projects#get) | Gets a project. |
| `GET` | [`list`](/docs/api/projects#list) | Lists projects in an org. |
| `POST` | [`create`](/docs/api/projects#create) | Creates a project. Access assigns the id. |
| `PATCH` | [`update`](/docs/api/projects#update) | Updates a project. |
| `DELETE` | [`delete`](/docs/api/projects#delete) | Deletes a project. |

## get

Gets a project.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop` · scope `access:read` · effect `read` · [Request, response and examples](/docs/api/projects/get)

## list

Lists projects in an org.

`GET https://api.sylphx.com/v1/orgs/acme/projects` · scope `access:read` · effect `read` · paginated · [Request, response and examples](/docs/api/projects/list)

## create

Creates a project. Access assigns the id.

`POST https://api.sylphx.com/v1/orgs/acme/projects` · scope `access:admin` · effect `write` · [Request, response and examples](/docs/api/projects/create)

## update

Updates a project.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop` · scope `access:admin` · effect `write` · [Request, response and examples](/docs/api/projects/update)

## delete

Deletes a project.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop` · scope `access:admin` · effect `destructive` · [Request, response and examples](/docs/api/projects/delete)