---
title: "Get-Comments"
slug: "scripting-get-comments"
updated: 2026-01-20T20:25:07Z
published: 2026-01-20T20:25:07Z
canonical: "help.agilityblue.com/scripting-get-comments"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.agilityblue.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get-Comments

> [!NOTE]
> Not Task Comments
> 
> These comments relate to non-task comments. Task comments have a dedicated object, found [here](/v1/docs/scripting-get-taskcomments).

## Summary

Retrieves a collection of comment objects.

```powershell
Get-Comments
    -Top
    -Skip
    -Filter
    -OrderBy
```

Returns a collection object with the following properties:

| Property | Type | Notes |
| --- | --- | --- |
| Collection | Collection of comment objects | The collection of entries retrieved after `top`, `skip`, `filter`, and `order by` parameters were applied. |
| Top | Int32 | The `top` parameter value that was used. Useful while paging data. |
| Skip | Int32 | The `skip` parameter value that was used. Useful while paging data. |
| TotalCount | Int32 | The total count of records available after any filtering was applied. Useful while paging data. |

## Parameters

| Parameter | Type | Required? | Notes |
| --- | --- | --- | --- |
| Top | Int32 | No, Defaults to `40` | Total number of entries to retrieve. Max is `1000`. |
| Skip | Int32 | No, Defaults to `0` | How many entries should be skipped within the collection. Used for paging the results. |
| Filter | String | No | An OData 4 string that can be used for filtering the collection. |
| OrderBy | String | No | An OData 4 string that can be used for sorting the collection by specific fields. |

## Examples

### Get a collection of comments

```powershell
# Retrieve one record from the collection, since we're only interested in the total count.
$collectionWrapper = Get-Comments -Top 1

Write-Output "There are $($collectionWrapper.TotalCount) comment(s) in the workspace"
```

Results of executing the script:

```plaintext
There are 55 comment(s) in the workspace
```