Sign in
Class Definition

Get field collection tree

Changed on

Get the field collection tree with grouped folders. <br> Optionally filter by allowed types using a comma-separated list via the <strong>{allowedTypes}</strong> query parameter.

get/pimcore-studio/api/class/field-collection/tree

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/class/field-collection/tree
  • Auth: none declared

Query parameters

allowedTypesstring
Example:NewsCars,NewsText

Comma-separated list of allowed field collection types to filter by.

Response

Field collection tree with nodes and folders

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "key": "myCollection",
      "name": "My Collection",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "group": "News"
    }
  ]
}

Changes