List Parameter Definition

Returns all parameters in helpdesk.

get

Responses

200

application/json

get

/public/v1/helpdesk/parameters

GET /public/v1/helpdesk/parameters HTTP/1.1
Host: api.s1.show
Accept: */*

200

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

PreviousCreate Parameter Definition NextGet Parameter Definition

Last updated 1 month ago

Was this helpful?

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