Skip to main content
GET
/
v1
/
api
/
workspaces
/
{workspaceId}
Get Workspace by ID
curl --request GET \
  --url https://api.trillet.ai/v1/api/workspaces/{workspaceId} \
  --header 'x-api-key: <api-key>'
{
  "_id": "<string>",
  "name": "<string>",
  "initials": "<string>",
  "teamMembers": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

​
Headers

​
x-api-key
string
required
API key used for authenticating requests to the API.

​
Path Parameters

​
workspaceId
string
required
The unique identifier of the workspace to retrieve.

​
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.
​
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.