---
title: List products
slug: model-api/list-products
docTags:
createdAt: 2024-06-10T16:48:45.445Z
---
{
"id": "x4tNJtbTzhBz8C_cUHSEn",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://api.catenda.com/v2/projects/{project-id}/ifc/products",
"servers": [
{
"url": "https://api.catenda.com/v2/projects/{project-id}/ifc/products"
}
],
"name": "List products",
"description": "List all the products in a project.",
"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": "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[]"
},
{
"kind": "optional",
"name": "ifcType",
"type": "string",
"description": "Filter by IFC type"
},
{
"kind": "optional",
"name": "page",
"type": "integer",
"description": "Default value is 1"
},
{
"kind": "optional",
"name": "pageSize",
"type": "integer",
"description": "Default 100, max 1000
"
}
],
"bodyDataParameters": [],
"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-product[]",
"schema": [
{
"name": "objectId",
"kind": "optional",
"type": "integer",
"description": "The object id of the product",
"example": 73749689,
"format": "int64"
},
{
"name": "ifcType",
"kind": "optional",
"type": "string",
"description": "The entity type of the product",
"example": "IfcWall"
},
{
"name": "attributes",
"kind": "optional",
"type": "object",
"description": "The attributes of the product",
"example": "",
"schema": []
},
{
"name": "revisionId",
"kind": "optional",
"type": "string",
"description": "The id of the model revision",
"example": "924809076a694255c489d236517a55da"
},
{
"name": "propertySets",
"kind": "optional",
"type": "map",
"description": "Map of property sets specific to this product ocurrence. The key is the name of the property set.",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "quantitySets",
"kind": "optional",
"type": "map",
"description": "Map of quantity sets specific to this product ocurrence. The key is the name of the quantity set.",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "materials",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ifc-material",
"customType": "ifc-material[]",
"schema": [
{
"name": "objectId",
"kind": "optional",
"type": "integer",
"description": "The object id of the material",
"example": 217235939073,
"format": "int64"
},
{
"name": "attributes",
"kind": "optional",
"type": "object",
"description": "The attributes of the material including the name",
"example": "",
"schema": []
},
{
"name": "ifcSchema",
"kind": "optional",
"type": "string",
"description": "The IFC schema of the model revision",
"example": "IFC2X3"
},
{
"name": "ifcType",
"kind": "optional",
"type": "string",
"description": "The entity type of the material",
"example": "IfcMaterialLayerSet"
}
]
},
{
"name": "type",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ifc-type",
"customType": "ifc-type",
"schema": [
{
"name": "revisionId",
"kind": "optional",
"type": "string",
"description": "The id of the model revision",
"example": "924809076a694255c489d236517a55da"
},
{
"name": "objectId",
"kind": "optional",
"type": "integer",
"description": "The object id of the type",
"example": 75749589,
"format": "int64"
},
{
"name": "ifcType",
"kind": "optional",
"type": "string",
"description": "The entity type of the type",
"example": "IfcWallType"
},
{
"name": "attributes",
"kind": "optional",
"type": "object",
"description": "The attributes of the type including name and predefined type",
"example": "",
"schema": []
},
{
"name": "propertySets",
"kind": "optional",
"type": "map",
"description": "Map of property sets common to all ocurrences of this type. The key is the name of the property set.",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "quantitySets",
"kind": "optional",
"type": "map",
"description": "Map of quantity sets common to all ocurrences of this type. The key is the name of the quantity set.",
"example": "",
"customType": "map",
"schema": []
},
{
"name": "materials",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ifc-material",
"customType": "ifc-material[]",
"schema": [
{
"name": "objectId",
"kind": "optional",
"type": "integer",
"description": "The object id of the material",
"example": 217235939073,
"format": "int64"
},
{
"name": "attributes",
"kind": "optional",
"type": "object",
"description": "The attributes of the material including the name",
"example": "",
"schema": []
},
{
"name": "ifcSchema",
"kind": "optional",
"type": "string",
"description": "The IFC schema of the model revision",
"example": "IFC2X3"
},
{
"name": "ifcType",
"kind": "optional",
"type": "string",
"description": "The entity type of the material",
"example": "IfcMaterialLayerSet"
}
]
}
]
}
],
"modelRef": "#/components/schemas/ifc-product",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "gOy_RNRAT_Wlvo64YJESk",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://api.catenda.com/v2/projects/{project-id}/ifc/products \\\n --header 'accept: application/json'"
},
{
"id": "MpKVndpaM61Z9cF7zsrzu",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.catenda.com/v2/projects/{project-id}/ifc/products\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "8i_VIH5G_JH46fRexbtGv",
"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\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "QHWIdgM_fAMEGjchsyCTr",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/v2/projects/{project-id}/ifc/products\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "gOy_RNRAT_Wlvo64YJESk"
},
"results": {
"languages": [
{
"id": "DrYCDY5-5j0z49CusxRiI",
"language": "200",
"code": "// OK\n[\n {\n \"objectId\": 73749689,\n \"ifcType\": \"IfcWall\",\n \"attributes\": {},\n \"revisionId\": \"924809076a694255c489d236517a55da\",\n \"propertySets\": \"\",\n \"quantitySets\": \"\",\n \"materials\": [\n {\n \"objectId\": 217235939073,\n \"attributes\": {},\n \"ifcSchema\": \"IFC2X3\",\n \"ifcType\": \"IfcMaterialLayerSet\"\n }\n ],\n \"type\": {\n \"revisionId\": \"924809076a694255c489d236517a55da\",\n \"objectId\": 75749589,\n \"ifcType\": \"IfcWallType\",\n \"attributes\": {},\n \"propertySets\": \"\",\n \"quantitySets\": \"\",\n \"materials\": [\n {\n \"objectId\": 217235939073,\n \"attributes\": {},\n \"ifcSchema\": \"IFC2X3\",\n \"ifcType\": \"IfcMaterialLayerSet\"\n }\n ]\n }\n }\n]"
}
],
"selectedLanguageId": "DrYCDY5-5j0z49CusxRiI"
}
},
"children": [
{
"text": ""
}
]
}