---
title: "Get-Form"
slug: "scripting-get-form"
updated: 2026-01-20T20:41:30Z
published: 2026-01-20T20:41:30Z
canonical: "help.agilityblue.com/scripting-get-form"
---

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

## Summary

Retrieves an existing form.

```powershell
Get-Form
    -Id
```

Returns a [form](https://apidocs.agilityblue.com/#8c402f05-727c-4464-94d7-4ba56805c1e3) object.

## Parameters

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

## Examples

### Get an existing form

This example retrieves a specific form and outputs it as JSON.

```powershell
# Retrieve a specific form by id
$form = Get-Form -Id 39

Write-Output "Retrieved form '$($form.Name)' (Id: #$($form.formId), # of sections: $($form.NumberOfSections), # of fields: $($form.NumberOfFields))"

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

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

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

Execution results:

```json
Retrieved form 'Production' (Id: #39, # of sections: 1, # of fields: 9)

JSON Results:
{
  "FormId": 39,
  "FormTypeId": 1,
  "FormType": null,
  "FormTypeName": "Tasks",
  "Name": "Production",
  "Category": "Productions",
  "Description": null,
  "IsAvailableOnPortal": true,
  "NumberOfSections": 1,
  "NumberOfFields": 9,
  "CreatedByFullName": "Joan Ofarc",
  "CreatedById": "d8555513-3db6-451a-9af2-e5d45b57f031",
  "CreatedOn": "2017-04-20T14:17:49.2759228-05:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2025-02-12T19:14:43.9578692+00:00",
  "LastUpdatedBy": null,
  "Sections": [
    {
      "SectionId": 47,
      "FormId": 39,
      "Heading": "Production Instructions",
      "Position": 0,
      "Guid": 1492715423321,
      "Fields": [
        {
          "FieldId": 151,
          "SectionId": 47,
          "DataTypeId": 1,
          "DataTypeName": "Basic Text",
          "Label": "Data to Produce",
          "IsRequired": true,
          "IsVisible": true,
          "Position": 0,
          "Guid": 1492715477785,
          "DefaultValue": null,
          "ReferenceObject": null,
          "ConditionGroups": [],
          "AppliedProperties": []
        },
        {
          "FieldId": 152,
          "SectionId": 47,
          "DataTypeId": 1,
          "DataTypeName": "Basic Text",
          "Label": "Beginning Production Number",
          "IsRequired": true,
          "IsVisible": true,
          "Position": 1,
          "Guid": 1492715488891,
          "DefaultValue": "Next Available",
          "ReferenceObject": null,
          "ConditionGroups": [],
          "AppliedProperties": []
        },
        {
          "FieldId": 153,
          "SectionId": 47,
          "DataTypeId": 8,
          "DataTypeName": "Single Choice",
          "Label": "Confidentiality Designation",
          "IsRequired": true,
          "IsVisible": true,
          "Position": 2,
          "Guid": 1492715505772,
          "DefaultValue": "Endorse per coding\nAll \"Confidential\"\nAll \"Highly Confidential\"\nNone (all public)\nOther",
          "ReferenceObject": null,
          "ConditionGroups": [],
          "AppliedProperties": []
        },
        {
          "FieldId": 154,
          "SectionId": 47,
          "DataTypeId": 8,
          "DataTypeName": "Single Choice",
          "Label": "Production Format",
          "IsRequired": true,
          "IsVisible": true,
          "Position": 3,
          "Guid": 1492715553160,
          "DefaultValue": "Follow Previous Production\nSee Matter-level ESI Protocol\nCustom ESI Protocol",
          "ReferenceObject": null,
          "ConditionGroups": [],
          "AppliedProperties": []
        },
        {
          "FieldId": 291,
          "SectionId": 47,
          "DataTypeId": 10,
          "DataTypeName": "Reference",
          "Label": "Metadata to Include",
          "IsRequired": false,
          "IsVisible": true,
          "Position": 4,
          "Guid": 1615207055584,
          "DefaultValue": null,
          "ReferenceObject": {
            "FieldReferenceObjectId": 17,
            "FieldId": 291,
            "ObjectId": 11,
            "Object": null,
            "KeyType": "Int32",
            "DisplayFormat": "%Name%",
            "IsSystemObject": false,
            "Name": "Metadata",
            "DefaultValues": []
          },
          "ConditionGroups": [],
          "AppliedProperties": [
            {
              "FieldPropertyId": 2,
              "ForFieldId": 291,
              "ForFieldLabel": "Metadata to Include",
              "FieldPropertyTypeId": 36,
              "FieldPropertyTypeName": "Tooltip",
              "FieldPropertyType": null,
              "RenderMode": "Edit",
              "ValueAsString": "Which metadata should be included?",
              "ValueAsNumber": null,
              "ValueAsDecimal": null,
              "ValueAsBoolean": null,
              "ValueAsDate": null
            },
            {
              "FieldPropertyId": 3,
              "ForFieldId": 291,
              "ForFieldLabel": "Metadata to Include",
              "FieldPropertyTypeId": 37,
              "FieldPropertyTypeName": "Information Block",
              "FieldPropertyType": null,
              "RenderMode": "Edit",
              "ValueAsString": "Choose which metadata standard should be included in the production load file.",
              "ValueAsNumber": null,
              "ValueAsDecimal": null,
              "ValueAsBoolean": null,
              "ValueAsDate": null
            }
          ]
        },
        {
          "FieldId": 208,
          "SectionId": 47,
          "DataTypeId": 2,
          "DataTypeName": "Rich Text",
          "Label": "Custom ESI Protocol",
          "IsRequired": false,
          "IsVisible": false,
          "Position": 5,
          "Guid": 1523801116503,
          "DefaultValue": null,
          "ReferenceObject": null,
          "ConditionGroups": [
            {
              "FormFieldConditionGroupDefinitionId": 6,
              "ForFieldId": 208,
              "Description": "When the \"Production Format\" field has any of these choices: [Custom ESI Protocol], make this field Required and make this field Visible.",
              "Conditions": []
            },
            {
              "FormFieldConditionGroupDefinitionId": 7,
              "ForFieldId": 208,
              "Description": "When the \"Production Format\" field has none of these choices: [Custom ESI Protocol], make this field Not Required and make this field Hidden.",
              "Conditions": []
            }
          ],
          "AppliedProperties": []
        },
        {
          "FieldId": 155,
          "SectionId": 47,
          "DataTypeId": 9,
          "DataTypeName": "Multiple Choice",
          "Label": "Deliverable",
          "IsRequired": true,
          "IsVisible": true,
          "Position": 6,
          "Guid": 1492715598409,
          "DefaultValue": "CD/DVD\nFlash/External Hard Drive\nInternal FTP\nClient FTP\nOther",
          "ReferenceObject": null,
          "ConditionGroups": [],
          "AppliedProperties": []
        },
        {
          "FieldId": 209,
          "SectionId": 47,
          "DataTypeId": 10,
          "DataTypeName": "Reference",
          "Label": "Deliverable Recipient(s)",
          "IsRequired": false,
          "IsVisible": true,
          "Position": 7,
          "Guid": 1523801082381,
          "DefaultValue": null,
          "ReferenceObject": {
            "FieldReferenceObjectId": 2,
            "FieldId": 209,
            "ObjectId": 7,
            "Object": null,
            "KeyType": "Int32",
            "DisplayFormat": "%Val%",
            "IsSystemObject": true,
            "Name": "Contact",
            "DefaultValues": []
          },
          "ConditionGroups": [],
          "AppliedProperties": []
        },
        {
          "FieldId": 156,
          "SectionId": 47,
          "DataTypeId": 2,
          "DataTypeName": "Rich Text",
          "Label": "Further Instructions",
          "IsRequired": false,
          "IsVisible": true,
          "Position": 8,
          "Guid": 1492715640773,
          "DefaultValue": null,
          "ReferenceObject": null,
          "ConditionGroups": [],
          "AppliedProperties": []
        }
      ]
    }
  ]
}
```