List User Workspaces
Retrieve all workspaces the authenticated user owns or is a team member of.
Headers
x-workspace-idstringrequiredThe unique identifier of any workspace you are a member of. Required by the auth middleware when using API key authentication. This endpoint still returns all workspaces the authenticated user has access to, regardless of which workspace ID is provided here.
Description
This endpoint returns every workspace where the authenticated user is:
- The owner,
- An internal team member, or
- An external team member.
Owned and internal-member workspaces come first, followed by external ones. There is no other sorting.
Before listing, any pending invitation for your email is accepted automatically. If you're a brand-new user with no workspaces and no invitation, a default workspace is created for you. No user is ever created by this endpoint: an unknown user gets 404 {"error": "User not found"}.
Each workspace object carries many more fields than listed below (billing, plan, white-label and feature settings).
Response Fields
_idstringUnique identifier of the workspace.
namestringName of the workspace.
initialsstringInitials of the workspace.
teamMembersarrayList of team members associated with the workspace, including their roles and optional external workspace details.
createdAtstringTimestamp when the workspace was created (ISO 8601 format).
updatedAtstringTimestamp when the workspace was last updated (ISO 8601 format).
Last updated on