Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

User

Get workspace user

Retrieve a user in the context of a workspace. This will also retrieve high-level user information for any users that were historically in the workspace. Users not in the workspace will be filtered out.

get/workspaces/{workspace_id}/users/{id}

Path parameters

workspace_idstring required

Workspace ID

idstring required

ID of the user to retrieve

Response

User that was retrieved

idstring

Unique identifier representing a specific user

created_timeinteger

Time at which the user was created

created_by_idstring

The ID of the user who created this user

desktop_app_installedboolean

Flag indicating whether or not the user has installed electron app

last_updated_timeinteger

Time at which the user was last updated

last_updated_by_idstring

The ID of the user who last updated this user

emailstring

The user's E-Mail address

email_verifiedboolean

Flag indicating whether or not the user's e-mail address has been verified

namestring

The user's full name

given_namestring

The user's first/given name

family_namestring

The user's surname

nicknamestring

The user's nickname

localestring

The user's locale

picturestring

URL of the user's picture

firebase_tokenstring

Token to use for Firebase authentication

onboardedboolean

flag indicating whether the workspace the user has joined has gone through onboarding

accepted_invitationboolean

flag indicating whether the user has ever accepted invitation to any workspace

companystring

The user's company

phonestring

The user's phone number

type'agent' | 'normal'

Classification of the user. A null/unset value is equivalent to normal and is the default for existing users. agent users are synthetic users created to act on behalf of AI agent sessions that were initiated by an API key rather than a human user.