---
title: "Get-IgnoredFile"
slug: "scripting-get-ignoredfile"
updated: 2026-01-21T14:42:45Z
published: 2026-01-21T14:42:45Z
canonical: "help.agilityblue.com/scripting-get-ignoredfile"
---

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

## Summary

Retrieves an existing ignored file.

```powershell
Get-IgnoredFile
    -Id
```

Returns a ignored file object.

## Parameters

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

## Examples

### Get an existing ignored file

This example retrieves a specific ignored file and outputs it as JSON.

```powershell
# Retrieve a specific ignored file entry by id
$entry = Get-IgnoredFile -Id 8

Write-Output "Retrieved ignored fle entry '$($entry.SHA256)' (Id: #$($entry.IgnoredFileId))"

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

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

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

Execution results:

```json
Retrieved ignored fle entry 'de1a9f5351362ac3f780284066c5dbe74654e897a927c54cbd9edc96fdc710d6' (Id: #8)

JSON Results:
{
  "IgnoredFileId": 8,
  "SHA256": "de1a9f5351362ac3f780284066c5dbe74654e897a927c54cbd9edc96fdc710d6",
  "Notes": null,
  "CreatedByFullName": "Carrie Johnson",
  "CreatedById": "d1aacb66-2c15-4c4b-b1b5-54ab70787a38",
  "CreatedOn": "2025-07-17T21:17:19.3162007+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Carrie Johnson",
  "LastUpdatedById": "d1aacb66-2c15-4c4b-b1b5-54ab70787a38",
  "LastUpdatedOn": "2025-07-17T21:17:19.3162007+00:00",
  "LastUpdatedBy": null
}
```