Get Workspace

Get a workspace's metadata and the caller's roleKey and roleKeys. Returns 404 if the workspace is archived or the caller has no permission on it (the two cases are not distinguished for security).

GET/api/v1/workspaces/{id}
X-API-Key<token>

Your SteelEngine API key (personal, workspace, or organization). Create personal and workspace keys under Settings > API Keys. Create organization keys under Organization Settings > API Keys.

In: header

Path Parameters

id*string

Workspace ID.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/workspaces/string"
{  "success": true,  "data": {    "workspace": {      "id": "string",      "name": "string",      "slug": "string",      "color": "string",      "ownerId": "string",      "organizationId": "string",      "billedAccountUserId": "string",      "allowPersonalApiKeys": true,      "roleKey": "string",      "roleKeys": [        "string"      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "archivedAt": "2019-08-24T14:15:22Z"    }  }}