Get-WorkspaceUser

Summary

Retrieves an existing workspace user.

Get-WorkspaceUser
    -Id

Returns a workspace user object.

Parameters

Examples

Get an existing workspace user

This example retrieves a specific workspace user and outputs it as JSON.

# Retrieve a specific user by id
$user = Get-WorkspaceUser -Id "08077d23-bb13-4727-b76d-ab8fdf9d870f"

Write-Output "Retrieved user '$($user.FullName)' (Id: #$($user.Id), Roles: $($user.Roles), Notifications Enabled: $($user.NotificationsEnabled))"

# For debug purposes, convert the entity to output as JSON so we can see the available fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $user | ConvertTo-Json -Depth 10

# Output the entity
Write-Output $jsonOutput

Execution results:

Retrieved user 'Max Miller' (Id: #08077d23-bb13-4727-b76d-ab8fdf9d870f, Roles: Organization User;Organization Administrator, Notifications Enabled: True)

JSON Results:
{
  "Id": "08077d23-bb13-4727-b76d-ab8fdf9d870f",
  "Email": "mmiller@agilityblue.com",
  "FirstName": "Max",
  "LastName": "Miller",
  "FullName": "Max Miller",
  "Active": true,
  "Deleted": false,
  "IsSystemAccount": false,
  "IsTeamAccount": false,
  "PrimaryColor": "#003366",
  "OrganizationId": 1020,
  "OrganizationName": "Sadie Blue Software",
  "TimeZoneIdentifier": "Central Standard Time",
  "Roles": "Organization User;Organization Administrator",
  "NotificationsEnabled": true,
  "NumberOfProjectsCreated": 0,
  "NumberOfProjectsOwned": 0,
  "NumberOfTasksCreated": 1,
  "NumberOfTasksAssigned": 1,
  "NumberOfTasksCompleted": 1,
  "NumberOfNotificationRules": 0,
  "CreatedOn": "2025-03-06T10:18:00+00:00"
}