---
title: "Get-CustomObjects"
slug: "scripting-get-customobjects"
updated: 2025-07-16T20:17:17Z
published: 2025-07-16T20:17:17Z
canonical: "help.agilityblue.com/scripting-get-customobjects"
---

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

## Summary

Retrieves a collection of custom object instances.

```powershell
Get-CustomObjects
    -CustomObjectId
    -Top
    -Skip
    -Filter
    -OrderBy
```

Returns a collection object with the following properties:

| Property | Type | Notes |
| --- | --- | --- |
| Collection | Collection of [custom object](https://apidocs.agilityblue.com/#8fa4e4b4-452d-49b8-9a08-03b936874e54) entries | 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 |
| --- | --- | --- | --- |
| CustomObjectId | Int32 | Yes | The custom object id directs the command to which object collection of data to pull. The Id can be found within the UI on the objects grid or by using the Get-Objects command within a script. |
| 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 custodians (a custom object created within the workspace)

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

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

```Execution
There are 780 custodian(s) in the workspace
```