openstead
APIEndpoint referenceProjects

List projects

Legacy requests without limit/cursor return the complete list. Opt in to bounded pages with limit or cursor.

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

Legacy requests without limit/cursor return the complete list. Opt in to bounded pages with limit or cursor.

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

Query Parameters

limit?integer

Page size. Supplying limit or cursor enables pagination for legacy unbounded lists.

Range1 <= value <= 200
Default100
cursor?string

Opaque nextCursor returned by the previous page. Reuse with the same endpoint and query; do not parse or construct it.

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" \  -H "Authorization: Bearer <OPENSTEAD_API_KEY>"
{  "page": {    "hasMore": false,    "limit": 100,    "nextCursor": null  },  "projects": [    {      "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.

Save the shared visual layout PATCH

Developer, admin or owner required, including in protected environments because this changes visual state only. Replaces all saved positions and viewport for the selected scope. A stale revision returns 409 canvas_revision_conflict; GET the latest canvas before retrying. Unknown or no-longer-visible node IDs return 400 canvas_invalid_node. Unknown scope parameters, duplicate/empty scope values and unsupported fields are rejected. Maximum request body is 256 KiB. Uses optimistic revision control, not Idempotency-Key replay.

Create a project and its Production environment POST

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