Skip to main content
GET
Read Nodes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required
projectId
string
required

Query Parameters

grouping
string
Required string length: 2 - 4096
Example:

"[{\"kind\":\"supplier\"},{\"kind\":\"finish\"}]"

parentPath
string
Required string length: 2 - 4096
Example:

"[{\"dimension\":\"supplier\",\"supplierId\":\"42\"}]"

limit
number

Page size (default 50); Finish grouping is safely capped by the server at 25 without truncating labels.

Required range: 1 <= x <= 100
filter
object
status
enum<string>
Available options:
new,
ready,
broken
categoryId
string
categoryIds
string[]
Required array length: 1 - 100 elements
layout
enum<string>
required
Available options:
areas,
categories,
areas-categories,
categories-areas,
custom
parentAreaId
string
parentCategoryId
string
showItemCount
boolean
cursor
string
Required string length: 1 - 2048

Response

200 - application/json
areaStructureVersion
number | null
required
nodes
object[]
required
pageInfo
object | null
required