Get Product Parameter

Get a product parameter definition.

get

Path parameters

idstringRequired

productIdstringRequired

Query parameters

selectstringOptional

Responses

200

OK

application/json

idstringOptional

namestringOptional

descriptionstringOptional

scopestring · enumOptionalPossible values:

phasestring · enumOptionalPossible values:

contextstring · enumOptionalPossible values:

externalIdstring · nullableOptional

displayOrderinteger · int32Optional

optionsany · nullableRead-onlyOptional

typestring · enumOptionalPossible values:

statusstringOptional

404

Not Found

application/json

get

/public/v1/catalog/products/{productId}/parameters/{id}

HTTPcURLJavaScriptPython

GET /public/v1/catalog/products/{productId}/parameters/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-02-19T17:45:19.429Z",
      "by": {}
    },
    "updated": {
      "at": "2026-02-19T17:45:19.429Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "group": {
    "id": "text",
    "name": "text"
  },
  "scope": "Agreement",
  "phase": "Configuration",
  "context": "None",
  "externalId": "text",
  "displayOrder": 1,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": true
  },
  "product": {
    "id": "text",
    "name": "text",
    "externalIds": {
      "operations": "text",
      "defaultErpItem": "text"
    },
    "icon": "text",
    "status": "text"
  },
  "options": null,
  "type": "SingleLineText",
  "status": "text"
}