---
title: "Get-Matters"
slug: "scripting-get-matters"
updated: 2026-01-22T13:31:27Z
published: 2026-01-22T13:31:27Z
canonical: "help.agilityblue.com/scripting-get-matters"
---

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

## Summary

Retrieves a collection of matter field cache objects.

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

Returns a collection object with the following properties:

| Property | Type | Notes |
| --- | --- | --- |
| Collection | Collection of [matter field cache](https://apidocs.agilityblue.com/#96d56a7e-07d6-4be0-a195-9670b88fe1c4) 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 matters

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

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

Execution results:

```plaintext
There are 450,177 matter(s) in the workspace
```