Get hierarchical view of folders

GET

/domains/{domainID}/folders/tree

curl --request GET \
  --url 'https://example.com/api/v1/domains/1/folders/tree?folderID=144115188075855870' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

Query Parameters

folderID

integer

default: 144115188075855870

ID of the root folder

Responses

200

Tree of folders returned

Media typeapplication/json

object

folderid

string

name

string

container

string

children

List of child folders (in the same format as the parent)

Array<object>

object

Example^generated

{
  "folderid": "example",
  "name": "example",
  "container": "example",
  "children": [
    {}
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}