List parameters in a parameter group

List parameters in a parameter group

get

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.

Path parameters

groupIdstringRequired

The unique identifier of the parameter group

Query parameters

selectstringOptional

Optional RQL select statement to filter fields

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

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

HTTPcURLJavaScriptPython

GET /public/v1/helpdesk/parameter-groups/{groupId}/parameters HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "data": [
    {
      "id": "param-123",
      "label": "Customer Name",
      "description": "Full name of the customer",
      "type": "String",
      "displayOrder": 1,
      "required": true,
      "revision": 2,
      "audit": {
        "created": {
          "at": "2024-02-02T10:00:00+00:00",
          "by": "[e-mail]"
        },
        "updated": {
          "at": "2024-02-02T12:00:00+00:00",
          "by": "[e-mail]"
        }
      }
    }
  ],
  "total": 1
}