GET · /workspaces Authentication required
List your team workspaces Returns a bounded list of the caller’s accessible workspaces. This fictional contract uses a limit and optional plan filter.
Name Location Type Requirement Description limitquery integer Optional Maximum records in this response. planquery string Optional Filter by subscription plan.
curl --request GET 'https://api.northstar.example/v1/workspaces?limit=12&plan=team' \
--header "Authorization: Bearer ${API_TOKEN}" Response status200 — Workspace list. 401 — Authentication is missing or invalid.
Original response schema POST · /workspaces Authentication required
Create a named workspace Creates one workspace for the caller. This is a mutating request example; the reference never executes it.
No parameters declared.
curl --request POST https://api.northstar.example/v1/workspaces \
--header "Authorization: Bearer ${API_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{"name": "River Launch", "plan": "team"}' Response status201 — Workspace created. 401 — Authentication is missing or invalid. 422 — Input does not satisfy the workspace contract.
Original response schema GET · /workspaces/{workspaceId} Authentication required
Inspect a workspace Read its name, plan and member count. Private access is determined by the actual service, outside this documentation generator.
Name Location Type Requirement Description workspaceIdpath string Required The workspace identifier from the list response.
curl --request GET https://api.northstar.example/v1/workspaces/wk_river_01 \
--header "Authorization: Bearer ${API_TOKEN}" Response status200 — Workspace details. 401 — Authentication is missing or invalid. 404 — The workspace was not found.
Original response schema PATCH · /workspaces/{workspaceId} Authentication required
Rename a workspace Updates the workspace name. Review permissions and the intended mutation before running a downloaded example.
Name Location Type Requirement Description workspaceIdpath string Required The workspace identifier from the list response.
curl --request PATCH https://api.northstar.example/v1/workspaces/wk_river_01 \
--header "Authorization: Bearer ${API_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{"name": "River Launch / Review"}' Response status200 — Updated workspace. 401 — Authentication is missing or invalid. 404 — The workspace was not found.
Original response schema DELETE · /workspaces/{workspaceId} Authentication required
Remove a workspace A destructive request example requiring an explicit decision in the real service. No deletion occurs in this studio.
Name Location Type Requirement Description workspaceIdpath string Required The workspace identifier from the list response.
curl --request DELETE https://api.northstar.example/v1/workspaces/wk_river_01 \
--header "Authorization: Bearer ${API_TOKEN}" Response status204 — Removed; no response body. 401 — Authentication is missing or invalid. 404 — The workspace was not found.
Original response schema GET · /workspaces/{workspaceId}/activity Authentication required
Read recent activity Returns authored workspace activity records from this fictional interface.
Name Location Type Requirement Description workspaceIdpath string Required The workspace identifier from the list response.
curl --request GET https://api.northstar.example/v1/workspaces/wk_river_01/activity \
--header "Authorization: Bearer ${API_TOKEN}" Response status200 — Recent activity. 401 — Authentication is missing or invalid. 404 — The workspace was not found.
Original response schema GET · /health Public contract
Check service health A public health contract with a simple status response.
No parameters declared.
curl --request GET https://api.northstar.example/v1/health Response status200 — Service health.
Original response schema