openstead
APIEndpoint referenceProjects

Get a project

Request parameters, responses, and examples for get a project.

Suggest a change

Kept in memory for this page. Requests go through this documentation site to the live Openstead API and can change your workspace. Use a read-only key to explore read operations.

GET
/workspaces/{workspaceId}/projects/{projectId}

Authorization

AuthorizationBearer <token>

Workspace-scoped rnv_ API key. Read scope allows GET; write scope is additionally constrained by current membership, role, email verification, expiry and workspace MFA policy.

In: header

Path Parameters

workspaceId*string

Workspace UUID; it must match the bearer key scope.

Formatuuid
projectId*string

Project UUID in this workspace.

Formatuuid

Header Parameters

X-Request-ID?string

Optional correlation identifier; invalid values are replaced. The accepted/generated value is returned in X-Request-ID and error body requestId. This is not an idempotency key.

Match^[A-Za-z0-9][A-Za-z0-9._-]*$
Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.openstead.tech/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <OPENSTEAD_API_KEY>"
{  "project": {    "color": "violet",    "createdAt": "2026-09-25T12:00:00Z",    "description": "",    "environments": [],    "id": "00000000-0000-4000-8000-000000000001",    "name": "API platform",    "updatedAt": "2026-09-25T12:00:00Z"  }}
Need a hand? Contact Openstead support.

Create a project and its Production environment POST

Request parameters, responses, and examples for create a project and its production environment.

Update a project PATCH

Request parameters, responses, and examples for update a project.