---
title: "Get-Volume"
slug: "scripting-get-volume"
updated: 2025-07-15T18:52:22Z
published: 2025-07-15T18:52:22Z
canonical: "help.agilityblue.com/scripting-get-volume"
---

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

## Summary

Retrieves an existing volume.

```powershell
Get-Volume
    -Id
```

Returns a [volume](https://apidocs.agilityblue.com/#ee58c718-6eff-43a5-b23c-106ae336400d) object.

## Parameters

| Parameter | Type | Required? | Notes |
| --- | --- | --- | --- |
| Id | Int32 | Yes | The volume id. |

## Examples

### Get an existing volume

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

```powershell
# Retrieve a specific volume by id
$data = Get-Volume -Id 17

Write-Output "Retrieved volume $($data.VolumeId)"

# Convert the volume to output as JSON
$jsonOutput = $data | ConvertTo-Json -Depth 10

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

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

# Output the data
Write-Output $jsonOutput
```

Execution results:

```plaintext
Retrieved volume 17

JSON Results:
{
  "VolumeId": 17,
  "ProjectId": 2016100000006,
  "Project": null,
  "ProjectDescription": "Load Data",
  "Name": "AGM001",
  "TaskId": 284,
  "Task": null,
  "TaskName": "Process and Load Data",
  "MatterId": 51,
  "Matter": null,
  "MatterName": "AGM Widget v. XYZ Sprocket",
  "MatterReference": "0002",
  "ClientId": 29,
  "Client": null,
  "ClientName": "AGM Widget Corporation",
  "ClientReference": "1024",
  "DocCount": 1033,
  "PageCount": 0,
  "NativeCount": 1033,
  "Notes": "Collected from AGM in Media Log ",
  "VolumeRangeBeg": "AGM0000001",
  "VolumeRangeEnd": "AGM0001033",
  "NumberOfVolumeRanges": 1,
  "VolumeDate": "2016-10-07T17:00:00+00:00",
  "VolumeRanges": [],
  "BatesRanges": [],
  "Fields": [
    {
      "FieldId": 77,
      "ObjectId": 4,
      "DataTypeId": 8,
      "DataTypeName": "Single Choice",
      "Label": "Volume Type",
      "IsRequired": false,
      "Position": 0,
      "Guid": 8232606313213,
      "IsSystemField": false,
      "IsReferenceValue": false,
      "DefaultValue": "Processing Volume\nProduced From Opposing Counsel\nProduced To Opposing Counsel",
      "CopyPreviousValueOnSaveAndNew": false,
      "Value": {
        "ObjectFieldValueId": 2183,
        "ObjectFieldId": 77,
        "ObjectId": 4,
        "PrimaryKeyId": 17,
        "ValueAsString": "Produced From Opposing Counsel",
        "ValueAsBoolean": null,
        "ValueAsNumber": null,
        "ValueAsDecimal": null,
        "ValueAsDate": null,
        "ReferenceObject": null
      },
      "ReferenceObject": null
    },
    {
      "FieldId": 78,
      "ObjectId": 4,
      "DataTypeId": 10,
      "DataTypeName": "Reference",
      "Label": "Requesting Party",
      "IsRequired": false,
      "Position": 1,
      "Guid": 7456561091592,
      "IsSystemField": false,
      "IsReferenceValue": false,
      "DefaultValue": null,
      "CopyPreviousValueOnSaveAndNew": false,
      "Value": {
        "ObjectFieldValueId": 2184,
        "ObjectFieldId": 78,
        "ObjectId": 4,
        "PrimaryKeyId": 17,
        "ValueAsString": null,
        "ValueAsBoolean": null,
        "ValueAsNumber": null,
        "ValueAsDecimal": null,
        "ValueAsDate": null,
        "ReferenceObject": {
          "ObjectFieldReferenceObjectInstanceId": 329,
          "ObjectFieldValueId": 2184,
          "ObjectId": 7,
          "Object": null,
          "PrimaryObjectId": 4,
          "PrimaryKeyId": 17,
          "KeyType": "Int32",
          "DisplayFormat": "%Val%",
          "IsSystemObject": true,
          "Name": null,
          "NumberOfValues": 1,
          "Values": [
            {
              "ObjectFieldReferenceObjectInstanceValueId": 248,
              "ObjectFieldReferenceObjectInstanceId": 329,
              "KeyAsString": null,
              "KeyAsInteger": 12,
              "KeyAsLong": null,
              "Value": "Adele Butler <abutler@abdemo.com>"
            }
          ]
        }
      },
      "ReferenceObject": null
    }
  ],
  "CreatedByFullName": "John Trask",
  "CreatedById": "d8555513-3db6-451a-9af2-e5d45b57f031",
  "CreatedOn": "2016-10-07T14:38:15.8950048-05:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "25a34a2f-e3d8-4690-88f5-6b399cf88c4c",
  "LastUpdatedOn": "2024-04-18T12:58:54.1207723+00:00",
  "LastUpdatedBy": null,
  "IsFavorite": false
}
```