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

Description

This endpoint returns a list of workspaces where the authenticated user is either:
  • The owner of the workspace,
  • An internal team member, or
  • An external team member.
If the user is signing in for the first time, the system will:
  1. Check for any pending invitations and join the user to an existing workspace if one exists.
  2. If no invitation exists, create a default workspace for the user.
The response includes both direct workspaces and external workspaces, sorted in the following order:
  1. Owned workspaces,
  2. Team memberships,
  3. Guest workspaces.

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, including their roles and optional external workspace details.
createdAt
string
Timestamp when the workspace was created (ISO 8601 format).
updatedAt
string
Timestamp when the workspace was last updated (ISO 8601 format).