GET
/
v1
/
api
/
workspaces
/
{x-workspace-id}
Get Workspace by ID
curl --request GET \
  --url https://api.trillet.ai/v1/api/workspaces/{x-workspace-id} \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "_id": "<string>",
  "name": "<string>",
  "initials": "<string>",
  "pricingTier": "<string>",
  "isMasterWorkspace": true,
  "teamMembers": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Path Parameters

x-workspace-id
string
required
The unique identifier of the workspace to retrieve.

Headers

x-workspace-id
string
required
The unique identifier of the workspace being accessed (should match the path parameter :workspaceId).

Description

This endpoint returns the details of a specific workspace if the authenticated user is authorized to access it. The user must be either:
  • The owner of the workspace, or
  • A team member of the workspace (internal or external).
If the workspace is not found or the user lacks permission, a 404 Not Found is returned.

Response Fields

_id
string
Unique identifier of the workspace.
name
string
Name of the workspace.
initials
string
Initials of the workspace.
pricingTier
string
Pricing tier of the workspace (e.g., “build_plan”).
isMasterWorkspace
boolean
Indicates whether this is the master workspace.
teamMembers
array
List of team members associated with the workspace.
createdAt
string
ISO 8601 timestamp when the workspace was created.
updatedAt
string
ISO 8601 timestamp when the workspace was last updated.