Skip to main content

List all nodes

GET 

/pcm/hierarchies/nodes

A fully paginated view of all nodes in all hierarchies regardless of depth.

Filtering

Many Commerce API endpoints support filtering. The general syntax is described in Filtering.

The following attributes and operators are supported.

OperatorAttributeDescriptionExample
eqid, hierarchy_id, owner, parent_id, name, slug, description, has_children, created_at, updated_at, locales.[locale].name, locales.[locale].description, breadcrumbs.id, breadcrumbs.name, breadcrumbs.slug, breadcrumbs.locales.[locale].nameEquals. Checks if the value of the attribute matches the specified value.filter=eq(name,some-name), filter=eq(locales.fr-FR.name,Nom-du-produit)
inid, hierarchy_id, parent_id, breadcrumbs.idChecks if the value of the attribute is included in the specified list.filter=in(id,1,2,3,4)
lt, le, gt, geid, hierarchy_id, parent_id, created_at, updated_atComparison operators. lt: Less than, le: Less than or equal to, gt: Greater than, ge: Greater than or equal to.filter=lt(id,100), filter=ge(created_at,2022-01-01)
likename, slug, description, locales.[locale].name, locales.[locale].description, breadcrumbs.name, breadcrumbs.slug, breadcrumbs.locales.[locale].nameLike. Checks if the attribute contains the specified string (wildcards supported).filter=like(name,*some-name*), filter=like(locales.es-ES.description,*descripción*)

Request

Responses

Returns a list of nodes