CentralCSP
APIWorkspaces

Get a workspace

Returns one workspace, including your role in it and its current plan.

Requires membership of the workspace.

GET
/v1/workspaces/{workspaceId}

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

Response Body

A workspace.

application/json
  1. response
id*string

Unique identifier of the workspace.

name*string

Display name.

ownerId*string

User who owns the workspace. The owner can do everything, including transferring ownership and deleting the workspace.

requiresMfa*boolean

When true, a member without two-factor authentication is refused on every workspace endpoint until they enrol.

disableAiIntegrations*boolean

When true, AI tools cannot reach this workspace.

plan*|

The plan of the current subscription, or null when the workspace has no active subscription and cannot collect reports.

role*|

Your role in this workspace, or null when you own it without being a member.

createdAt*string

When the workspace was created.

Formatdate-time
updatedAt*string

When the workspace was last changed.

Formatdate-time
Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90'
Example Response
{  "id": "string",  "name": "Acme",  "ownerId": "string",  "requiresMfa": true,  "disableAiIntegrations": true,  "plan": {    "slug": "pro",    "name": "Pro",    "features": [      "compliance",      "alerting",      "api_keys"    ]  },  "role": "admin",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}