Workspace

Retrieve the workspace that is currently selected.

get

Retrieve the workspace that is currently selected.

Responses

200

The currently selected workspace.

application/json

idstringRequired

The ID of the workspace.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

namestringRequired

The name of the workspace.

Example: My Workspace

subdomainstringRequired

The subdomain of the workspace.

Example: myworkspace

owner_idstringRequired

The ID of the owner of the workspace.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

statusstring · enumRequired

The status of the workspace.

Possible values:

plan_price_idstringRequired

The ID of the plan price of the workspace.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

referral_creditnumberRequired

How much referral credit has been applied to the workspace.

Example: 10000

created_atstring · date-timeRequired

Timestamp of when the workspace was created.

Example: 2025-01-01T00:00:00.000Z

updated_atstring · date-timeRequired

Timestamp of when the workspace was last updated.

Example: 2025-01-01T00:00:00.000Z

401

The user is not authenticated.

get

/auth/workspace

HTTPcURLJavaScriptPython

GET /api/v1/auth/workspace HTTP/1.1
Accept: */*

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "name": "My Workspace",
  "subdomain": "myworkspace",
  "owner_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "status": "TRIAL",
  "plan_price_id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "referral_credit": 10000,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}