List Parameter Groups

get

Responses

200

OK

application/json

get

/public/v1/helpdesk/parameter-groups

HTTPcURLJavaScriptPython

GET /public/v1/helpdesk/parameter-groups HTTP/1.1
Host: api.s1.show
Accept: */*

200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-03-30T19:50:04.080Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-03-30T19:50:04.080Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-03-30T19:50:04.080Z",
          "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-03-30T19:50:04.080Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-03-30T19:50:04.080Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "deleted": {
              "at": "2026-03-30T19:50:04.080Z",
              "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]"
        }
      ],
      "account": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-03-30T19:50:04.080Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-03-30T19:50:04.080Z",
            "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
    }
  ]
}