Get-Project

Summary

Retrieves an existing project.

Get-Project
    -Id

Returns a project object.

Parameters

Examples

Get an existing project

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

# Retrieve a specific project by id
$entity = Get-Project -Id 2023110000001

Write-Output "Retrieved project '$($entity.Description)' (Id: #$($entity.ProjectId), Status: $($entity.Status))"

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

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

# Output the entity
Write-Output $jsonOutput

Execution results:

Retrieved project 'Process Data' (Id: #2023110000001, Status: Closed)

JSON Results:
{
  "ProjectId": 2023110000001,
  "ProjectTypeId": 1,
  "ProjectTypeName": "Normal",
  "ProjectTypeDescription": "The normal project type where task work is performed.",
  "ProjectSourceTypeId": 2,
  "ProjectSourceTypeName": "Agility Blue",
  "MatterId": 39,
  "Matter": null,
  "MatterName": "AGM Widget Corp. vs. MGM Manufacturing Inc.",
  "MatterReference": "1024-0002",
  "ClientId": 29,
  "Client": null,
  "ClientName": "AGM Widget Corporation",
  "ClientReference": "1024",
  "ContactId": null,
  "Contact": null,
  "ContactFullName": null,
  "PricingAgreementOptionId": 1,
  "PricingAgreementOptionName": "Standard Pricing",
  "OwnedById": "25a34a2f-e3d8-4690-88f5-6b399cf88c4c",
  "OwnedBy": null,
  "OwnedByFullName": "Sarah Cooper",
  "Priority": "Normal",
  "DateReceived": "2023-11-02T12:04:29.81+00:00",
  "DateDue": null,
  "DateInvoiced": null,
  "NumberOfTasks": 2,
  "NumberOfUnassignedTasks": 0,
  "NumberOfBillingEntries": 0,
  "NumberOfVolumes": 0,
  "NumberOfMediaLogEntries": 0,
  "TotalWeight": 10,
  "CurrentWeight": 10,
  "Status": "Closed",
  "Description": "Process Data",
  "Assignees": "Sarah Cooper, Max Miller",
  "IsApproved": false,
  "IsLate": false,
  "IsCompleted": true,
  "IsCanceled": false,
  "EmailNotificationsEnabled": true,
  "CompletedOn": "2023-11-02T12:06:23.4471242+00:00",
  "Tags": [],
  "ComputedTags": "Processing",
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2023-11-02T12:04:51.0083228+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2023-11-02T12:04:51.1022291+00:00",
  "LastUpdatedBy": null,
  "Settings": null
}