---
title: "Get-Volumes"
slug: "scripting-get-volumes"
updated: 2024-12-05T15:56:24Z
published: 2024-12-05T15:56:24Z
canonical: "help.agilityblue.com/scripting-get-volumes"
---

> ## 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-Volumes

## Summary

Retrieves a collection of volume field cache objects.

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

Returns a collection object with the following properties:

| Property | Type | Notes |
| --- | --- | --- |
| Collection | Collection of [volume field cache](https://apidocs.agilityblue.com/#ca444f73-c7cb-4ae0-bbf7-a102b97b23f6) 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. |

> [!WARNING]
> Field Cache Objects
> 
> Field cache objects cannot be used directly for updating an object using a `Set-*` command. Instead, you will need to retrieve the object you intend to update directly using a `Get-*` command, modify the properties you want to update, and then save that object back using a `Set-*` command.

## 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 volumes

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

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

```Execution
There are 339 volume(s) in the workspace
```