openstead
APIEndpoint referenceWorkspaces

Get a workspace

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

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}

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

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" \  -H "Authorization: Bearer <OPENSTEAD_API_KEY>"
{  "workspace": {    "billing": {},    "configuration": {      "allowOverages": false,      "avatarColor": "#e6daff",      "budget": 0,      "budgetAlerts": true,      "buildConcurrency": 1,      "currency": "USD",      "defaultRegion": "auto",      "deployNotifications": "failure",      "description": "",      "includePreviewLogs": true,      "notificationEmail": "",      "overlappingDeploys": "cancel",      "previewNotifications": false,      "requireMfa": false,      "securityContact": "",      "timezone": "Africa/Lagos"    },    "entitlements": {},    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "plan": "string",    "role": "viewer"  }}
Need a hand? Contact Openstead support.

Get this public core API contract GET

Request parameters, responses, and examples for get this public core api contract.

Get scoped service topology and shared layout GET

Readers can view the workspace, one project across its environments, or one project environment. Only active service records and valid scoped reference/group connections are shown; archived and deleting/deleted services are excluded. Manual secret values are never inspected. Layouts are independent per scope. Unsaved layouts have revision 0. No pagination or silent truncation: scopes beyond 2000 total nodes or 10000 reference records/edges return 413 canvas_too_large.