> For the complete documentation index, see [llms.txt](https://docs.platform.softwareone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform.softwareone.com/developer-resources/rest-api/helpdesk-api/parameter-group/get-parameter-in-a-parameter-group.md).

# Get parameter in a parameter group

## Retrieve a parameter within parameter group by ID

> GetGroupParameter\
> Retrieves a specific parameter definition that belongs to the specified parameter group.\
> Supports RQL select parameter for field filtering to optimize response payload.\
> Returns 404 if the parameter does not exist, does not belong to the group, or the user lacks access.\
> Available for Operations accounts with helpdesk administration permissions.

```json
{"openapi":"3.0.1","info":{"title":"Marketplace API","version":"5.0.5843-g491c2e59"},"servers":[{"url":"https://api.platform.softwareone.com"}],"paths":{"/public/v1/helpdesk/parameter-groups/{groupId}/parameters/{id}":{"get":{"tags":["OrderedParameterDefinition"],"summary":"Retrieve a parameter within parameter group by ID","description":"GetGroupParameter\nRetrieves a specific parameter definition that belongs to the specified parameter group.\nSupports RQL select parameter for field filtering to optimize response payload.\nReturns 404 if the parameter does not exist, does not belong to the group, or the user lacks access.\nAvailable for Operations accounts with helpdesk administration permissions.","parameters":[{"name":"groupId","in":"path","description":"The unique identifier of the parameter group","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The unique identifier of the parameter","required":true,"schema":{"type":"string"}},{"name":"select","in":"query","description":"Optional RQL select statement to filter fields","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderedParameterDefinition"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"OrderedParameterDefinition":{"type":"object","properties":{"id":{"type":"string"},"audit":{"allOf":[{"$ref":"#/components/schemas/ParameterDefinitionAudit"}],"description":"Audit information for a parameter definition"},"$meta":{"allOf":[{"$ref":"#/components/schemas/PlatformMetadata"}],"nullable":true},"name":{"type":"string"},"icon":{"type":"string","nullable":true},"revision":{"type":"integer","format":"int32"},"scope":{"allOf":[{"$ref":"#/components/schemas/HelpdeskParameterScope"}],"description":"The scope that defines the applicability and context of the helpdesk parameter within the system"},"phase":{"allOf":[{"$ref":"#/components/schemas/HelpdeskParameterPhase"}],"description":"The phase of the parameter in the helpdesk workflow"},"description":{"type":"string","description":"The description of the parameter"},"multiple":{"type":"boolean","description":"Indicates whether the parameter can accept multiple values"},"externalId":{"type":"string","description":"The optional external identifier of the parameter for integration purposes","nullable":true},"displayOrder":{"type":"integer","description":"The display order of the parameter where a lower value indicates higher priority in the display sequence","format":"int32","nullable":true},"constraints":{"allOf":[{"$ref":"#/components/schemas/HelpdeskConstraints"}],"description":"The constraints associated with the parameter including required, readonly, and visibility settings"},"options":{"description":"The type-specific options for the parameter which vary based on the parameter type","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/ParameterType"}],"description":"The parameter type defining the data format and validation rules"},"statistics":{"allOf":[{"$ref":"#/components/schemas/ParameterUsageStatistics"}],"description":"Statistics about parameter usage across cases and groups"},"account":{"type":"object","allOf":[{"$ref":"#/components/schemas/AccountRef"}]},"isDeleted":{"type":"boolean","description":"Indicates whether the parameter definition has been marked as deleted."},"group":{"allOf":[{"$ref":"#/components/schemas/HelpdeskParameterGroup"}],"description":"The parameter group that contains this parameter definition"}},"additionalProperties":false,"description":"Ordered parameter definition within a parameter group"},"ParameterDefinitionAudit":{"type":"object","properties":{"created":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectEvent"}],"nullable":true},"updated":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectEvent"}],"nullable":true},"deleted":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectEvent"}],"description":"The deletion event details","nullable":true}},"additionalProperties":false,"description":"Audit information for a parameter definition"},"PlatformObjectEvent":{"type":"object","properties":{"at":{"type":"string","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"$ref":"#/components/schemas/PlatformIdentityRef"}]}},"additionalProperties":false},"PlatformIdentityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string","nullable":true},"revision":{"type":"integer","format":"int32"}},"additionalProperties":false},"PlatformMetadata":{"type":"object","properties":{"omitted":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"HelpdeskParameterScope":{"enum":["Case","Form"],"type":"string","description":"Defines the scope that determines where a parameter is applicable in the helpdesk system."},"HelpdeskParameterPhase":{"enum":["Request","Response"],"type":"string","description":"Defines the phase that determines when a parameter is used in the helpdesk workflow."},"HelpdeskConstraints":{"type":"object","properties":{"hidden":{"type":"boolean","nullable":true},"readonly":{"type":"boolean","nullable":true},"required":{"type":"boolean","nullable":true},"capacity":{"allOf":[{"$ref":"#/components/schemas/CapacitySettings"}],"nullable":true},"visibility":{"allOf":[{"$ref":"#/components/schemas/VisibilityMode"}],"description":"The visibility mode controlling who can see the parameter","nullable":true}},"additionalProperties":false,"description":"Constraints specific to helpdesk parameters"},"CapacitySettings":{"type":"object","properties":{"min":{"type":"integer","format":"int32"},"max":{"type":"integer","format":"int32"}},"additionalProperties":false},"VisibilityMode":{"enum":["All","OnlyMyAccount"],"type":"string","description":"Defines who can see the parameter in the helpdesk system."},"ParameterType":{"enum":["SingleLineText","MultiLineText","Address","Contact","Checkbox","Choice","Subdomain","Heading","DropDown","Email","DataObject","Date"],"type":"string"},"ParameterUsageStatistics":{"type":"object","properties":{"cases":{"type":"integer","description":"The number of cases using this parameter","format":"int32"},"groups":{"type":"integer","description":"The number of groups using this parameter","format":"int32"},"forms":{"type":"integer","description":"The number of forms using this parameter","format":"int32"}},"additionalProperties":false,"description":"Usage statistics for a parameter definition"},"AccountRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string","nullable":true},"revision":{"type":"integer","format":"int32"},"type":{"allOf":[{"$ref":"#/components/schemas/AccountType"}],"nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/AccountStatus"}],"nullable":true}},"additionalProperties":false},"AccountType":{"enum":["Client","Vendor","Operations"],"type":"string"},"AccountStatus":{"enum":["Active","Enabled","Disabled"],"type":"string"},"HelpdeskParameterGroup":{"type":"object","properties":{"id":{"type":"string"},"audit":{"allOf":[{"$ref":"#/components/schemas/ParameterGroupAudit"}]},"$meta":{"allOf":[{"$ref":"#/components/schemas/PlatformMetadata"}],"nullable":true},"name":{"type":"string"},"icon":{"type":"string","nullable":true},"revision":{"type":"integer","format":"int32"},"label":{"type":"string","description":"The translatable label for the parameter group"},"description":{"type":"string","description":"The optional description providing additional context for the parameter group","nullable":true},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/OrderedParameterDefinition"},"description":"The collection of ordered parameter definitions that belong to this parameter group"},"account":{"allOf":[{"$ref":"#/components/schemas/Account"}],"description":"The platform account that owns this parameter group"},"statistics":{"allOf":[{"$ref":"#/components/schemas/ParameterGroupStatistics"}],"description":"Statistics about parameter count and form usage for this parameter group"},"isDeleted":{"type":"boolean","description":"Indicates whether the parameter group has been marked as deleted"}},"additionalProperties":false},"ParameterGroupAudit":{"type":"object","properties":{"created":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectEvent"}],"nullable":true},"updated":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectEvent"}],"nullable":true},"deleted":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectEvent"}],"nullable":true}},"additionalProperties":false},"Account":{"type":"object","properties":{"id":{"type":"string"},"audit":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectAudit"}]},"$meta":{"allOf":[{"$ref":"#/components/schemas/PlatformMetadata"}],"nullable":true},"name":{"type":"string"},"icon":{"type":"string","nullable":true},"revision":{"type":"integer","format":"int32"},"type":{"allOf":[{"$ref":"#/components/schemas/AccountType"}],"nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/AccountStatus"}],"nullable":true},"externalIds":{"allOf":[{"$ref":"#/components/schemas/AccountExternalIds"}],"nullable":true},"externalId":{"type":"string","nullable":true},"externalName":{"type":"string","nullable":true},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}]},"technicalSupportEmail":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groups":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupRef"},"nullable":true},"eligibility":{"allOf":[{"$ref":"#/components/schemas/Eligibility"}],"nullable":true},"defaultLanguageCode":{"type":"string","nullable":true}},"additionalProperties":false},"PlatformObjectAudit":{"type":"object","properties":{"created":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectEvent"}],"nullable":true},"updated":{"allOf":[{"$ref":"#/components/schemas/PlatformObjectEvent"}],"nullable":true}},"additionalProperties":false},"AccountExternalIds":{"type":"object","properties":{"pyraTenantId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false},"Address":{"type":"object","properties":{"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"postCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"additionalProperties":false},"UserGroupRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"revision":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"logo":{"type":"string","nullable":true},"isDefault":{"type":"boolean"}},"additionalProperties":false},"Eligibility":{"type":"object","properties":{"client":{"type":"boolean"},"partner":{"type":"boolean"}},"additionalProperties":false},"ParameterGroupStatistics":{"type":"object","properties":{"parameters":{"type":"integer","description":"The number of parameter definitions in this group","format":"int32"},"forms":{"type":"integer","description":"The number of non-deleted forms this group is assigned to","format":"int32"}},"additionalProperties":false,"description":"Usage statistics for a parameter group"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/helpdesk-api/parameter-group/get-parameter-in-a-parameter-group.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.