---
title: "Get-GridStates"
slug: "scripting-get-gridstates"
tags: ["Closed Beta"]
updated: 2024-06-10T11:40:19Z
published: 2024-06-10T11:40:19Z
canonical: "help.agilityblue.com/scripting-get-gridstates"
---

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

## Summary

Retrieves a collection of grid state objects.

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

Returns a collection object with the following properties:

| Property | Type | Notes |
| --- | --- | --- |
| Collection | Collection of Grid State 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 grid states

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

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

```custom
There are 45 grid state(s) in the workspace
```