---
title: Get suggested field values
slug: model-api/get-suggested-field-values
docTags: 
createdAt: 2026-04-14T12:07:21.044Z
---

{
  "id": "40UnPr1H3zeeZndIBy7r3",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://api.catenda.com/v2/projects/{project-id}/ifc/products/fields/suggested_values",
    "servers": [
      {
        "url": "https://api.catenda.com/v2/projects/{project-id}/ifc/products/fields/suggested_values"
      }
    ],
    "name": "Get suggested field values",
    "description": "Get suggested values for a specific queryable product field. Useful for building autocomplete interfaces or discovering available values.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "project-id",
          "type": "string",
          "example": "af2d8af0fa54465b89bf26dd3d92cfd0",
          "description": "Catenda project id"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "data-mode",
          "type": "string",
          "description": "<p>Data mode for IFC data. <code>explicit</code> returns data as stored. <code>inferred</code> merges type properties with product properties.</p>",
          "default": "explicit",
          "enum": [
            "explicit",
            "inferred"
          ]
        },
        {
          "kind": "optional",
          "name": "model",
          "type": "array",
          "description": "Filter by latest revision of model id.",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        },
        {
          "kind": "optional",
          "name": "revision",
          "type": "array",
          "description": "Filter by revision id. Can be repeated to filter by multiple revisions.",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        }
      ],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "",
          "schema": [
            {
              "name": "field",
              "kind": "required",
              "type": "string",
              "description": "The field to get values for",
              "example": "ifcType"
            },
            {
              "name": "search",
              "kind": "required",
              "type": "string",
              "description": "Search term to filter values",
              "example": "wall"
            },
            {
              "name": "models",
              "kind": "optional",
              "type": "array",
              "description": "Filter by latest revision of model ids",
              "example": "",
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            },
            {
              "name": "revisions",
              "kind": "optional",
              "type": "array",
              "description": "Filter by revision ids",
              "example": "",
              "itemType": "string",
              "customType": "string[]",
              "itemExample": "",
              "itemDefault": ""
            }
          ],
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "Bearer",
          "name": "Bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "array",
            "description": "",
            "customType": "ifc-field-value[]",
            "schema": [
              {
                "name": "value",
                "kind": "optional",
                "type": "string",
                "description": "A suggested value for the field",
                "example": "IfcWall"
              }
            ],
            "modelRef": "#/components/schemas/ifc-field-value",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "ToJtiC-r205nlBOkbfOfV",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url 'https://api.catenda.com/v2/projects/{project-id}/ifc/products/fields/suggested_values?data-mode=explicit' \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"field\": \"ifcType\",\n     \"search\": \"wall\"\n     }'"
        },
        {
          "id": "qrCwhOApwFRzldG77bSdh",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"field\": \"ifcType\",\n   \"search\": \"wall\"\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.catenda.com/v2/projects/{project-id}/ifc/products/fields/suggested_values?data-mode=explicit\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "eSQt9HFjq95082sbYuptk",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/v2/projects/{project-id}/ifc/products/fields/suggested_values?data-mode=explicit\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"field\": \"ifcType\",\n   \"search\": \"wall\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "TH4RkPnnl7cPP11mnHfoC",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/v2/projects/{project-id}/ifc/products/fields/suggested_values?data-mode=explicit\"\n\npayload = json.dumps({\n   \"field\": \"ifcType\",\n   \"search\": \"wall\"\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "ToJtiC-r205nlBOkbfOfV"
    },
    "results": {
      "languages": [
        {
          "id": "pQzQKabEPh9M705AkHZ89",
          "language": "200",
          "code": "// OK\n[\n  {\n    \"value\": \"IfcWall\"\n  }\n]"
        }
      ],
      "selectedLanguageId": "pQzQKabEPh9M705AkHZ89"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}