Get-Team

Prev Next

Summary

Retrieves an existing team.

Get-Team
    -Id

Returns a team object.

Parameters

Parameter

Type

Required?

Notes

Id

String

Yes

The team id.

Examples

Get an existing team

This example retrieves a specific team and outputs it as JSON.

# Retrieve a specific team by id
$team = Get-Team -Id "521d1513-a164-41a5-b5cf-64964a210503"

Write-Output "Retrieved team '$($team.Name)' (Id: $($team.Id), # of users: $($team.NumberOfUsers))"

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

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

# Output the entity
Write-Output $jsonOutput

Execution results:

Retrieved team 'Document Reviewers' (Id: 521d1513-a164-41a5-b5cf-64964a210503, # of users: 1)

JSON Results:
{
  "Id": "521d1513-a164-41a5-b5cf-64964a210503",
  "Name": "Document Reviewers",
  "Description": null,
  "IsSystemTeam": false,
  "NumberOfUsers": 1,
  "TeamUsers": [],
  "LinkedUser": null,
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2024-06-26T16:11:26.9344868+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2024-07-08T13:25:21.4233373+00:00",
  "LastUpdatedBy": null
}