---
title: "Get-TaskStatusTypes"
slug: "scripting-get-taskstatustypes"
tags: ["Enterprise Only"]
updated: 2026-01-22T13:29:46Z
published: 2026-01-22T13:29:46Z
canonical: "help.agilityblue.com/scripting-get-taskstatustypes"
---

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

## Summary

Retrieves a collection of task status type objects.

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

Returns a collection object with the following properties:

| Property | Type | Notes |
| --- | --- | --- |
| Collection | Collection of [task status type](https://apidocs.agilityblue.com/#5fe802da-c851-4b7d-ac16-0012a1eabda2) 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 task status types

```powershell
# Retrieve the collection
$collectionWrapper = Get-TaskStatusTypes -Top 500

Write-Output "There are $($collectionWrapper.TotalCount) task task status types in the workspace"

$collectionWrapper.Collection |
    Select-Object TaskStatusTypeId, Description, Weight |
    Out-String -Width 300 |
    Write-Output
```

Execution results:

```ExecutionResults
There are 6 task task status types in the workspace

TaskStatusTypeId Description        Weight
---------------- -----------        ------
               1 New                     1
               2 In Progress             3
               3 In Quality Control      4
               4 Completed               5
               5 On Hold                 2
               6 Canceled                0
```