# Parameter

The Parameter object contains the following properties:

<table><thead><tr><th width="161">Field Name</th><th width="239">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The platform-generated ID of the parameter. </p><p>Example: PRD-1234-1234-1234</p></td></tr><tr><td><code>href</code></td><td>string</td><td><p>Resource reference. </p><p>Example: /v1/products/PRD-1234-1234-1234</p></td></tr><tr><td><code>scope</code></td><td>string</td><td><p>The context in which the parameter will be used. </p><p>Example: Agreement</p></td></tr><tr><td><code>phase</code></td><td>string</td><td><p>The process during which the parameter will be used. </p><p>Example: Order</p></td></tr><tr><td><code>type</code></td><td>string</td><td><p>Indicates the UI component that will be used to capture information. </p><p>Example: Email</p></td></tr><tr><td><code>options</code></td><td><p>One of the following: </p><p></p><ul><li><code>AddressOptions</code></li><li><code>CheckboxOptions</code></li><li><code>SingleLineTextOptions</code></li><li><code>MultiLineTextOptions</code></li><li><code>ChoiceOptions</code></li><li><code>AddressOptions</code></li><li><code>ContactOptions</code></li><li><code>SubdomainOptions</code></li><li><code>HeadingOptions</code></li><li><code>DropDownOptions</code></li><li><code>EmailOptions</code></li><li><code>DataObjectOptions</code></li><li><code>DateOptions</code><br></li></ul></td><td><p>The options are specific to a selected type and allow customization of the UI component. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
    "label": "Client address",
    "hintText": "please add your email",
    "placeholderText": "someone@org.com",
    "defaultValue": "none"
}
</code></pre></td></tr><tr><td><code>constraints</code></td><td>constraints</td><td>Used to specify the characteristics of an entire parameter, which can also impact the validation of values. For instance, enabling <strong>Optional</strong> overrides any mandatory fields within the UI components associated with the selected type.</td></tr><tr><td><code>group</code></td><td>object (<a href="parameter-group"><code>parameterGroup</code></a>)</td><td>Groups allow logical grouping of parameters. They are used by the purchase wizard and represented as a wizard step. </td></tr><tr><td><code>externalId</code></td><td>object (<a href="../common-api-objects/externalids"><code>externalIds</code></a>)</td><td><p>Used for programmatic processing, for example, as a variable name within embedding templates or a “connector” process. </p><p>Example: EXT-1234-1234</p></td></tr></tbody></table>

## Example response

{% code lineNumbers="true" %}

```json
{
  "scope": "Agreement",
  "phase": "Order",
  "description": "Agreement identifier of the reseller",
  "externalId": "RES-233-33-xx3",
  "displayOrder": 100,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "optional": false
  },
  "type": "SingleLineText",
  "options": {
    "name": "Agreement Id",
    "placeholderText": "AGR-xxx-xxx-xxx",
    "hintText": "Add agreement id",
    "minChar": 15,
    "maxChar": 15,
    "defaultValue": null
  },
  "group": { "id": PGR-7373-6782" }
}
```

{% endcode %}