Get Parameter in a Parameter Group

Retrieve a parameter within parameter group by ID

get

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.

Path parameters

groupIdstringRequired

The unique identifier of the parameter group

idstringRequired

The unique identifier of the parameter

Query parameters

selectstringOptional

Optional RQL select statement to filter fields

Responses

200

OK

application/json

Ordered parameter definition within a parameter group

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

scopestring · enumOptional

Defines the scope that determines where a parameter is applicable in the helpdesk system.

Possible values:

phasestring · enumOptional

Defines the phase that determines when a parameter is used in the helpdesk workflow.

Possible values:

descriptionstringOptional

The description of the parameter

Example: Customer contact email address

multiplebooleanOptional

Indicates whether the parameter can accept multiple values

Example: false

externalIdstring · nullableOptional

The optional external identifier of the parameter for integration purposes

Example: EXT-PARAM-123

displayOrderinteger · int32 · nullableOptional

The display order of the parameter where a lower value indicates higher priority in the display sequence

Example: 1

optionsany · nullableOptional

The type-specific options for the parameter which vary based on the parameter type

typestring · enumOptionalPossible values:

isDeletedbooleanOptional

Indicates whether the parameter definition has been marked as deleted.

403

Forbidden

application/json

404

Not Found

application/json

get

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

HTTPcURLJavaScriptPython

GET /public/v1/helpdesk/parameter-groups/{groupId}/parameters/{id} HTTP/1.1
Host: api.s1.show
Accept: */*

{
  "id": "param-123",
  "label": "Customer Name",
  "description": "Full name of the customer",
  "type": "String",
  "displayOrder": 1,
  "scope": "Form",
  "phase": "Request",
  "constraints": {
    "required": true,
    "readonly": false
  },
  "revision": 2,
  "audit": {
    "created": {
      "at": "2024-02-02T10:00:00+00:00",
      "by": "[email protected]"
    },
    "updated": {
      "at": "2024-02-02T12:00:00+00:00",
      "by": "[email protected]"
    }
  }
}