See Stacksync in action with a solution architect. Book a demo ↗
Workspaces

Workspaces

Get a workspace

GET
/v1/workspaces/{workspace_id}

The workspace's name, the caller's role in it and its default region (where new resources go).

Authorization

Authorizationstringheaderrequired

Bearer <key>, where <key> is a workspace API key or a user API key. See Authentication.

Path Parameters

workspace_id*integer

The workspace. List the ones your key can reach with GET /v1/workspaces.

Response Body

OK

application/json
  1. response

A workspace the caller can act in

workspace_id*Workspace Id
workspace_name*Workspace Name
role*|

The caller's role in the workspace: viewer, editor or owner (a workspace API key acts as an editor)

default_region*|

The region the web app opens on and new resources go to by default

Get a workspace
curl -X GET 'https://api.stacksync.com/v1/workspaces/0'
{  "workspace_id": 0,  "workspace_name": "<workspace_name>",  "role": "viewer",  "default_region": "besg"}