OrderedParameterDefinition

List parameters in a parameter group

ListGroupParameters Retrieves all parameter definitions associated with the specified parameter group. Returns a paginated list with support for filtering, sorting, and field selection via RQL query parameters. The group property is automatically excluded from the response to avoid circular references. Available for Operations accounts with helpdesk administration permissions.

get/public/v1/helpdesk/parameter-groups/{groupId}/parameters

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/helpdesk/parameter-groups/{groupId}/parameters
  • Auth: none declared

Path parameters

groupIdstring required

The unique identifier of the parameter group

Query parameters

selectstring

Optional RQL select statement to filter fields

Response

OK

Example response

{
  "data": [
    {
      "description": "Customer contact email address",
      "externalId": "EXT-PARAM-123",
      "displayOrder": 1,
      "group": {
        "label": "Customer Information",
        "description": "Basic customer details and contact information"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.