OK
The translatable label for the parameter group
Customer InformationThe optional description providing additional context for the parameter group
Basic customer details and contact informationDefines the scope that determines where a parameter is applicable in the helpdesk system.
Defines the phase that determines when a parameter is used in the helpdesk workflow.
The description of the parameter
Customer contact email addressIndicates whether the parameter can accept multiple values
falseThe optional external identifier of the parameter for integration purposes
EXT-PARAM-123The display order of the parameter where a lower value indicates higher priority in the display sequence
1Defines who can see the parameter in the helpdesk system.
The type-specific options for the parameter which vary based on the parameter type
The number of cases using this parameter
The number of groups using this parameter
The number of forms using this parameter
Indicates whether the parameter definition has been marked as deleted.
The translatable label for the parameter group
Customer InformationThe optional description providing additional context for the parameter group
Basic customer details and contact informationThe optional external identifier associated with the parameter group
The number of parameter definitions in this group
The number of non-deleted forms this group is assigned to
Indicates whether the parameter group has been marked as deleted
falseThe optional external identifier associated with the parameter group
The number of parameter definitions in this group
The number of non-deleted forms this group is assigned to
Indicates whether the parameter group has been marked as deleted
falseGET /public/v1/helpdesk/parameter-groups HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
OK
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"label": "Customer Information",
"description": "Basic customer details and contact information",
"parameters": [
{
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"deleted": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"scope": "Form",
"phase": "Request",
"description": "Customer contact email address",
"multiple": false,
"externalId": "EXT-PARAM-123",
"displayOrder": 1,
"constraints": {
"hidden": true,
"readonly": true,
"required": true,
"capacity": {
"min": 1,
"max": 1
},
"visibility": "All"
},
"options": null,
"type": "String",
"statistics": {
"cases": 1,
"groups": 1,
"forms": 1
},
"account": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active"
},
"isDeleted": true,
"group": "[Circular Reference]"
}
],
"externalId": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
},
"updated": {
"at": "2026-01-01T00:00:00.000Z",
"by": {
"id": "text",
"name": "text",
"icon": "text",
"revision": 1
}
}
},
"$meta": {
"omitted": [
"text"
]
},
"name": "text",
"icon": "text",
"revision": 1,
"type": "Client",
"status": "Active",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "text",
"website": "text",
"description": "text",
"groups": [
{
"id": "text",
"name": "text",
"revision": 1,
"description": "text",
"logo": "text",
"isDefault": true
}
],
"eligibility": {
"client": true,
"partner": true
},
"defaultLanguageCode": "text"
},
"statistics": {
"parameters": 1,
"forms": 1
},
"isDeleted": false
}
]
}